MonitoredResourceDescriptor class
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.
Constructors
Properties
- description ↔ String
-
Optional. A detailed description of the monitored resource type that might
be used in documentation.
read / write
- displayName ↔ 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"
.read / write -
labels
↔ List<
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"
.read / write - launchStage ↔ String
-
Optional. The launch stage of the monitored resource definition.
Possible string values are: [...]
read / write
- 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}"
.read / write - 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.read / write - hashCode → int
-
The hash code for this object.
read-only, inherited
- runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited
Methods
-
toJson(
) → Map< String, Object> -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed.
inherited
-
toString(
) → String -
Returns a string representation of this object.
inherited
Operators
-
operator ==(
dynamic other) → bool -
The equality operator.
inherited