google_api_monitoring v0.2.0 GoogleApi.Monitoring.V3.Model.MonitoredResourceDescriptor 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 (String.t): Optional. A detailed description of the monitored resource type that might be used in documentation. Defaults to: null.
  • displayName (String.t): 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". Defaults to: null.
  • labels ([LabelDescriptor]): 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". Defaults to: null.
  • name (String.t): 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}". Defaults to: null.
  • type (String.t): Required. The monitored resource type. For example, the type "cloudsql_database" represents databases in Google Cloud SQL. The maximum length of this value is 256 characters. Defaults to: null.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields

Link to this section Types

Link to this type t() View Source
t() :: %GoogleApi.Monitoring.V3.Model.MonitoredResourceDescriptor{
  description: any(),
  displayName: any(),
  labels: [GoogleApi.Monitoring.V3.Model.LabelDescriptor.t()],
  name: any(),
  type: any()
}

Link to this section Functions

Link to this function decode(value, options) View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.