Struct gapi_grpc::google::genomics::v1::annotation_service_v1_client::AnnotationServiceV1Client

pub struct AnnotationServiceV1Client<T> { /* fields omitted */ }

This service provides storage and positional retrieval of genomic reference annotations, including variant annotations.

Implementations

impl AnnotationServiceV1Client<Channel>

pub async fn connect<D>(dst: D) -> Result<Self, Error> where
    D: TryInto<Endpoint>,
    D::Error: Into<StdError>, 

Attempt to create a new client by connecting to a given endpoint.

impl<T> AnnotationServiceV1Client<T> where
    T: GrpcService<BoxBody>,
    T::ResponseBody: Body + HttpBody + Send + 'static,
    T::Error: Into<StdError>,
    <T::ResponseBody as HttpBody>::Error: Into<StdError> + Send, 

pub fn new(inner: T) -> Self

pub fn with_interceptor(inner: T, interceptor: impl Into<Interceptor>) -> Self

pub async fn create_annotation_set(
    &mut self,
    request: impl IntoRequest<CreateAnnotationSetRequest>
) -> Result<Response<AnnotationSet>, Status>

Creates a new annotation set. Caller must have WRITE permission for the associated dataset.

The following fields are required:

• [datasetId][google.genomics.v1.AnnotationSet.dataset_id]
• [referenceSetId][google.genomics.v1.AnnotationSet.reference_set_id]

All other fields may be optionally specified, unless documented as being server-generated (for example, the id field).

pub async fn get_annotation_set(
    &mut self,
    request: impl IntoRequest<GetAnnotationSetRequest>
) -> Result<Response<AnnotationSet>, Status>

Gets an annotation set. Caller must have READ permission for the associated dataset.

pub async fn update_annotation_set(
    &mut self,
    request: impl IntoRequest<UpdateAnnotationSetRequest>
) -> Result<Response<AnnotationSet>, Status>

Updates an annotation set. The update must respect all mutability restrictions and other invariants described on the annotation set resource. Caller must have WRITE permission for the associated dataset.

pub async fn delete_annotation_set(
    &mut self,
    request: impl IntoRequest<DeleteAnnotationSetRequest>
) -> Result<Response<()>, Status>

Deletes an annotation set. Caller must have WRITE permission for the associated annotation set.

pub async fn search_annotation_sets(
    &mut self,
    request: impl IntoRequest<SearchAnnotationSetsRequest>
) -> Result<Response<SearchAnnotationSetsResponse>, Status>

Searches for annotation sets that match the given criteria. Annotation sets are returned in an unspecified order. This order is consistent, such that two queries for the same content (regardless of page size) yield annotation sets in the same order across their respective streams of paginated responses. Caller must have READ permission for the queried datasets.

pub async fn create_annotation(
    &mut self,
    request: impl IntoRequest<CreateAnnotationRequest>
) -> Result<Response<Annotation>, Status>

Creates a new annotation. Caller must have WRITE permission for the associated annotation set.

The following fields are required:

• [annotationSetId][google.genomics.v1.Annotation.annotation_set_id]
• [referenceName][google.genomics.v1.Annotation.reference_name] or [referenceId][google.genomics.v1.Annotation.reference_id]

Transcripts

For annotations of type TRANSCRIPT, the following fields of [transcript][google.genomics.v1.Annotation.transcript] must be provided:

• [exons.start][google.genomics.v1.Transcript.Exon.start]
• [exons.end][google.genomics.v1.Transcript.Exon.end]

All other fields may be optionally specified, unless documented as being server-generated (for example, the id field). The annotated range must be no longer than 100Mbp (mega base pairs). See the [Annotation resource][google.genomics.v1.Annotation] for additional restrictions on each field.

pub async fn batch_create_annotations(
    &mut self,
    request: impl IntoRequest<BatchCreateAnnotationsRequest>
) -> Result<Response<BatchCreateAnnotationsResponse>, Status>

Creates one or more new annotations atomically. All annotations must belong to the same annotation set. Caller must have WRITE permission for this annotation set. For optimal performance, batch positionally adjacent annotations together.

If the request has a systemic issue, such as an attempt to write to an inaccessible annotation set, the entire RPC will fail accordingly. For lesser data issues, when possible an error will be isolated to the corresponding batch entry in the response; the remaining well formed annotations will be created normally.

For details on the requirements for each individual annotation resource, see [CreateAnnotation][google.genomics.v1.AnnotationServiceV1.CreateAnnotation].

pub async fn get_annotation(
    &mut self,
    request: impl IntoRequest<GetAnnotationRequest>
) -> Result<Response<Annotation>, Status>

Gets an annotation. Caller must have READ permission for the associated annotation set.

pub async fn update_annotation(
    &mut self,
    request: impl IntoRequest<UpdateAnnotationRequest>
) -> Result<Response<Annotation>, Status>

Updates an annotation. Caller must have WRITE permission for the associated dataset.

pub async fn delete_annotation(
    &mut self,
    request: impl IntoRequest<DeleteAnnotationRequest>
) -> Result<Response<()>, Status>

Deletes an annotation. Caller must have WRITE permission for the associated annotation set.

pub async fn search_annotations(
    &mut self,
    request: impl IntoRequest<SearchAnnotationsRequest>
) -> Result<Response<SearchAnnotationsResponse>, Status>

Searches for annotations that match the given criteria. Results are ordered by genomic coordinate (by reference sequence, then position). Annotations with equivalent genomic coordinates are returned in an unspecified order. This order is consistent, such that two queries for the same content (regardless of page size) yield annotations in the same order across their respective streams of paginated responses. Caller must have READ permission for the queried annotation sets.

Trait Implementations

impl<T: Clone> Clone for AnnotationServiceV1Client<T>

fn clone(&self) -> Self

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Debug for AnnotationServiceV1Client<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.