Google API Common Protos Client - Class Status (4.8.3)

Reference documentation and code samples for the Google API Common Protos Client class Status.

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details.

You can find out more about this error model and how to work with it in the API Design Guide.

Generated from protobuf message google.rpc.Status

Namespace

Google \ Rpc

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ code int

The status code, which should be an enum value of google.rpc.Code.

↳ message string

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

↳ details array<Google\Protobuf\Any>

A list of messages that carry the error details. There is a common set of message types for APIs to use.

getCode

The status code, which should be an enum value of google.rpc.Code.

Returns
Type Description
int

setCode

The status code, which should be an enum value of google.rpc.Code.

Parameter
Name Description
var int
Returns
Type Description
$this

getMessage

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

Returns
Type Description
string

setMessage

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

Parameter
Name Description
var string
Returns
Type Description
$this

getDetails

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setDetails

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Parameter
Name Description
var array<Google\Protobuf\Any>
Returns
Type Description
$this