GoogleApi.ServiceConsumerManagement.V1.Model.MonitoredResourceDescriptor (google_api_service_consumer_management v0.26.1) View Source

An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of "gce_instance" and specifies the use of the labels "instance_id" and "zone" to identify particular VM instances. Different APIs can support different monitored resource types. APIs generally provide a list method that returns the monitored resource descriptors used by the API.

Attributes

  • description (type: String.t, default: nil) - Optional. A detailed description of the monitored resource type that might be used in documentation.
  • displayName (type: String.t, default: nil) - Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, "Google Cloud SQL Database".
  • labels (type: list(GoogleApi.ServiceConsumerManagement.V1.Model.LabelDescriptor.t), default: nil) - Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels "database_id" and "zone".
  • launchStage (type: String.t, default: nil) - Optional. The launch stage of the monitored resource definition.
  • name (type: String.t, default: nil) - Optional. The resource name of the monitored resource descriptor: "projects/{project_id}/monitoredResourceDescriptors/{type}" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format "monitoredResourceDescriptors/{type}".
  • type (type: String.t, default: nil) - Required. The monitored resource type. For example, the type "cloudsql_database" represents databases in Google Cloud SQL.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Specs

t() ::
  %GoogleApi.ServiceConsumerManagement.V1.Model.MonitoredResourceDescriptor{
    description: String.t(),
    displayName: String.t(),
    labels: [GoogleApi.ServiceConsumerManagement.V1.Model.LabelDescriptor.t()],
    launchStage: String.t(),
    name: String.t(),
    type: String.t()
  }

Link to this section Functions

Specs

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.