Google API Core Client - Class ApiException (1.35.0)
Stay organized with collections
Save and categorize content based on your preferences.
Reference documentation and code samples for the Google API Core Client class ApiException.
Represents an exception thrown during an RPC.
Namespace
Google \ ApiCore
Methods
__construct
ApiException constructor.
| Parameters |
| Name |
Description |
message |
string
|
code |
int
|
status |
string|null
|
optionalArgs |
array
{
@type Exception|null $previous
@type array|null $metadata
@type string|null $basicMessage
}
|
↳ previous |
Exception|null
|
↳ metadata |
array|null
|
↳ basicMessage |
string|null
|
getStatus
getReason
Returns the reason in ErrorInfo for an exception, or null if there is no ErrorInfo.
| Returns |
| Type |
Description |
string|null |
$reason |
getDomain
Returns the domain in ErrorInfo for an exception, or null if there is no ErrorInfo.
| Returns |
| Type |
Description |
string|null |
$domain |
Returns the metadata in ErrorInfo for an exception, or null if there is no ErrorInfo.
| Returns |
| Type |
Description |
array|null |
$errorInfoMetadata |
getBasicMessage
| Returns |
| Type |
Description |
null|string |
|
| Returns |
| Type |
Description |
array |
|
__toString
String representation of ApiException
| Returns |
| Type |
Description |
string |
|
static::createFromStdClass
| Parameter |
| Name |
Description |
status |
stdClass
|
static::createFromApiResponse
| Parameters |
| Name |
Description |
basicMessage |
string
|
rpcCode |
int
|
metadata |
array|null
|
previous |
Exception
|
static::createFromRestApiResponse
For REST-based responses, the metadata does not need to be decoded.
| Parameters |
| Name |
Description |
basicMessage |
string
|
rpcCode |
int
|
metadata |
array|null
|
previous |
Exception
|
static::createFromRpcStatus
static::createFromRequestException
Creates an ApiException from a GuzzleHttp RequestException.
| Parameters |
| Name |
Description |
ex |
GuzzleHttp\Exception\RequestException
|
isStream |
bool
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-11-19 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-11-19 UTC."],[],[]]
