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 \ RpcMethods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ 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 .
int
setCode
The status code, which should be an enum value of google.rpc.Code .
var
int
$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.
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.
var
string
$this
getDetails
A list of messages that carry the error details. There is a common set of message types for APIs to use.
setDetails
A list of messages that carry the error details. There is a common set of message types for APIs to use.
$this
