Class Google::Rpc::Status (v0.1.0)

Version 0.1.0

• 0.61.0 (latest)
• 0.60.0
• 0.59.0
• 0.58.0
• 0.57.0
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.1
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

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.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#code

def code() -> ::Integer

Returns

• (::Integer) — The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

#code=

def code=(value) -> ::Integer

Parameter

• value (::Integer) — The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

Returns

• (::Integer) — The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

#details

def details() -> ::Array<::Google::Protobuf::Any>

Returns

• (::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.

#details=

def details=(value) -> ::Array<::Google::Protobuf::Any>

Parameter

• value (::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.

Returns

• (::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.

#message

def message() -> ::String

Returns

• (::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.

#message=

def message=(value) -> ::String

Parameter

• value (::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.

Returns

• (::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.