Class: Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleRpcStatus
- Inherits:
-
Object
- Object
- Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleRpcStatus
- Defined in:
- generated/google/apis/cloudprivatecatalogproducer_v1beta1/classes.rb,
generated/google/apis/cloudprivatecatalogproducer_v1beta1/representations.rb,
generated/google/apis/cloudprivatecatalogproducer_v1beta1/representations.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
-
#code ⇒ Fixnum
The status code, which should be an enum value of google.rpc.Code.
-
#details ⇒ Array<Hash<String,Object>>
A list of messages that carry the error details.
-
#message ⇒ String
A developer-facing error message, which should be in English.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleRpcStatus
constructor
A new instance of GoogleRpcStatus.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ GoogleRpcStatus
Returns a new instance of GoogleRpcStatus.
1177 1178 1179 |
# File 'generated/google/apis/cloudprivatecatalogproducer_v1beta1/classes.rb', line 1177 def initialize(**args) update!(**args) end |
Instance Attribute Details
#code ⇒ Fixnum
The status code, which should be an enum value of google.rpc.Code.
Corresponds to the JSON property code
1162 1163 1164 |
# File 'generated/google/apis/cloudprivatecatalogproducer_v1beta1/classes.rb', line 1162 def code @code end |
#details ⇒ Array<Hash<String,Object>>
A list of messages that carry the error details. There is a common set of
message types for APIs to use.
Corresponds to the JSON property details
1168 1169 1170 |
# File 'generated/google/apis/cloudprivatecatalogproducer_v1beta1/classes.rb', line 1168 def details @details end |
#message ⇒ 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.
Corresponds to the JSON property message
1175 1176 1177 |
# File 'generated/google/apis/cloudprivatecatalogproducer_v1beta1/classes.rb', line 1175 def @message end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1182 1183 1184 1185 1186 |
# File 'generated/google/apis/cloudprivatecatalogproducer_v1beta1/classes.rb', line 1182 def update!(**args) @code = args[:code] if args.key?(:code) @details = args[:details] if args.key?(:details) @message = args[:message] if args.key?(:message) end |