An object that describes the schema of a [MonitoredResource][google.api.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.
Value parameters
- description
-
Optional. A detailed description of the monitored resource type that might be used in documentation.
- displayName
-
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
-
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
-
Optional. The launch stage of the monitored resource definition.
- name
-
Optional. The resource name of the monitored resource descriptor:
"projects/{project_id}/monitoredResourceDescriptors/{type}"
where {type} is the value of thetype
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
-
Required. The monitored resource type. For example, the type
"cloudsql_database"
represents databases in Google Cloud SQL. For a list of types, see Monitoring resource types and Logging resource types.
Attributes
- Companion
- object
- Source
- MonitoredResourceDescriptor.scala
- Graph
-
- Supertypes
-
trait Updatable[MonitoredResourceDescriptor]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any