PHPFUI/InstaDoc
 
Copied!

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.

Generated from protobuf message google.api.MonitoredResourceDescriptor

CloneableInstantiable
Methods
public __construct( $data = NULL)
 

Constructor.

  • param array $data { Optional. Data for populating the Message object. 
    @type string $name
      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 $type
      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](https://cloud.google.com/monitoring/api/resources)
      and [Logging resource
      types](https://cloud.google.com/logging/docs/api/v2/resource-list).
@type string $display_name
      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"`.
@type string $description
      Optional. A detailed description of the monitored resource type that might
      be used in documentation.
@type array<\Google\Api\LabelDescriptor>|\Google\Protobuf\Internal\RepeatedField $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"`.
@type int $launch_stage
      Optional. The launch stage of the monitored resource definition.
    }
public Google\Protobuf\Internal\Message::__debugInfo()
public Google\Protobuf\Internal\Message::byteSize()
 
  • ignore
public Google\Protobuf\Internal\Message::clear()
 

Clear all containing fields.

  • return null
public Google\Protobuf\Internal\Message::discardUnknownFields()
 

Clear all unknown fields previously parsed.

  • return null
public getDescription()
 

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

Generated from protobuf field string description = 3;

  • return string
public 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;

  • return string
public 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;

  • return \Google\Protobuf\Internal\RepeatedField
public getLaunchStage()
 

Optional. The launch stage of the monitored resource definition.

Generated from protobuf field .google.api.LaunchStage launch_stage = 7;

  • return int
public 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;

  • return string
public 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.

Generated from protobuf field string type = 1;

  • return string
public Google\Protobuf\Internal\Message::jsonByteSize( $options = 0)
 
  • ignore
public Google\Protobuf\Internal\Message::mergeFrom( $msg)
 

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Map fields key-value pairs are overwritten. Singular/Oneof sub-messages are recursively merged. All overwritten sub-messages are deep-copied.

  • param object $msg Protobuf message to be merged from.
  • return null
public Google\Protobuf\Internal\Message::mergeFromJsonString( $data, $ignore_unknown = false)
 

Parses a json string to protobuf message.

This function takes a string in the json wire format, matching the encoding output by serializeToJsonString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

  • param string $data Json protobuf data.
  • param bool $ignore_unknown
  • return null
  • throws \Exception Invalid data.
public Google\Protobuf\Internal\Message::mergeFromString( $data)
 

Parses a protocol buffer contained in a string.

This function takes a string in the (non-human-readable) binary wire format, matching the encoding output by serializeToString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

  • param string $data Binary protobuf data.
  • return null
  • throws \Exception Invalid data.
public Google\Protobuf\Internal\Message::parseFromJsonStream( $input, $ignore_unknown)
 
  • ignore
public Google\Protobuf\Internal\Message::parseFromStream( $input)
 
  • ignore
public Google\Protobuf\Internal\Message::serializeToJsonStream( $output)
 
  • ignore
public Google\Protobuf\Internal\Message::serializeToJsonString( $options = 0)
 

Serialize the message to json string.

  • return string Serialized json protobuf data.
public Google\Protobuf\Internal\Message::serializeToStream( $output)
 
  • ignore
public Google\Protobuf\Internal\Message::serializeToString()
 

Serialize the message to string.

  • return string Serialized binary protobuf data.
public setDescription( $var)
 

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

Generated from protobuf field string description = 3;

  • param string $var
  • return $this
public setDisplayName( $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;

  • param string $var
  • return $this
public setLabels( $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;

  • param \Google\Api\LabelDescriptor[]|\Google\Protobuf\Internal\RepeatedField $var
  • return $this
public setLaunchStage( $var)
 

Optional. The launch stage of the monitored resource definition.

Generated from protobuf field .google.api.LaunchStage launch_stage = 7;

  • param int $var
  • return $this
public setName( $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;

  • param string $var
  • return $this
public setType( $var)
 

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.

Generated from protobuf field string type = 1;

  • param string $var
  • return $this
Properties
protected $description = ''
 

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

Generated from protobuf field string description = 3;

protected $display_name = ''
 

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;

protected $launch_stage = 0
 

Optional. The launch stage of the monitored resource definition.

Generated from protobuf field .google.api.LaunchStage launch_stage = 7;

protected $name = ''
 

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;

protected $type = ''
 

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.

Generated from protobuf field string type = 1;

Methods
protected Google\Protobuf\Internal\Message::hasOneof( $number)
protected Google\Protobuf\Internal\Message::mergeFromArray(array $array)
 

Populates the message from a user-supplied PHP array. Array keys correspond to Message properties and nested message properties.

Example:

$message->mergeFromArray([
    'name' => 'This is a message name',
    'interval' => [
         'startTime' => time() - 60,
         'endTime' => time(),
    ]
]);

This method will trigger an error if it is passed data that cannot be converted to the correct type. For example, a StringValue field must receive data that is either a string or a StringValue object.

  • param array $array An array containing message properties and values.
  • return null
protected Google\Protobuf\Internal\Message::mergeFromJsonArray( $array, $ignore_unknown)
protected Google\Protobuf\Internal\Message::readOneof( $number)
protected Google\Protobuf\Internal\Message::readWrapperValue( $member)
protected Google\Protobuf\Internal\Message::whichOneof( $oneof_name)
protected Google\Protobuf\Internal\Message::writeOneof( $number, $value)
protected Google\Protobuf\Internal\Message::writeWrapperValue( $member, $value)
Properties
private $labels = NULL
 

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;

© 2025 Bruce Wells
Search Namespaces \ Classes
Configuration