hugegraph-pd/hg-pd-grpc/src/main/proto/pd_watch.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.
 */

syntax = "proto3";

import "metapb.proto";

option java_multiple_files = true;
option java_package = "org.apache.hugegraph.pd.grpc.watch";
option java_outer_classname = "HgPdWatchProto";

service HgPdWatch {
  rpc Watch(stream WatchRequest) returns (stream WatchResponse);
}

message WatchRequest {
  WatchCreateRequest create_request = 1;
  WatchCancelRequest cancel_request = 2;
}

message WatchCreateRequest {
  WatchType  watch_type = 1;
}

message WatchCancelRequest {
  int64 watcher_id = 1;
}

message WatchResponse {
  WatchType watch_type = 1;
  int64 watcher_id = 2;
  int32 status = 3;   //0=ok,1=fail
  int64 notice_id = 4;
  string msg = 5;
  oneof response_union {
    WatchPartitionResponse partition_response = 10;
    WatchNodeResponse node_response = 11;
    WatchGraphResponse graph_response = 12;
    WatchShardGroupResponse shard_group_response = 13;
  }
}

message WatchPartitionResponse {
  string graph = 1;
  int32 partition_id = 2;
  WatchChangeType change_type = 3;
}

message WatchNodeResponse {
  string graph = 1;
  uint64 node_id = 2;
  NodeEventType node_event_type = 3;
}

message WatchGraphResponse {
  metapb.Graph graph = 1;
  WatchType type = 2;
}

message WatchShardGroupResponse {
  metapb.ShardGroup shard_group = 1;
  WatchChangeType type = 2;
  int32 shard_group_id = 3;
}

enum WatchType {
  WATCH_TYPE_UNKNOWN = 0;
  WATCH_TYPE_PARTITION_CHANGE = 1;
  WATCH_TYPE_STORE_NODE_CHANGE = 2;
  WATCH_TYPE_GRAPH_CHANGE = 3;
  WATCH_TYPE_SHARD_GROUP_CHANGE = 4;
}

enum WatchChangeType {
  WATCH_CHANGE_TYPE_UNKNOWN = 0;
  WATCH_CHANGE_TYPE_ADD = 1;
  WATCH_CHANGE_TYPE_ALTER = 2;
  WATCH_CHANGE_TYPE_DEL = 3;
  WATCH_CHANGE_TYPE_SPECIAL1 = 4;
}

enum NodeEventType {
  NODE_EVENT_TYPE_UNKNOWN = 0;
  NODE_EVENT_TYPE_NODE_ONLINE = 1;
  NODE_EVENT_TYPE_NODE_OFFLINE = 2;
  NODE_EVENT_TYPE_NODE_RAFT_CHANGE = 3;
  NODE_EVENT_TYPE_PD_LEADER_CHANGE = 4;
}