Describes the cause of the error with structured details.

Example of an error when contacting the "pubsub.googleapis.com" API when it
is not enabled:

{ "type":   "API_DISABLED"
  "domain": "googleapis.com"
  "metadata": {
    "resource": "projects/123",
    "service": "pubsub.googleapis.com"
  }
}

This response indicates that the pubsub.googleapis.com API is not enabled.
Example of an error that is returned when attempting to create a Spanner
instance in a region that is out of stock:

{ "type":   "STOCKOUT"
  "domain": "spanner.googleapis.com",
  "metadata": {
    "availableRegions": ""us-central1,us-east2"
  }
}

Generated from protobuf message google.rpc.ErrorInfo

CloneableInstantiable
ExtendsGoogle\Protobuf\Internal\Message
Methods
public __construct( $data = NULL)
 
Constructor.

    public Google\Protobuf\Internal\Message::byteSize()
     


    • ignore
    public Google\Protobuf\Internal\Message::clear()
    public Google\Protobuf\Internal\Message::discardUnknownFields()
    public getDomain()
     
    The logical grouping to which the "type" belongs. Often "domain" will contain the registered service name of the tool or product that is the source of the error. Example: "pubsub.googleapis.com". If the error is common across many APIs, the first segment of the example above will be omitted. The value will be, "googleapis.com".

    Generated from protobuf field string domain = 2;

    • return string
    public getMetadata()
     
    Additional structured details about this error.

    Keys should match /[a-zA-Z0-9-_]/ and be limited to 64 characters in
    length. When identifying the current value of an exceeded limit, the units
    should be contained in the key, not the value. For example, rather than
    {"instanceLimit": "100/request"}, should be returned as,
    {"instanceLimitPerRequest": "100"}, if the client exceeds the number of
    instances that can be created in a single (batch) request.

    Generated from protobuf field map<string, string> metadata = 3;

    public getType()
     
    The type of the error. This is a constant value that identifies the proximate cause of the error. Error types are unique within a particular source of errors. This should be at most 63 characters and match /[A-Z0-9_]+/.

    Generated from protobuf field string type = 1;

    • return string
    public Google\Protobuf\Internal\Message::jsonByteSize()
     


    • ignore
    public Google\Protobuf\Internal\Message::mergeFrom( $msg)
    public Google\Protobuf\Internal\Message::mergeFromJsonString( $data)
    public Google\Protobuf\Internal\Message::mergeFromString( $data)
    public Google\Protobuf\Internal\Message::parseFromJsonStream( $input)
     


    • 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 setDomain( $var)
     
    The logical grouping to which the "type" belongs. Often "domain" will contain the registered service name of the tool or product that is the source of the error. Example: "pubsub.googleapis.com". If the error is common across many APIs, the first segment of the example above will be omitted. The value will be, "googleapis.com".

    Generated from protobuf field string domain = 2;

    • return $this
    public setMetadata( $var)
     
    Additional structured details about this error.

    Keys should match /[a-zA-Z0-9-_]/ and be limited to 64 characters in
    length. When identifying the current value of an exceeded limit, the units
    should be contained in the key, not the value. For example, rather than
    {"instanceLimit": "100/request"}, should be returned as,
    {"instanceLimitPerRequest": "100"}, if the client exceeds the number of
    instances that can be created in a single (batch) request.

    Generated from protobuf field map<string, string> metadata = 3;

    • return $this
    public setType( $var)
     
    The type of the error. This is a constant value that identifies the proximate cause of the error. Error types are unique within a particular source of errors. This should be at most 63 characters and match /[A-Z0-9_]+/.

    Generated from protobuf field string type = 1;

    • return $this
    Methods
    protected Google\Protobuf\Internal\Message::mergeFromArray(array $array)
    protected Google\Protobuf\Internal\Message::mergeFromJsonArray( $array)
    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 $domain
     
    The logical grouping to which the "type" belongs. Often "domain" will contain the registered service name of the tool or product that is the source of the error. Example: "pubsub.googleapis.com". If the error is common across many APIs, the first segment of the example above will be omitted. The value will be, "googleapis.com".

    Generated from protobuf field string domain = 2;

    private $metadata
     
    Additional structured details about this error.

    Keys should match /[a-zA-Z0-9-_]/ and be limited to 64 characters in
    length. When identifying the current value of an exceeded limit, the units
    should be contained in the key, not the value. For example, rather than
    {"instanceLimit": "100/request"}, should be returned as,
    {"instanceLimitPerRequest": "100"}, if the client exceeds the number of
    instances that can be created in a single (batch) request.

    Generated from protobuf field map<string, string> metadata = 3;

    private $type
     
    The type of the error. This is a constant value that identifies the proximate cause of the error. Error types are unique within a particular source of errors. This should be at most 63 characters and match /[A-Z0-9_]+/.

    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, $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)
    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