google_api_genomics v0.5.0 GoogleApi.Genomics.V1.Api.Variantsets View Source

API calls for all endpoints tagged Variantsets.

Link to this section Summary

Functions

Creates a new variant set. The provided variant set must have a valid `datasetId` set - all other fields are optional. Note that the `id` field will be ignored, as this is assigned by the server.

Deletes a variant set including all variants, call sets, and calls within. This is not reversible.

Returns a list of all variant sets matching search criteria. Implements GlobalAllianceApi.searchVariantSets.

Link to this section Functions

Link to this function

genomics_variantsets_create(connection, optional_params \\ [], opts \\ []) View Source

Creates a new variant set. The provided variant set must have a valid `datasetId` set - all other fields are optional. Note that the `id` field will be ignored, as this is assigned by the server.

Parameters

  • connection (GoogleApi.Genomics.V1.Connection): Connection to server
  • optional_params (KeywordList): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): 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.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): 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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :body (VariantSet):

Returns

{:ok, %GoogleApi.Genomics.V1.Model.VariantSet{}} on success {:error, info} on failure

Link to this function

genomics_variantsets_delete(connection, variant_set_id, optional_params \\ [], opts \\ []) View Source

Deletes a variant set including all variants, call sets, and calls within. This is not reversible.

Parameters

  • connection (GoogleApi.Genomics.V1.Connection): Connection to server
  • variant_set_id (String.t): The ID of the variant set to be deleted.
  • optional_params (KeywordList): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): 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.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): 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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").

Returns

{:ok, %GoogleApi.Genomics.V1.Model.Empty{}} on success {:error, info} on failure

Link to this function

genomics_variantsets_export(connection, variant_set_id, optional_params \\ [], opts \\ []) View Source

Exports variant set data to an external destination.

Parameters

  • connection (GoogleApi.Genomics.V1.Connection): Connection to server
  • variant_set_id (String.t): Required. The ID of the variant set that contains variant data which should be exported. The caller must have READ access to this variant set.
  • optional_params (KeywordList): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): 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.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): 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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :body (ExportVariantSetRequest):

Returns

{:ok, %GoogleApi.Genomics.V1.Model.Operation{}} on success {:error, info} on failure

Link to this function

genomics_variantsets_get(connection, variant_set_id, optional_params \\ [], opts \\ []) View Source

Gets a variant set by ID.

Parameters

  • connection (GoogleApi.Genomics.V1.Connection): Connection to server
  • variant_set_id (String.t): Required. The ID of the variant set.
  • optional_params (KeywordList): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): 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.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): 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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").

Returns

{:ok, %GoogleApi.Genomics.V1.Model.VariantSet{}} on success {:error, info} on failure

Link to this function

genomics_variantsets_patch(connection, variant_set_id, optional_params \\ [], opts \\ []) View Source

Updates a variant set using patch semantics.

Parameters

  • connection (GoogleApi.Genomics.V1.Connection): Connection to server
  • variant_set_id (String.t): The ID of the variant to be updated (must already exist).
  • optional_params (KeywordList): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): 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.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): 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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :updateMask (String.t): An optional mask specifying which fields to update. Supported fields: metadata. name. * description. Leaving `updateMask` unset is equivalent to specifying all mutable fields.
    • :body (VariantSet):

Returns

{:ok, %GoogleApi.Genomics.V1.Model.VariantSet{}} on success {:error, info} on failure

Link to this function

genomics_variantsets_search(connection, optional_params \\ [], opts \\ []) View Source

Returns a list of all variant sets matching search criteria. Implements GlobalAllianceApi.searchVariantSets.

Parameters

  • connection (GoogleApi.Genomics.V1.Connection): Connection to server
  • optional_params (KeywordList): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): 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.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): 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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :body (SearchVariantSetsRequest):

Returns

{:ok, %GoogleApi.Genomics.V1.Model.SearchVariantSetsResponse{}} on success {:error, info} on failure