Class: Google::Apis::GenomicsV1::Status
- Inherits:
-
Object
- Object
- Google::Apis::GenomicsV1::Status
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/genomics_v1/classes.rb,
generated/google/apis/genomics_v1/representations.rb,
generated/google/apis/genomics_v1/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. The error model is designed to be: - Simple to
use and understand for most users - Flexible enough to meet unexpected needs #
Overview The Status
message contains three pieces of data: error code, error
message, and error details. The error code should be an enum value of google.
rpc.Code, but it may accept additional error codes if needed. The error
message should be a developer-facing English message that helps developers *
understand* and resolve the error. If a localized user-facing error message
is needed, put the localized message in the error details or localize it in
the client. The optional error details may contain arbitrary information about
the error. There is a predefined set of error detail types in the package
google.rpc
which can be used for common error conditions. # Language mapping
The Status
message is the logical representation of the error model, but it
is not necessarily the actual wire format. When the Status
message is
exposed in different client libraries and different wire protocols, it can be
mapped differently. For example, it will likely be mapped to some exceptions
in Java, but more likely mapped to some error codes in C. # Other uses The
error model and the Status
message can be used in a variety of environments,
either with or without APIs, to provide a consistent developer experience
across different environments. Example uses of this error model include: -
Partial errors. If a service needs to return partial errors to the client, it
may embed the Status
in the normal response to indicate the partial errors. -
Workflow errors. A typical workflow has multiple steps. Each step may have a
Status
message for error reporting purpose. - Batch operations. If a client
uses batch request and batch response, the Status
message should be used
directly inside batch response, one for each error sub-response. -
Asynchronous operations. If an API call embeds asynchronous operation results
in its response, the status of those operations should be represented directly
using the Status
message. - Logging. If some API errors are stored in logs,
the message Status
could be used directly after any stripping needed for
security/privacy reasons.
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) ⇒ 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.
689 690 691 |
# File 'generated/google/apis/genomics_v1/classes.rb', line 689 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
674 675 676 |
# File 'generated/google/apis/genomics_v1/classes.rb', line 674 def code @code end |
#details ⇒ Array<Hash<String,Object>>
A list of messages that carry the error details. There will be a common set of
message types for APIs to use.
Corresponds to the JSON property details
687 688 689 |
# File 'generated/google/apis/genomics_v1/classes.rb', line 687 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
681 682 683 |
# File 'generated/google/apis/genomics_v1/classes.rb', line 681 def @message end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
694 695 696 697 698 |
# File 'generated/google/apis/genomics_v1/classes.rb', line 694 def update!(**args) @code = args[:code] if args.key?(:code) @message = args[:message] if args.key?(:message) @details = args[:details] if args.key?(:details) end |