Google API Common Protos Client - Class MonitoredResourceDescriptor (4.12.4)

Reference documentation and code samples for the Google API Common Protos Client class MonitoredResourceDescriptor.

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.

Generated from protobuf message google.api.MonitoredResourceDescriptor

Namespace

Google \ Api

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

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}".
↳ type string

Required. The monitored resource type. For example, the type "cloudsql_database" represents databases in Google Cloud SQL. For a list of types, see Monitored resource types and Logging resource types.
↳ 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 array<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".
↳ launch_stage int

Optional. The launch stage of the monitored resource definition.

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}".

Returns
Type Description
string

setName

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}".

Parameter
Name Description
var string
Returns
Type Description
$this

getType

Required. The monitored resource type. For example, the type "cloudsql_database" represents databases in Google Cloud SQL.

For a list of types, see Monitored resource types and Logging resource types.

Returns
Type Description
string

setType

Required. The monitored resource type. For example, the type "cloudsql_database" represents databases in Google Cloud SQL.

For a list of types, see Monitored resource types and Logging resource types.

Parameter
Name Description
var string
Returns
Type Description
$this

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".

Returns
Type Description
string

setDisplayName

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".

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

Optional. A detailed description of the monitored resource type that might be used in documentation.

Returns
Type Description
string

setDescription

Optional. A detailed description of the monitored resource type that might be used in documentation.

Parameter
Name Description
var string
Returns
Type Description
$this

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".

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setLabels

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".

Parameter
Name Description
var array<LabelDescriptor>
Returns
Type Description
$this

getLaunchStage

Optional. The launch stage of the monitored resource definition.

Returns
Type Description
int Enum of type LaunchStage.

setLaunchStage

Optional. The launch stage of the monitored resource definition.

Parameter
Name Description
var int

Enum of type LaunchStage.

Returns
Type Description
$this