github.com/cloudwan/edgelq-sdk@v1.15.4/monitoring/proto/v3/metric_descriptor_service.proto

syntax = "proto3";

package ntt.monitoring.v3;

import "edgelq-sdk/monitoring/proto/v3/metric_descriptor.proto";
import "edgelq-sdk/monitoring/proto/v3/metric_descriptor_change.proto";
import "edgelq-sdk/monitoring/proto/v3/metric_descriptor_custom.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
import "google/protobuf/timestamp.proto";
import "goten-sdk/types/view.proto";
import "goten-sdk/types/watch_type.proto";

option go_package = "github.com/cloudwan/edgelq-sdk/monitoring/client/v3/metric_descriptor;metric_descriptor_client";
option java_multiple_files = false;
option java_outer_classname = "MetricDescriptorServiceProto";
option java_package = "com.ntt.monitoring.pb.v3";

// A request message of the BatchGetMetricDescriptors method.
message BatchGetMetricDescriptorsRequest {
  // Names of MetricDescriptors
  repeated string names = 2;

  // A list of extra fields to be obtained for each response item on top of
  // fields defined by request field view
  google.protobuf.FieldMask field_mask = 3;

  // View defines list of standard response fields present in response items.
  // Additional fields can be amended by request field field_mask
  goten.types.View view = 4;

  reserved 1;
}

// A response message of the BatchGetMetricDescriptors method.
message BatchGetMetricDescriptorsResponse {
  // found MetricDescriptors
  repeated MetricDescriptor metric_descriptors = 1;

  // list of not found MetricDescriptors
  repeated string missing = 2;
}

// A request message of the WatchMetricDescriptor method.
message WatchMetricDescriptorRequest {
  // Name of ntt.monitoring.v3.MetricDescriptor
  string name = 1;

  // A list of extra fields to be obtained for each response item on top of
  // fields defined by request field view
  google.protobuf.FieldMask field_mask = 2;

  // View defines list of standard response fields present in response items.
  // Additional fields can be amended by request field field_mask
  goten.types.View view = 4;
}

// A response message of the WatchMetricDescriptor method.
message WatchMetricDescriptorResponse { MetricDescriptorChange change = 1; }

// A request message of the WatchMetricDescriptors method.
message WatchMetricDescriptorsRequest {
  // Type of a watch. Identifies how server stream data to a client, which
  // fields in a request are allowed and which fields in response are relevant.
  goten.types.WatchType type = 9;

  // Parent name of ntt.monitoring.v3.MetricDescriptor
  string parent = 1;

  // Requested page size. Server may return fewer MetricDescriptors than
  // requested. If unspecified, server will pick an appropriate default. Can be
  // populated only for stateful watch type.
  int32 page_size = 2;

  // A token identifying a page of results the server should return.
  // Can be populated only for stateful watch type.
  string page_token = 3;

  // Order By -
  // https://cloud.google.com/apis/design/design_patterns#list_pagination Can be
  // populated only for stateful watch type.
  string order_by = 4;

  // A token identifying watch resume point from previous session.
  // Can be populated only for stateless watch type.
  string resume_token = 10;

  // Point in the time from which we want to start getting updates. This field
  // can be populated only for stateless watch type and if resume token is not
  // known yet. If specified, initial snapshot will NOT be provided. It is
  // assumed client can obtain it using separate means. Watch responses will
  // contain resume tokens which should be used to resume broken connection.
  google.protobuf.Timestamp starting_time = 12;

  // Filter - filter results by field criteria. Simplified SQL-like syntax with
  // following operators:
  // <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS
  // [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels
  // CONTAINS "severity:important" OR (state.last_error_time >
  // "2018-11-15T10:00:00Z" AND state.status = "ERROR")'
  string filter = 5;

  // A list of extra fields to be obtained for each response item on top of
  // fields defined by request field view Changes to MetricDescriptor that don't
  // affect any of masked fields won't be sent back.
  google.protobuf.FieldMask field_mask = 6;

  // View defines list of standard response fields present in response items.
  // Additional fields can be amended by request field field_mask Changes to
  // MetricDescriptor that don't affect any of masked fields won't be sent back.
  goten.types.View view = 8;

  // Maximum amount of changes in each response message. Query result response
  // is divided on the server side into chunks with size of a specified amount
  // to limit memory footprint of each message. Responses will hold information
  // whether more elements will continue for the actual change. If unspecified,
  // server will pick an appropriate default.
  int32 max_chunk_size = 11;
}

