github.com/cloudwan/edgelq-sdk@v1.15.4/monitoring/proto/v4/time_series_forwarder_sink.proto (about)

     1  syntax = "proto3";
     2  
     3  package ntt.monitoring.v4;
     4  
     5  import "google/api/resource.proto";
     6  import "google/protobuf/timestamp.proto";
     7  import "goten-sdk/types/meta.proto";
     8  
     9  option go_package = "github.com/cloudwan/edgelq-sdk/monitoring/resources/v4/time_series_forwarder_sink;time_series_forwarder_sink";
    10  option java_multiple_files = true;
    11  option java_outer_classname = "TimeSeriesForwarderSinkProto";
    12  option java_package = "com.ntt.monitoring.pb.v4";
    13  
    14  // TimeSeriesForwarderSink Resource describes destination of TimeSeries data.
    15  // Sink can be connected to TimeSeriesCollectionRule.
    16  // TimeSeriesForwarderSink does not need to be in the same project as collection
    17  // rule. Each item published on the sink will be a protobuf message of
    18  // ntt.monitoring.v4.BulkTimeSeries.
    19  message TimeSeriesForwarderSink {
    20    option (google.api.resource) = {
    21      type : "monitoring.edgelq.com/TimeSeriesForwarderSink"
    22      pattern : "projects/{project}/timeSeriesForwarderSinks/"
    23                "{time_series_forwarder_sink}"
    24    };
    25  
    26    // Name of TimeSeriesForwarderSink
    27    // When creating a new instance, this field is optional and if not provided,
    28    // it will be generated automatically. Last ID segment must conform to the
    29    // following regex: [a-z][a-z0-9\\-]{0,28}[a-z0-9]
    30    string name = 1;
    31  
    32    // Metadata is an object with information like create, update and delete time
    33    // (for async deleted resources), has user labels/annotations, sharding
    34    // information, multi-region syncing information and may have non-schema
    35    // owners (useful for taking ownership of resources belonging to lower level
    36    // services by higher ones).
    37    goten.types.Meta metadata = 2;
    38  
    39    // Optional display name
    40    string display_name = 5;
    41  
    42    // Current spec
    43    Spec spec = 3;
    44  
    45    // Current status
    46    Status status = 4;
    47  
    48    // Sink specification, instructing where data must go.
    49    // It must specify one valid sink spec inside.
    50    message Spec {
    51      // Optional data compression.
    52      Compression compression = 1;
    53  
    54      oneof sink { AzureEventHubSink azure_event_hub = 2; }
    55  
    56      // AzureEventHubSink describes sink for Azure Event Hub.
    57      message AzureEventHubSink {
    58        // Endpoint must contain secret value for authentication purposes,
    59        // therefore it is packed as a Secret resource. Secret resource itself
    60        // must contain following data field:
    61        // {
    62        //  "data": {
    63        //    "EndpointString":
    64        //    "Endpoint=sb://<name>.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=<SECRET>;EntityPath=<topicName>"
    65        //   }
    66        // }
    67        // Replace <> elements with appropiate values.
    68        string endpoint = 1;
    69      }
    70  
    71      enum Compression {
    72        NO_COMPRESSION = 0;
    73  
    74        SNAPPY = 1;
    75      }
    76    }
    77  
    78    // Status describes status of TimeSeriesForwarderSink.
    79    message Status {
    80      // If there is some persisting error on the sink, it will be reported here.
    81      string error = 1;
    82    }
    83  }