1. class
  2. Google
  3. \
  4. ApiCore
  5. \
  6. ApiException

ApiException

class ApiException extends Exception (View source)

Represents an exception thrown during an RPC.

Methods

__construct(string $message, int $code, string $status, array $optionalArgs = [])

ApiException constructor.

getStatus()

No description

static ApiException
createFromStdClass(stdClass $status)

No description

static ApiException
createFromApiResponse(string $basicMessage, int $rpcCode, array $metadata = null, Exception $previous = null)

No description

static ApiException
createFromRestApiResponse(string $basicMessage, int $rpcCode, array $metadata = null, Exception $previous = null)

For REST-based responses, the metadata does not need to be decoded.

static ApiException
createFromRpcStatus(Status $status)

No description

static ApiException
createFromRequestException(RequestException $ex, bool $isStream = false)

Creates an ApiException from a GuzzleHttp RequestException.

null|string
getBasicMessage()

No description

array
getMetadata()

No description

string
__toString()

String representation of ApiException

Details

at line 59
__construct(string $message, int $code, string $status, array $optionalArgs = [])

ApiException constructor.

Parameters

string $message
int $code
string $status
array $optionalArgs

{ @type Exception|null $previous @type array|null $metadata @type string|null $basicMessage }

at line 76
getStatus()

No description

at line 85
static ApiException createFromStdClass(stdClass $status)

No description

Parameters

stdClass $status

Return Value

ApiException

at line 103
static ApiException createFromApiResponse(string $basicMessage, int $rpcCode, array $metadata = null, Exception $previous = null)

No description

Parameters

string $basicMessage
int $rpcCode
array $metadata
Exception $previous

Return Value

ApiException

at line 127
static ApiException createFromRestApiResponse(string $basicMessage, int $rpcCode, array $metadata = null, Exception $previous = null)

For REST-based responses, the metadata does not need to be decoded.

Parameters

string $basicMessage
int $rpcCode
array $metadata
Exception $previous

Return Value

ApiException

at line 179
static ApiException createFromRpcStatus(Status $status)

No description

Parameters

Status $status

Return Value

ApiException

at line 197
static ApiException createFromRequestException(RequestException $ex, bool $isStream = false)

Creates an ApiException from a GuzzleHttp RequestException.

Parameters

RequestException $ex
bool $isStream

Return Value

ApiException

Exceptions

ValidationException

at line 225
null|string getBasicMessage()

No description

Return Value

null|string

at line 233
array getMetadata()

No description

Return Value

array

at line 242
string __toString()

String representation of ApiException

Return Value

string