groot.sdk.client.proto Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of groot-client Show documentation
The Java client of Groot, a persistence storage engine
There is a newer version: 0.28.1
/**
 * Copyright 2020 Alibaba Group Holding Limited.
 * 
 * Licensed 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.
 */
syntax = "proto3";
package gs.rpc.groot;

import "groot/sdk/model.proto";

option java_package = "com.alibaba.graphscope.proto.groot";
option java_multiple_files = true;

service Client {
  rpc getSchema(GetSchemaRequest) returns (GetSchemaResponse);
  rpc ingestData(IngestDataRequest) returns (IngestDataResponse);
  rpc getMetrics(GetMetricsRequest) returns (GetMetricsResponse);
  rpc loadJsonSchema(LoadJsonSchemaRequest) returns (LoadJsonSchemaResponse);
  rpc dropSchema(DropSchemaRequest) returns (DropSchemaResponse);
  rpc prepareDataLoad(PrepareDataLoadRequest) returns (PrepareDataLoadResponse);
  rpc commitDataLoad(CommitDataLoadRequest) returns (CommitDataLoadResponse);
  rpc getPartitionNum(GetPartitionNumRequest) returns (GetPartitionNumResponse);
  rpc getLoggerInfo(GetLoggerInfoRequest) returns (GetLoggerInfoResponse);
  rpc clearIngest(ClearIngestRequest) returns (ClearIngestResponse);
}

message GetSchemaRequest {

}

message GetSchemaResponse {
  GraphDefPb graphDef = 1;
}

message IngestDataRequest {
  string dataPath = 1;
  map config = 2;
}

message IngestDataResponse {
}

message GetMetricsRequest {
  string roleNames = 1;
}

message GetMetricsResponse {
  string metricsJson = 1;
}

message LoadJsonSchemaRequest {
  string schemaJson = 1;
}

message LoadJsonSchemaResponse {
  GraphDefPb graphDef = 1;
}

message DropSchemaRequest {

}

message DropSchemaResponse {
  GraphDefPb graphDef = 1;
}

message PrepareDataLoadRequest {
  repeated DataLoadTargetPb dataLoadTargets = 1;
}

message PrepareDataLoadResponse {
  GraphDefPb graphDef = 1;
}

message CommitDataLoadRequest {
  map tableToTarget = 1;
  string path = 2;
}

message CommitDataLoadResponse {

}

message GetPartitionNumRequest {

}

message GetPartitionNumResponse {
  int32 partitionNum = 1;
}

message GetLoggerInfoRequest {

}

message GetLoggerInfoResponse {
  string loggerServers = 1;
  string loggerTopic = 2;
  int32 loggerQueueCount = 3;
}

message ClearIngestRequest {
  string dataPath = 1;
}

message ClearIngestResponse {
}