Constants

USER_AGENT → String

'dart-api-client genomics/v1'

Classes

Binding

Associates members with a role.

CallSet

A call set is a collection of variant calls, typically for one sample. It belongs to a variant set. For more genomics resource definitions, see Fundamentals of Google Genomics

CallsetsResourceApi

CancelOperationRequest

The request message for Operations.CancelOperation.

CigarUnit

A single CIGAR operation.

CoverageBucket

A bucket over which read coverage has been precomputed. A bucket corresponds to a specific range of the reference sequence.

Dataset

A Dataset is a collection of genomic data. For more genomics resource definitions, see Fundamentals of Google Genomics

DatasetsResourceApi

Empty

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.

Experiment

ExportReadGroupSetRequest

The read group set export request.

ExportVariantSetRequest

The variant data export request.

GenomicsApi

An API to store, process, explore, and share genomic data. It supports reference-based alignements, genetic variants, and reference genomes. This API provides an implementation of the Global Alliance for Genomics and Health (GA4GH) v0.5.1 API as well as several extensions.

GetIamPolicyRequest

Request message for GetIamPolicy method.

ImportReadGroupSetsRequest

The read group set import request.

ImportReadGroupSetsResponse

The read group set import response.

ImportVariantsRequest

The variant data import request.

ImportVariantsResponse

The variant data import response.

LinearAlignment

A linear alignment can be represented by one CIGAR string. Describes the mapped position and local alignment of the read to the reference.

ListBasesResponse

ListCoverageBucketsResponse

ListDatasetsResponse

The dataset list response.

ListOperationsResponse

The response message for Operations.ListOperations.

Operation

This resource represents a long-running operation that is the result of a network API call.

OperationEvent

An event that occurred during an Operation.

OperationMetadata

Metadata describing an Operation.

OperationsResourceApi

Policy

Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A Policy consists of a list of bindings. A Binding binds a list of members to a role, where the members can be user accounts, Google groups, Google domains, and service accounts. A role is a named list of permissions defined by IAM. Example { "bindings": { "role": "roles/owner", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]"] }, { "role": "roles/viewer", "members": ["user:[email protected]"] } } For a description of IAM and its features, see the IAM developer's guide.

Position

An abstraction for referring to a genomic position, in relation to some already known reference. For now, represents a genomic position as a reference name, a base number on that reference (0-based), and a determination of forward or reverse strand.

Program

Range

A 0-based half-open genomic coordinate range for search requests.

Read

A read alignment describes a linear alignment of a string of DNA to a reference sequence, in addition to metadata about the fragment (the molecule of DNA sequenced) and the read (the bases which were read by the sequencer). A read is equivalent to a line in a SAM file. A read belongs to exactly one read group and exactly one read group set. For more genomics resource definitions, see Fundamentals of Google Genomics

ReadGroup

A read group is all the data that's processed the same way by the sequencer.

ReadGroupSet

A read group set is a logical collection of read groups, which are collections of reads produced by a sequencer. A read group set typically models reads corresponding to one sample, sequenced one way, and aligned one way. * A read group set belongs to one dataset. * A read group belongs to one read group set. * A read belongs to one read group. For more genomics resource definitions, see Fundamentals of Google Genomics

ReadgroupsetsCoveragebucketsResourceApi

ReadgroupsetsResourceApi

ReadsResourceApi

Reference

A reference is a canonical assembled DNA sequence, intended to act as a reference coordinate space for other genomic annotations. A single reference might represent the human chromosome 1 or mitochandrial DNA, for instance. A reference belongs to one or more reference sets. For more genomics resource definitions, see Fundamentals of Google Genomics

ReferenceBound

ReferenceBound records an upper bound for the starting coordinate of variants in a particular reference.

ReferencesBasesResourceApi

ReferenceSet

A reference set is a set of references which typically comprise a reference assembly for a species, such as GRCh38 which is representative of the human genome. A reference set defines a common coordinate space for comparing reference-aligned experimental data. A reference set contains 1 or more references. For more genomics resource definitions, see Fundamentals of Google Genomics

ReferencesetsResourceApi

ReferencesResourceApi

SearchCallSetsRequest

The call set search request.

SearchCallSetsResponse

The call set search response.

SearchReadGroupSetsRequest

The read group set search request.

SearchReadGroupSetsResponse

The read group set search response.

SearchReadsRequest

The read search request.

SearchReadsResponse

The read search response.

SearchReferenceSetsRequest

SearchReferenceSetsResponse

SearchReferencesRequest

SearchReferencesResponse

SearchVariantSetsRequest

The search variant sets request.

SearchVariantSetsResponse

The search variant sets response.

SearchVariantsRequest

The variant search request.

SearchVariantsResponse

The variant search response.

SetIamPolicyRequest

Request message for SetIamPolicy method.

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 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.

StreamReadsRequest

The stream reads request.

StreamReadsResponse

StreamVariantsRequest

The stream variants request.

StreamVariantsResponse

TestIamPermissionsRequest

Request message for TestIamPermissions method.

TestIamPermissionsResponse

Response message for TestIamPermissions method.

UndeleteDatasetRequest

Variant

A variant represents a change in DNA sequence relative to a reference sequence. For example, a variant could represent a SNP or an insertion. Variants belong to a variant set. For more genomics resource definitions, see Fundamentals of Google Genomics Each of the calls on a variant represent a determination of genotype with respect to that variant. For example, a call might assign probability of 0.32 to the occurrence of a SNP named rs1234 in a sample named NA12345. A call belongs to a call set, which contains related calls typically from one sample.

VariantCall

A call represents the determination of genotype with respect to a particular variant. It may include associated information such as quality and phasing. For example, a call might assign a probability of 0.32 to the occurrence of a SNP named rs1234 in a call set with the name NA12345.

VariantSet

A variant set is a collection of call sets and variants. It contains summary statistics of those contents. A variant set belongs to a dataset. For more genomics resource definitions, see Fundamentals of Google Genomics

VariantSetMetadata

Metadata describes a single piece of variant call metadata. These data include a top level key and either a single value string (value) or a list of key-value pairs (info.) Value and info are mutually exclusive.

VariantsetsResourceApi

VariantsResourceApi

Exceptions / Errors

ApiRequestError

Represents a general error reported by the API endpoint.

DetailedApiRequestError

Represents a specific error reported by the API endpoint.