Class: Google::Apis::GenomicsV1::Entry
- Inherits:
-
Object
- Object
- Google::Apis::GenomicsV1::Entry
- 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
Instance Attribute Summary collapse
-
#annotation ⇒ Google::Apis::GenomicsV1::Annotation
An annotation describes a region of reference genome.
-
#status ⇒ Google::Apis::GenomicsV1::Status
The
Status
type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Entry
constructor
A new instance of Entry.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Entry
Returns a new instance of Entry
759 760 761 |
# File 'generated/google/apis/genomics_v1/classes.rb', line 759 def initialize(**args) update!(**args) end |
Instance Attribute Details
#annotation ⇒ Google::Apis::GenomicsV1::Annotation
An annotation describes a region of reference genome. The value of an
annotation may be one of several canonical types, supplemented by arbitrary
info tags. An annotation is not inherently associated with a specific
sample or individual (though a client could choose to use annotations in
this way). Example canonical annotation types are GENE
and
VARIANT
.
Corresponds to the JSON property annotation
714 715 716 |
# File 'generated/google/apis/genomics_v1/classes.rb', line 714 def annotation @annotation end |
#status ⇒ Google::Apis::GenomicsV1::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. 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 packagegoogle.rpc
that can be used for common error conditions. # Language mapping TheStatus
message is the logical representation of the error model, but it is not necessarily the actual wire format. When theStatus
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 theStatus
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. - 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. Corresponds to the JSON propertystatus
757 758 759 |
# File 'generated/google/apis/genomics_v1/classes.rb', line 757 def status @status end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
764 765 766 767 |
# File 'generated/google/apis/genomics_v1/classes.rb', line 764 def update!(**args) @annotation = args[:annotation] if args.key?(:annotation) @status = args[:status] if args.key?(:status) end |