Reference documentation and code samples for the Cloud IDS 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
defcode()->::Integer
Returns
(::Integer) — The status code, which should be an enum value of
[google.rpc.Code][google.rpc.Code].
#code=
defcode=(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
defdetails()->::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.
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
defmessage()->::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=
defmessage=(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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[],[],null,["# Cloud IDS V1 API - Class Google::Rpc::Status (v2.1.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.1.0 (latest)](/ruby/docs/reference/google-cloud-ids-v1/latest/Google-Rpc-Status)\n- [2.0.1](/ruby/docs/reference/google-cloud-ids-v1/2.0.1/Google-Rpc-Status)\n- [1.2.0](/ruby/docs/reference/google-cloud-ids-v1/1.2.0/Google-Rpc-Status)\n- [1.1.0](/ruby/docs/reference/google-cloud-ids-v1/1.1.0/Google-Rpc-Status)\n- [1.0.1](/ruby/docs/reference/google-cloud-ids-v1/1.0.1/Google-Rpc-Status)\n- [0.7.0](/ruby/docs/reference/google-cloud-ids-v1/0.7.0/Google-Rpc-Status)\n- [0.6.2](/ruby/docs/reference/google-cloud-ids-v1/0.6.2/Google-Rpc-Status)\n- [0.5.0](/ruby/docs/reference/google-cloud-ids-v1/0.5.0/Google-Rpc-Status)\n- [0.4.0](/ruby/docs/reference/google-cloud-ids-v1/0.4.0/Google-Rpc-Status)\n- [0.3.0](/ruby/docs/reference/google-cloud-ids-v1/0.3.0/Google-Rpc-Status)\n- [0.2.0](/ruby/docs/reference/google-cloud-ids-v1/0.2.0/Google-Rpc-Status)\n- [0.1.1](/ruby/docs/reference/google-cloud-ids-v1/0.1.1/Google-Rpc-Status) \nReference documentation and code samples for the Cloud IDS V1 API class Google::Rpc::Status.\n\nThe `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). Each `Status` message contains\nthree pieces of data: error code, error message, and error details.\n\n\n\u003cbr /\u003e\n\nYou can find out more about this error model and how to work with it in the\n[API Design Guide](https://cloud.google.com/apis/design/errors). \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #code\n\n def code() -\u003e ::Integer\n\n**Returns**\n\n- (::Integer) --- The status code, which should be an enum value of \\[google.rpc.Code\\]\\[google.rpc.Code\\].\n\n### #code=\n\n def code=(value) -\u003e ::Integer\n\n**Parameter**\n\n- **value** (::Integer) --- The status code, which should be an enum value of \\[google.rpc.Code\\]\\[google.rpc.Code\\]. \n**Returns**\n\n- (::Integer) --- The status code, which should be an enum value of \\[google.rpc.Code\\]\\[google.rpc.Code\\].\n\n### #details\n\n def details() -\u003e ::Array\u003c::Google::Protobuf::Any\u003e\n\n**Returns**\n\n- (::Array\\\u003c[::Google::Protobuf::Any](./Google-Protobuf-Any)\\\u003e) --- A list of messages that carry the error details. There is a common set of message types for APIs to use.\n\n### #details=\n\n def details=(value) -\u003e ::Array\u003c::Google::Protobuf::Any\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c[::Google::Protobuf::Any](./Google-Protobuf-Any)\\\u003e) --- A list of messages that carry the error details. There is a common set of message types for APIs to use. \n**Returns**\n\n- (::Array\\\u003c[::Google::Protobuf::Any](./Google-Protobuf-Any)\\\u003e) --- A list of messages that carry the error details. There is a common set of message types for APIs to use.\n\n### #message\n\n def message() -\u003e ::String\n\n**Returns**\n\n- (::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](/ruby/docs/reference/google-cloud-ids-v1/latest/Google-Rpc-Status#Google__Rpc__Status_details_instance_ \"Google::Rpc::Status#details (method)\") field, or localized by the client.\n\n### #message=\n\n def message=(value) -\u003e ::String\n\n**Parameter**\n\n- **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](/ruby/docs/reference/google-cloud-ids-v1/latest/Google-Rpc-Status#Google__Rpc__Status_details_instance_ \"Google::Rpc::Status#details (method)\") field, or localized by the client. \n**Returns**\n\n- (::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](/ruby/docs/reference/google-cloud-ids-v1/latest/Google-Rpc-Status#Google__Rpc__Status_details_instance_ \"Google::Rpc::Status#details (method)\") field, or localized by the client."]]
