Struct google_genomics1::VariantMergeCall

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

Merges the given variants with existing variants.

Each variant will be merged with an existing variant that matches its reference sequence, start, end, reference bases, and alternative bases. If no such variant exists, a new one will be created.

When variants are merged, the call information from the new variant is added to the existing variant. Variant info fields are merged as specified in the infoMergeConfig field of the MergeVariantsRequest.

Please exercise caution when using this method! It is easy to introduce mistakes in existing variants and difficult to back out of them. For example, suppose you were trying to merge a new variant with an existing one and both variants contain calls that belong to callsets with the same callset ID.

// Existing variant - irrelevant fields trimmed for clarity
{
    "variantSetId": "10473108253681171589",
    "referenceName": "1",
    "start": "10582",
    "referenceBases": "G",
    "alternateBases": [
        "A"
    ],
    "calls": [
        {
            "callSetId": "10473108253681171589-0",
            "callSetName": "CALLSET0",
            "genotype": [
                0,
                1
            ],
        }
    ]
}

// New variant with conflicting call information
{
    "variantSetId": "10473108253681171589",
    "referenceName": "1",
    "start": "10582",
    "referenceBases": "G",
    "alternateBases": [
        "A"
    ],
    "calls": [
        {
            "callSetId": "10473108253681171589-0",
            "callSetName": "CALLSET0",
            "genotype": [
                1,
                1
            ],
        }
    ]
}

The resulting merged variant would overwrite the existing calls with those from the new variant:

{
    "variantSetId": "10473108253681171589",
    "referenceName": "1",
    "start": "10582",
    "referenceBases": "G",
    "alternateBases": [
        "A"
    ],
    "calls": [
        {
            "callSetId": "10473108253681171589-0",
            "callSetName": "CALLSET0",
            "genotype": [
                1,
                1
            ],
        }
    ]
}

This may be the desired outcome, but it is up to the user to determine if if that is indeed the case.

A builder for the merge method supported by a variant resource. It is not used directly, but through a VariantMethods instance.

Example

Instantiate a resource method builder

use genomics1::MergeVariantsRequest;
 
// As the method needs a request, you would usually fill it with the desired information
// into the respective structure. Some of the parts shown here might not be applicable !
// Values shown here are possibly random and not representative !
let mut req = MergeVariantsRequest::default();
 
// 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.variants().merge(req)
             .doit();

Methods

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

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

Perform the operation you have build so far.

pub fn request(     self,     new_value: MergeVariantsRequest ) -> VariantMergeCall<'a, C, A>

Sets the request 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 delegate(self, new_value: &'a mut Delegate) -> VariantMergeCall<'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) -> VariantMergeCall<'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

• upload_protocol (query-string) - Upload protocol for media (e.g. "raw", "multipart").
• prettyPrint (query-boolean) - Returns response with indentations and line breaks.
• 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) -> VariantMergeCall<'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::CloudPlatform.

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 VariantMergeCall<'a, C, A>