MonitoredResourceDescriptor
class MonitoredResourceDescriptor extends Message
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.
Protobuf type Google\Api\MonitoredResourceDescriptor
Methods
No description
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}".
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}".
Required. The monitored resource type. For example, the type
"cloudsql_database" represents databases in Google Cloud SQL.
Required. The monitored resource type. For example, the type
"cloudsql_database" represents databases in Google Cloud SQL.
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".
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".
Optional. A detailed description of the monitored resource type that might be used in documentation.
Optional. A detailed description of the monitored resource type that might be used in documentation.
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".
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".
Details
at line 69
__construct()
at line 85
string
getName()
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}".
Generated from protobuf field string name = 5;
at line 101
setName(string $var)
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}".
Generated from protobuf field string name = 5;
at line 115
string
getType()
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.
Generated from protobuf field string type = 1;
at line 128
setType(string $var)
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.
Generated from protobuf field string type = 1;
at line 143
string
getDisplayName()
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".
Generated from protobuf field string display_name = 2;
at line 157
setDisplayName(string $var)
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".
Generated from protobuf field string display_name = 2;
at line 170
string
getDescription()
Optional. A detailed description of the monitored resource type that might be used in documentation.
Generated from protobuf field string description = 3;
at line 182
setDescription(string $var)
Optional. A detailed description of the monitored resource type that might be used in documentation.
Generated from protobuf field string description = 3;
at line 196
RepeatedField
getLabels()
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".
Generated from protobuf field repeated .google.api.LabelDescriptor labels = 4;
at line 209
setLabels(array|RepeatedField $var)
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".
Generated from protobuf field repeated .google.api.LabelDescriptor labels = 4;