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
ExtendsGoogle\Protobuf\Internal\Message
Methods
public __construct( $data = NULL)
 

Constructor.

    public Google\Protobuf\Internal\Message::byteSize()
     
    • ignore
    public Google\Protobuf\Internal\Message::clear()
     

    Clear all containing fields.

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

    Clear all unknown fields previously parsed.

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

    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.

    The maximum length of this value is 256 characters.

    Generated from protobuf field string type = 1;

    • return string
    public Google\Protobuf\Internal\Message::jsonByteSize()
     
    • 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.

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

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

    • return
    • 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()
     

    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;

    • 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;

    • 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;

    • 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;

    • return $this
    public setType( $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;

    • return $this
    Methods
    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.

    • return
    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 $description
     

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

    Generated from protobuf field string description = 3;

    private $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;

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

    Generated from protobuf field repeated .google.api.LabelDescriptor labels = 4;

    private $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;

    private $type
     

    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;

    Methods
    private Google\Protobuf\Internal\Message::appendHelper( $field, $append_value)
    private Google\Protobuf\Internal\Message::convertJsonValueToProtoValue( $value, $field, $ignore_unknown, $is_map_key = false)
    private Google\Protobuf\Internal\Message::defaultValue( $field)
     
    • ignore
    private Google\Protobuf\Internal\Message::existField( $field)
     
    • ignore
    private Google\Protobuf\Internal\Message::fieldByteSize( $field)
     
    • ignore
    private Google\Protobuf\Internal\Message::fieldDataOnlyByteSize( $field, $value)
     
    • ignore
    private Google\Protobuf\Internal\Message::fieldDataOnlyJsonByteSize( $field, $value)
     
    • ignore
    private Google\Protobuf\Internal\Message::fieldJsonByteSize( $field)
     
    • ignore
    private Google\Protobuf\Internal\Message::initWithDescriptor(Google\Protobuf\Internal\Descriptor $desc)
     
    • ignore
    private Google\Protobuf\Internal\Message::initWithGeneratedPool()
     
    • ignore
    private Google\Protobuf\Internal\Message::kvUpdateHelper( $field, $update_key, $update_value)
    private Google\Protobuf\Internal\Message::mergeFromArrayJsonImpl( $array, $ignore_unknown)
    private static Google\Protobuf\Internal\Message::normalizeArrayElementsToMessageType( $value, $class)
     

    Tries to normalize the elements in $value into a provided protobuf
    wrapper type $class. If $value is any type other than array, we do
    not do any conversion, and instead rely on the existing protobuf
    type checking. If $value is an array, we process each element and
    try to convert it to an instance of $class.

      private static Google\Protobuf\Internal\Message::normalizeToMessageType( $value, $class)
       

      Tries to normalize $value into a provided protobuf wrapper type $class.

      If $value is any type other than an object, we attempt to construct an
      instance of $class and assign $value to it using the setValue method
      shared by all wrapper types.

      This method will raise an error if it receives a type that cannot be
      assigned to the wrapper type via setValue.

        private Google\Protobuf\Internal\Message::parseFieldFromStream( $tag, $input, $field)
         
        • ignore
        private static Google\Protobuf\Internal\Message::parseFieldFromStreamNoTag( $input, $field, $value)
         
        • ignore
        private Google\Protobuf\Internal\Message::repeatedFieldDataOnlyByteSize( $field)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeFieldToJsonStream( $output, $field)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeFieldToStream( $output, $field)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeMapFieldToStream( $field, $output)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeRepeatedFieldToStream( $field, $output)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeSingularFieldToStream( $field, $output)
         
        • ignore
        private Google\Protobuf\Internal\Message::skipField( $input, $tag)
         
        • ignore
        Methods
        private static Google\Protobuf\Internal\Message::normalizeArrayElementsToMessageType( $value, $class)
         

        Tries to normalize the elements in $value into a provided protobuf
        wrapper type $class. If $value is any type other than array, we do
        not do any conversion, and instead rely on the existing protobuf
        type checking. If $value is an array, we process each element and
        try to convert it to an instance of $class.

          private static Google\Protobuf\Internal\Message::normalizeToMessageType( $value, $class)
           

          Tries to normalize $value into a provided protobuf wrapper type $class.

          If $value is any type other than an object, we attempt to construct an
          instance of $class and assign $value to it using the setValue method
          shared by all wrapper types.

          This method will raise an error if it receives a type that cannot be
          assigned to the wrapper type via setValue.

            private static Google\Protobuf\Internal\Message::parseFieldFromStreamNoTag( $input, $field, $value)
             
            • ignore
            © 2020 Bruce Wells
            Search Namespaces \ Classes
            ConfigurationNumbers (0-9.) only