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

syntax = "proto3";

package ntt.monitoring.v3;

import "edgelq-sdk/common/rpc/status.proto";
import "edgelq-sdk/monitoring/proto/v3/common.proto";
import "edgelq-sdk/monitoring/proto/v3/time_serie.proto";
import "google/protobuf/field_mask.proto";

option go_package = "github.com/cloudwan/edgelq-sdk/monitoring/client/v3/time_serie;time_serie_client";
option java_multiple_files = false;
option java_outer_classname = "TimeSerieCustomProto";
option java_package = "com.ntt.monitoring.pb.v3";

// Request message for method [ListTimeSeries][ntt.monitoring.v3.ListTimeSeries]
message ListTimeSeriesRequest {
  // The project on which to execute the request. The format is
  // "projects/{project_id_or_number}".
  string parent = 10;

  // A monitoring filter that specifies which time
  // series should be returned.  The filter must specify a single metric type,
  // and can additionally specify metric labels and other information. For
  // example:
  //
  //     metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND
  //         metric.label.instance_name = "my-instance-name"
  string filter = 2;

  // The time interval for which results should be returned. Only time series
  // that contain data points in the specified interval are included
  // in the response.
  TimeInterval interval = 4;

  // By default, the raw time series data is returned.
  // Use this field to combine multiple time series for different
  // views of the data.
  Aggregation aggregation = 5;

  // Picks paginated time series according to pre-defined (in metric descriptor)
  // view and function. Cannot be used with aggregation, because pagination
  // view and function determines time series transformation and sorting.
  Pagination pagination = 3;

  // Specifies which information is returned about the time series.
  TimeSeriesView view = 7;

  // view list mask. Optimize network usage and limit returned header fields to
  // a required subset. example fields in field mask:
  // - "key": for later caching,
  // - "resource.labels.project_id", "resource.labels.instance_name", etc -
  // specific labels only
  // - "resource", "metric": all resource labels, reduced_labels and type
  // NOTE: points are added implicitly
  google.protobuf.FieldMask field_mask = 12;

  // A positive number that is the maximum number of Points to return. If
  // `points_cap` is empty or more than 100,000 results, the effective
  // `points_cap` is 100,000 results. If `view` is set to `HEADERS`, this is
  // the maximum number of `TimeSeries` returned.
  int32 points_cap = 8;

  // If this field is not empty then it must contain the `continuation_token`
  // value returned by a previous call to this method.  Using this field causes
  // the method to return additional results from the previous method call.
  string continuation_token = 9;

  reserved 6;
}

// Response message for method
// [ListTimeSeries][ntt.monitoring.v3.ListTimeSeries]
message ListTimeSeriesResponse {
  // One or more time series that match the filter included in the request.
  repeated TimeSerie time_series = 1;

  // If there are more results than have been returned, then this field is set
  // to a non-empty value.  To see the additional results,
  // use that value as `continuation_token` in the next call to this method.
  string continuation_token = 2;

  // Special time series with total amount of records available for pagination
  // by given time series key. Metric/Resource labels will contain "common"
  // values shared by all ranked time series. ValueType will be always INT64 and
  // metricKind GAUGE. In a sense, this time series is execution of
  // ListTimeSeries with Aggregation = {groupByFields: [<viewPaginatedLabels>],
  // REDUCER: REDUCE_COUNT} This field is only populated for paginated queries
  // (pagination in ListTimeSeries is specified).
  repeated TimeSerie total_point_counters = 4;

  // ErrorDetails is used when one of the queried regions fails to produce
  // results. It is used in execution_errors field (see subfield
  // ntt.rpc.Status.details).
  message ErrorDetails {
    // region id which failed to give results.
    string region_id = 1;
  }
}

// Request message for method
// [CreateTimeSeries][ntt.monitoring.v3.CreateTimeSeries]
message CreateTimeSeriesRequest {
  // The project on which to execute the request. The format is
  // `"projects/{project_id_or_number}"`.
  string parent = 3;

  // The new data to be added to a list of time series.
  // Adds at most one data point to each of several time series.  The new data
  // point must be more recent than any other point in its time series.  Each
  // `TimeSeries` value must fully specify a unique time series by supplying
  // all label values for the metric and the monitored resource.
  repeated TimeSerie time_series = 2;
}

// Response message for method
// [CreateTimeSeries][ntt.monitoring.v3.CreateTimeSeries]
message CreateTimeSeriesResponse {
  // Time Serie keys indexed by Create position - present only when given
  // TimeSerie didn't use Key field
  map<uint32, bytes> time_serie_keys = 11;

  // Time series that failed to be created
  repeated CreateTimeSeriesError failed_time_series = 50;
}

// Describes the result of a failed request to write data to a time series.
message CreateTimeSeriesError {
  // The time series, including the `Metric`, `MonitoredResource`,
  // and `Point`s (including timestamp and value) that resulted
  // in the error. This field provides all of the context that
  // would be needed to retry the operation.
  TimeSerie time_series = 1;

  // The status of the requested write operation.
  ntt.rpc.Status status = 2;
}