hbase-protocol/src/main/protobuf/ShellExecEndpoint.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.
 */

/*
 * Opens a tunnel for remote shell execution on the target server. Used by `CoprocClusterManager`.
 */

package hbase.pb;
option java_package = "org.apache.hadoop.hbase.coprocessor.protobuf.generated";
option java_outer_classname = "ShellExecEndpoint";
option java_generic_services = true;
option java_generate_equals_and_hash = true;

message ShellExecRequest {
  required string command = 1;
  optional bool await_response = 2;
}

message ShellExecResponse {
  optional int32 exit_code = 1;
  optional string stdout = 2;
  optional string stderr = 3;
}

service ShellExecService {
  rpc shell_exec(ShellExecRequest) returns(ShellExecResponse);
}