// A response message of the WatchMetricDescriptors method.
message WatchMetricDescriptorsResponse {
  // Changes of MetricDescriptors
  repeated MetricDescriptorChange metric_descriptor_changes = 2;

  // If request specified max_chunk_size (or this limit was enforced if
  // stateless watch has been chosen), then responses with "full changeset" will
  // be divided into chunks. Client should keep receiving messages and, once
  // is_current has value true, combine this recent message with all previous
  // ones where is_current is false. If this is the first is_current in a whole
  // watch stream, then it means that client should have, at this moment,
  // contain snapshot of the current situation (or more accurately, snapshot of
  // situation at the moment of request). All MetricDescriptors will be of type
  // Added/Current (depending on watch_type specified in the request). Further
  // responses will be incremental - however messages may still be chunked and
  // is_current logic still applies. is_current is always true for stateful
  // watch if max_chunk_size was left to 0.
  bool is_current = 4;

  // When present, PageTokens used for page navigation should be updated.
  // Present only if is_current is true (last chunk).
  PageTokenChange page_token_change = 3;

  // Token that can be used if current connection drops and client needs to
  // reconnect. Populated only for stateless watch type. Present only if
  // is_current is true (last chunk).
  string resume_token = 5;

  // Server may occasionally send information how many resources should client
  // have in its state so far (response message without any changes, but with
  // snapshot_size field specified). If client has different value than the one
  // sent by the server, then it should be treated by a client as an error and
  // should reconnect. If value is smaller then 0, then client should ignore
  // this field as unpopulated. This field should be checked only for stateless
  // watch. In stateful those kind of errors are handled by the server side.
  // Will be never sent together with is_current, is_soft_reset and
  // is_hard_reset flags.
  int64 snapshot_size = 6;

  // In case of internal issue server may send response message with this flag.
  // It indicates that client should drop all changes from recent responses
  // where is_current is false only! If last message had is_current set to true,
  // client should do nothing and process normally. Resume token received before
  // is still valid. This field should be checked only for stateless watch. In
  // stateful those kind of errors are handled by the server side. Will never be
  // sent along with is_current, is_hard_reset or snapshot_size.
  bool is_soft_reset = 7;

  // In case of internal issue server may send response message with this flag.
  // After receiving, client should clear whole state (drop all changes received
  // so far) as server will send new snapshot (MetricDescriptors will contains
  // changes of type Current only). Any resume tokens should be discarded as
  // well. This field should be checked only for stateless watch. In stateful
  // those kind of errors are handled by the server side. Will never be sent
  // along with is_current, is_soft_reset or snapshot_size.
  bool is_hard_reset = 8;

  message PageTokenChange {
    // New token to retrieve previous page of results.
    string prev_page_token = 1;

    // New token to retrieve next page of results.
    string next_page_token = 2;
  }
}

// MetricDescriptor service API for Monitoring
service MetricDescriptorService {
  option (google.api.default_host) = "monitoring.edgelq.com";
  option (google.api.oauth_scopes) = "https://apis.edgelq.com";

  // BatchGetMetricDescriptors
  rpc BatchGetMetricDescriptors(BatchGetMetricDescriptorsRequest)
      returns (BatchGetMetricDescriptorsResponse) {
    option (google.api.http) = {
      get : "/v3/metricDescriptors:batchGet"
    };
  }

  // WatchMetricDescriptor
  rpc WatchMetricDescriptor(WatchMetricDescriptorRequest)
      returns (stream WatchMetricDescriptorResponse) {
    option (google.api.http) = {
      post : "/v3/{name=projects/*/metricDescriptors/*}:watch"
    };
  }

  // WatchMetricDescriptors
  rpc WatchMetricDescriptors(WatchMetricDescriptorsRequest)
      returns (stream WatchMetricDescriptorsResponse) {
    option (google.api.http) = {
      post : "/v3/{parent=projects/*}/metricDescriptors:watch"
    };
  }

  // GetMetricDescriptor
  rpc GetMetricDescriptor(GetMetricDescriptorRequest)
      returns (MetricDescriptor) {
    option (google.api.http) = {
      get : "/v3/{name=projects/*/metricDescriptors/*}"
    };
  }

  // CreateMetricDescriptor
  rpc CreateMetricDescriptor(CreateMetricDescriptorRequest)
      returns (MetricDescriptor) {
    option (google.api.http) = {
      post : "/v3/{parent=projects/*}/metricDescriptors"
      body : "metric_descriptor"
    };
  }

  // UpdateMetricDescriptor
  rpc UpdateMetricDescriptor(UpdateMetricDescriptorRequest)
      returns (MetricDescriptor) {
    option (google.api.http) = {
      put : "/v3/{metric_descriptor.name=projects/*/metricDescriptors/*}"
      body : "metric_descriptor"
    };
  }

  // DeleteMetricDescriptor
  rpc DeleteMetricDescriptor(DeleteMetricDescriptorRequest)
      returns (google.protobuf.Empty) {
    option (google.api.http) = {
      delete : "/v3/{name=projects/*/metricDescriptors/*}"
    };
  }

  // ListMetricDescriptors
  rpc ListMetricDescriptors(ListMetricDescriptorsRequest)
      returns (ListMetricDescriptorsResponse) {
    option (google.api.http) = {
      get : "/v3/{parent=projects/*}/metricDescriptors"
    };
  }
}