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

Status

class Status extends Message

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

Properties

protected $code The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
protected $message 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][google.rpc.Status.details] field, or localized by the client.

Methods

__construct(array $data = NULL)

Constructor.

int
getCode()

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

$this
setCode(int $var)

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

string
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][google.rpc.Status.details] field, or localized by the client.

$this
setMessage(string $var)

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][google.rpc.Status.details] field, or localized by the client.

RepeatedField
getDetails()

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

$this
setDetails(Any[]|RepeatedField $var)

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

Details

at line 62
__construct(array $data = NULL)

Constructor.

Parameters

array $data { Optional. Data for populating the Message object.

@type int $code
      The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
@type string $message
      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][google.rpc.Status.details] field, or localized by the client.
@type \Google\Protobuf\Any[]|\Google\Protobuf\Internal\RepeatedField $details
      A list of messages that carry the error details.  There is a common set of
      message types for APIs to use.

}

at line 73
int getCode()

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

Generated from protobuf field int32 code = 1;

Return Value

int

at line 85
$this setCode(int $var)

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

Generated from protobuf field int32 code = 1;

Parameters

int $var

Return Value

$this

at line 101
string 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][google.rpc.Status.details] field, or localized by the client.

Generated from protobuf field string message = 2;

Return Value

string

at line 115
$this setMessage(string $var)

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][google.rpc.Status.details] field, or localized by the client.

Generated from protobuf field string message = 2;

Parameters

string $var

Return Value

$this

at line 130
RepeatedField getDetails()

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

Generated from protobuf field repeated .google.protobuf.Any details = 3;

Return Value

RepeatedField

at line 143
$this setDetails(Any[]|RepeatedField $var)

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

Generated from protobuf field repeated .google.protobuf.Any details = 3;

Parameters

Any[]|RepeatedField $var

Return Value

$this