Documentation

ErrorInfo extends Message
in package

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: { "reason": "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: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }

Generated from protobuf message google.rpc.ErrorInfo

Table of Contents

Properties

$domain  : mixed
The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
$reason  : mixed
The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `[A-Z][A-Z0-9_]+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
$metadata  : mixed
Additional structured details about this error.

Methods

__construct()  : mixed
Constructor.
getDomain()  : string
The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
getMetadata()  : MapField
Additional structured details about this error.
getReason()  : string
The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `[A-Z][A-Z0-9_]+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
setDomain()  : $this
The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
setMetadata()  : $this
Additional structured details about this error.
setReason()  : $this
The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `[A-Z][A-Z0-9_]+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.

Properties

$domain

The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".

protected mixed $domain = ''

Generated from protobuf field string domain = 2 [json_name = "domain"];

$reason

The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `[A-Z][A-Z0-9_]+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.

protected mixed $reason = ''

Generated from protobuf field string reason = 1 [json_name = "reason"];

$metadata

Additional structured details about this error.

private mixed $metadata

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 [json_name = "metadata"];

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $data = NULL ]) : mixed
Parameters
$data : array<string|int, mixed> = NULL

{ Optional. Data for populating the Message object.

@type string $reason
      The reason of the error. This is a constant value that identifies the
      proximate cause of the error. Error reasons are unique within a particular
      domain of errors. This should be at most 63 characters and match a
      regular expression of `[A-Z][A-Z0-9_]+[A-Z0-9]`, which represents
      UPPER_SNAKE_CASE.
@type string $domain
      The logical grouping to which the "reason" belongs. The error domain
      is typically the registered service name of the tool or product that
      generates the error. Example: "pubsub.googleapis.com". If the error is
      generated by some common infrastructure, the error domain must be a
      globally unique value that identifies the infrastructure. For Google API
      infrastructure, the error domain is "googleapis.com".
@type array|\Google\Protobuf\Internal\MapField $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.

}

getDomain()

The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".

public getDomain() : string

Generated from protobuf field string domain = 2 [json_name = "domain"];

Return values
string

getMetadata()

Additional structured details about this error.

public getMetadata() : MapField

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 [json_name = "metadata"];

Return values
MapField

getReason()

The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `[A-Z][A-Z0-9_]+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.

public getReason() : string

Generated from protobuf field string reason = 1 [json_name = "reason"];

Return values
string

setDomain()

The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".

public setDomain(string $var) : $this

Generated from protobuf field string domain = 2 [json_name = "domain"];

Parameters
$var : string
Return values
$this

setMetadata()

Additional structured details about this error.

public setMetadata(array<string|int, mixed>|MapField $var) : $this

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 [json_name = "metadata"];

Parameters
$var : array<string|int, mixed>|MapField
Return values
$this

setReason()

The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `[A-Z][A-Z0-9_]+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.

public setReason(string $var) : $this

Generated from protobuf field string reason = 1 [json_name = "reason"];

Parameters
$var : string
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results