Reference documentation and code samples for the Transcoder V1 API class Google::Rpc::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.
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.