Struct google_genomics1::ReadgroupsetCoveragebucketListCall

pub struct ReadgroupsetCoveragebucketListCall<'a, C, A> where
    C: 'a,
    A: 'a,  { /* fields omitted */ }

Lists fixed width coverage buckets for a read group set, each of which correspond to a range of a reference sequence. Each bucket summarizes coverage information across its corresponding genomic range.

For the definitions of read group sets and other genomics resources, see Fundamentals of Google Genomics

Coverage is defined as the number of reads which are aligned to a given base in the reference sequence. Coverage buckets are available at several precomputed bucket widths, enabling retrieval of various coverage 'zoom levels'. The caller must have READ permissions for the target read group set.

A builder for the coveragebuckets.list method supported by a readgroupset resource. It is not used directly, but through a ReadgroupsetMethods instance.

Example

Instantiate a resource method builder

 
// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.readgroupsets().coveragebuckets_list("readGroupSetId")
             .target_bucket_width("eos")
             .start("erat")
             .reference_name("sadipscing")
             .page_token("dolor")
             .page_size(-39)
             .end("elitr")
             .doit();

Methods

impl<'a, C, A> ReadgroupsetCoveragebucketListCall<'a, C, A> where     C: BorrowMut<Client>,     A: GetToken,

pub fn doit(self) -> Result<(Response, ListCoverageBucketsResponse)>

Perform the operation you have build so far.

pub fn read_group_set_id(     self,     new_value: &str ) -> ReadgroupsetCoveragebucketListCall<'a, C, A>

Required. The ID of the read group set over which coverage is requested.

Sets the read group set id path property to the given value.

Even though the property as already been set when instantiating this call, we provide this method for API completeness.

pub fn target_bucket_width(     self,     new_value: &str ) -> ReadgroupsetCoveragebucketListCall<'a, C, A>

The desired width of each reported coverage bucket in base pairs. This will be rounded down to the nearest precomputed bucket width; the value of which is returned as bucketWidth in the response. Defaults to infinity (each bucket spans an entire reference sequence) or the length of the target range, if specified. The smallest precomputed bucketWidth is currently 2048 base pairs; this is subject to change.

Sets the target bucket width query property to the given value.

pub fn start(     self,     new_value: &str ) -> ReadgroupsetCoveragebucketListCall<'a, C, A>

The start position of the range on the reference, 0-based inclusive. If specified, referenceName must also be specified. Defaults to 0.

Sets the start query property to the given value.

pub fn reference_name(     self,     new_value: &str ) -> ReadgroupsetCoveragebucketListCall<'a, C, A>

The name of the reference to query, within the reference set associated with this query. Optional.

Sets the reference name query property to the given value.

pub fn page_token(     self,     new_value: &str ) -> ReadgroupsetCoveragebucketListCall<'a, C, A>

The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.

Sets the page token query property to the given value.

pub fn page_size(     self,     new_value: i32 ) -> ReadgroupsetCoveragebucketListCall<'a, C, A>

The maximum number of results to return in a single page. If unspecified, defaults to 1024. The maximum value is 2048.

Sets the page size query property to the given value.

pub fn end(     self,     new_value: &str ) -> ReadgroupsetCoveragebucketListCall<'a, C, A>

The end position of the range on the reference, 0-based exclusive. If specified, referenceName must also be specified. If unset or 0, defaults to the length of the reference.

Sets the end query property to the given value.

pub fn delegate(     self,     new_value: &'a mut Delegate ) -> ReadgroupsetCoveragebucketListCall<'a, C, A>

The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong while executing the actual API request.

It should be used to handle progress information, and to implement a certain level of resilience.

Sets the delegate property to the given value.

pub fn param<T>(     self,     name: T,     value: T ) -> ReadgroupsetCoveragebucketListCall<'a, C, A> where     T: AsRef<str>,

Set any additional parameter of the query string used in the request. It should be used to set parameters which are not yet available through their own setters.

Please note that this method must not be used to set any of the known paramters which have their own setter method. If done anyway, the request will fail.

Additional Parameters

• bearer_token (query-string) - OAuth bearer token.
• pp (query-boolean) - Pretty-print response.
• prettyPrint (query-boolean) - Returns response with indentations and line breaks.
• upload_protocol (query-string) - Upload protocol for media (e.g. "raw", "multipart").
• access_token (query-string) - OAuth access token.
• uploadType (query-string) - Legacy upload protocol for media (e.g. "media", "multipart").
• quotaUser (query-string) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
• callback (query-string) - JSONP
• oauth_token (query-string) - OAuth 2.0 token for the current user.
• key (query-string) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
• fields (query-string) - Selector specifying which fields to include in a partial response.
• alt (query-string) - Data format for response.
• $.xgafv (query-string) - V1 error format.

pub fn add_scope<T, S>(     self,     scope: T ) -> ReadgroupsetCoveragebucketListCall<'a, C, A> where     T: Into<Option<S>>,     S: AsRef<str>,

Identifies the authorization scope for the method you are building.

Use this method to actively specify which scope should be used, instead the default Scope variant Scope::Readonly.

The scope will be added to a set of scopes. This is important as one can maintain access tokens for more than one scope. If None is specified, then all scopes will be removed and no default scope will be used either. In that case, you have to specify your API-key using the key parameter (see the param() function for details).

Usually there is more than one suitable scope to authorize an operation, some of which may encompass more rights than others. For example, for listing resources, a read-only scope will be sufficient, a read-write scope will do as well.

Trait Implementations

impl<'a, C, A> CallBuilder for ReadgroupsetCoveragebucketListCall<'a, C, A>