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

     1  syntax = "proto3";
     2  
     3  package ntt.monitoring.v3;
     4  
     5  import "edgelq-sdk/monitoring/proto/v3/common.proto";
     6  import "google/api/resource.proto";
     7  import "goten-sdk/types/meta.proto";
     8  
     9  option go_package = "github.com/cloudwan/edgelq-sdk/monitoring/resources/v3/monitored_resource_descriptor;monitored_resource_descriptor";
    10  option java_multiple_files = true;
    11  option java_outer_classname = "MonitoredResourceDescriptorProto";
    12  option java_package = "com.ntt.monitoring.pb.v3";
    13  
    14  // An object that describes the schema of a
    15  // [MonitoredResource][google.api.MonitoredResource] object using a type name
    16  // and a set of labels.  For example, the monitored resource descriptor for
    17  // Google Compute Engine VM instances has a type of
    18  // `"gce_instance"` and specifies the use of the labels `"instance_id"` and
    19  // `"zone"` to identify particular VM instances.
    20  //
    21  // Different APIs can support different monitored resource types. APIs generally
    22  // provide a `list` method that returns the monitored resource descriptors used
    23  // by the API.
    24  message MonitoredResourceDescriptor {
    25    option (google.api.resource) = {
    26      type : "monitoring.edgelq.com/MonitoredResourceDescriptor"
    27      pattern : "monitoredResourceDescriptors/{monitored_resource_descriptor}"
    28    };
    29  
    30    // Optional. The resource name of the monitored resource descriptor:
    31    // `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where
    32    // {type} is the value of the `type` field in this object and
    33    // {project_id} is a project ID that provides API-specific context for
    34    // accessing the type.  APIs that do not use project information can use the
    35    // resource name format `"monitoredResourceDescriptors/{type}"`.
    36    // NOTE: currently only `"monitoredResourceDescriptors/{type}"` form is
    37    // supported.
    38    string name = 5;
    39  
    40    // Required. The monitored resource type. For example, the type
    41    // `"cloudsql_database"` represents databases in Google Cloud SQL.
    42    // The maximum length of this value is 256 characters.
    43    string type = 1;
    44  
    45    // Optional. A concise name for the monitored resource type that might be
    46    // displayed in user interfaces. It should be a Title Cased Noun Phrase,
    47    // without any article or other determiners. For example,
    48    // `"Google Cloud SQL Database"`.
    49    string display_name = 2;
    50  
    51    // Optional. A detailed description of the monitored resource type that might
    52    // be used in documentation.
    53    string description = 3;
    54  
    55    // Required. A set of labels used to describe instances of this monitored
    56    // resource type. For example, an individual Google Cloud SQL database is
    57    // identified by values for the labels `"database_id"` and `"zone"`.
    58    repeated LabelDescriptor labels = 4;
    59  
    60    // Promoted Label Key Sets allow defining multiple indexing rules for
    61    // underlying backend enabling query optimizations. Metric promoted label sets
    62    // are combined with MonitoredResource promoted label sets and result in
    63    // PromotedKeySet.
    64    repeated LabelKeySet promoted_label_key_sets = 32;
    65  
    66    // Metadata
    67    goten.types.Meta metadata = 33;
    68  }