google.api.monitored_resource_pb2¶
Classes
MonitoredResource |
An object representing a resource that can be used for monitoring, logging, billing, or other purposes. |
MonitoredResourceDescriptor |
An object that describes the schema of a MonitoredResource object using a type name and a set of labels. |
-
class
google.api.monitored_resource_pb2.
MonitoredResource
[source]¶ An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The
type
field identifies aMonitoredResourceDescriptor
object that describes the resource’s schema. Information in thelabels
field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because theMonitoredResourceDescriptor
for"gce_instance"
has labels"instance_id"
and"zone"
:{ "type": "gce_instance", "labels": { "instance_id": "12345678901234", "zone": "us-central1-a" }}
-
type
¶ string
Required. The monitored resource type. This field must match the
type
field of aMonitoredResourceDescriptor
object. For example, the type of a Cloud SQL database is"cloudsql_database"
.
-
labels
¶ dict[string ->
google.api.monitored_resource_pb2.MonitoredResource.LabelsEntry
]Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Cloud SQL databases use the labels
"database_id"
and"zone"
.
-
-
class
google.api.monitored_resource_pb2.
MonitoredResourceDescriptor
[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.-
name
¶ string
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
¶ string
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.
-
display_name
¶ string
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"
.
-
description
¶ string
Optional. A detailed description of the monitored resource type that might be used in documentation.
-
labels
¶ list[
google.api.label_pb2.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"
.
-