tez-api/src/main/proto/DAGClientAMProtocol.proto

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

option java_package = "org.apache.tez.dag.api.client.rpc";
option java_outer_classname = "DAGClientAMProtocolRPC";
option java_generic_services = true;
option java_generate_equals_and_hash = true;

//import "DAGClientAMProtocolRecords.proto";

import "DAGApiRecords.proto";

message GetAllDAGsRequestProto {
}

message GetAllDAGsResponseProto {
  repeated string dagId = 1;
}

message GetDAGStatusRequestProto {
  optional string dagId = 1;
  repeated StatusGetOptsProto statusOptions = 3;
}

message GetDAGStatusResponseProto {
  optional DAGStatusProto dagStatus = 1;
}

message GetVertexStatusRequestProto {
  optional string dagId = 1;
  optional string vertexName = 2;
  repeated StatusGetOptsProto statusOptions = 3;
}

message GetVertexStatusResponseProto {
  optional VertexStatusProto vertexStatus = 1;
}

message TryKillDAGRequestProto {
  optional string dagId = 1;
}

message TryKillDAGResponseProto {
  //nothing yet
}

message SubmitDAGRequestProto {
  optional DAGPlan d_a_g_plan = 1;
  optional PlanLocalResourcesProto additional_am_resources = 2;
}

message SubmitDAGResponseProto {
  optional string dagId = 1;
}

message ShutdownSessionRequestProto {
}

message ShutdownSessionResponseProto {
}

enum TezSessionStatusProto {
  INITIALIZING = 0;
  READY = 1;
  RUNNING = 2;
  SHUTDOWN = 3;
}

message GetAMStatusRequestProto {
}

message GetAMStatusResponseProto {
  required TezSessionStatusProto status = 1;
}

message PreWarmRequestProto {
  optional PreWarmContextProto pre_warm_context = 1;
}

message PreWarmResponseProto {
}

service DAGClientAMProtocol {
  rpc getAllDAGs (GetAllDAGsRequestProto) returns (GetAllDAGsResponseProto);
  rpc getDAGStatus (GetDAGStatusRequestProto) returns (GetDAGStatusResponseProto);
  rpc getVertexStatus (GetVertexStatusRequestProto) returns (GetVertexStatusResponseProto);
  rpc tryKillDAG (TryKillDAGRequestProto) returns (TryKillDAGResponseProto);
  rpc submitDAG (SubmitDAGRequestProto) returns (SubmitDAGResponseProto);
  rpc shutdownSession (ShutdownSessionRequestProto) returns (ShutdownSessionResponseProto);
  rpc getAMStatus (GetAMStatusRequestProto) returns (GetAMStatusResponseProto);
  rpc preWarm (PreWarmRequestProto) returns (PreWarmResponseProto);
}