1. class
  2. Google
  3. \
  4. Rpc
  5. \
  6. ErrorInfo

ErrorInfo

class ErrorInfo extends Message

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

Properties

protected $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-Z0-9_]+/.
protected $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".

Methods

__construct(array $data = NULL)

Constructor.

string
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-Z0-9_]+/.

$this
setReason(string $var)

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-Z0-9_]+/.

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

$this
setDomain(string $var)

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

MapField
getMetadata()

Additional structured details about this error.

$this
setMetadata(array|MapField $var)

Additional structured details about this error.

Details

at line 97
__construct(array $data = NULL)

Constructor.

Parameters

array $data { 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-Z0-9_]+/.
@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.

}

at line 111
string 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-Z0-9_]+/.

Generated from protobuf field string reason = 1;

Return Value

string

at line 126
$this setReason(string $var)

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-Z0-9_]+/.

Generated from protobuf field string reason = 1;

Parameters

string $var

Return Value

$this

at line 145
string 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".

Generated from protobuf field string domain = 2;

Return Value

string

at line 162
$this setDomain(string $var)

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

Generated from protobuf field string domain = 2;

Parameters

string $var

Return Value

$this

at line 182
MapField 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;

Return Value

MapField

at line 200
$this setMetadata(array|MapField $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;

Parameters

array|MapField $var

Return Value

$this