Class: Google::Apis::ToolresultsV1beta3::Status
- Inherits:
-
Object
- Object
- Google::Apis::ToolresultsV1beta3::Status
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/toolresults_v1beta3/classes.rb,
generated/google/apis/toolresults_v1beta3/representations.rb,
generated/google/apis/toolresults_v1beta3/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<Google::Apis::ToolresultsV1beta3::Any>
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) ⇒ Status
constructor
A new instance of Status.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Status
Returns a new instance of Status.
2233 2234 2235 |
# File 'generated/google/apis/toolresults_v1beta3/classes.rb', line 2233 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
2218 2219 2220 |
# File 'generated/google/apis/toolresults_v1beta3/classes.rb', line 2218 def code @code end |
#details ⇒ Array<Google::Apis::ToolresultsV1beta3::Any>
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
2224 2225 2226 |
# File 'generated/google/apis/toolresults_v1beta3/classes.rb', line 2224 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
2231 2232 2233 |
# File 'generated/google/apis/toolresults_v1beta3/classes.rb', line 2231 def @message end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2238 2239 2240 2241 2242 |
# File 'generated/google/apis/toolresults_v1beta3/classes.rb', line 2238 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 |