Class: Google::Rpc::Status

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/rpc/status.rb

Overview

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.

Instance Attribute Summary collapse

Instance Attribute Details

#code ⇒ ::Integer

Returns 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].



43
44
45
46
 
# File 'proto_docs/google/rpc/status.rb', line 43

class Status
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#details ⇒ ::Array<::Google::Protobuf::Any>

Returns 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.



43
44
45
46
 
# File 'proto_docs/google/rpc/status.rb', line 43

class Status
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#message ⇒ ::String

Returns 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.



43
44
45
46
 
# File 'proto_docs/google/rpc/status.rb', line 43

class Status
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end