Cloud Optimization V1 API - Class Google::Rpc::Status (v0.14.1)
Reference documentation and code samples for the Cloud Optimization V1 API class Google::Rpc::Status.
TheStatus type defines a logical error model that is suitable fordifferent programming environments, including REST APIs and RPC APIs. It isused bygRPC. EachStatus message containsthree 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 theAPI Design Guide.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#code
defcode()->::Integer- (::Integer) — The status code, which should be an enum value of[google.rpc.Code][google.rpc.Code].
#code=
defcode=(value)->::Integer- value (::Integer) — The status code, which should be an enum value of[google.rpc.Code][google.rpc.Code].
- (::Integer) — The status code, which should be an enum value of[google.rpc.Code][google.rpc.Code].
#details
defdetails()->::Array<::Google::Protobuf::Any>- (::Array<::Google::Protobuf::Any>) — A list of messages that carry the error details. There is a common set ofmessage types for APIs to use.
#details=
defdetails=(value)->::Array<::Google::Protobuf::Any>- value (::Array<::Google::Protobuf::Any>) — A list of messages that carry the error details. There is a common set ofmessage types for APIs to use.
- (::Array<::Google::Protobuf::Any>) — A list of messages that carry the error details. There is a common set ofmessage types for APIs to use.
#message
defmessage()->::String- (::String) — A developer-facing error message, which should be in English. Anyuser-facing error message should be localized and sent in thegoogle.rpc.Status.details field, or localizedby the client.
#message=
defmessage=(value)->::String- value (::String) — A developer-facing error message, which should be in English. Anyuser-facing error message should be localized and sent in thegoogle.rpc.Status.details field, or localizedby the client.
- (::String) — A developer-facing error message, which should be in English. Anyuser-facing error message should be localized and sent in thegoogle.rpc.Status.details field, or localizedby the client.
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-30 UTC.