google_api_genomics v0.0.1 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. For the definitions of variant sets and other genomics resources, see Fundamentals of Google Genomics 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. For the definitions of variant sets and other genomics resources, see Fundamentals of Google Genomics

Exports variant set data to an external destination. For the definitions of variant sets and other genomics resources, see Fundamentals of Google Genomics

Gets a variant set by ID. For the definitions of variant sets and other genomics resources, see Fundamentals of Google Genomics

Updates a variant set using patch semantics. For the definitions of variant sets and other genomics resources, see Fundamentals of Google Genomics

Returns a list of all variant sets matching search criteria. For the definitions of variant sets and other genomics resources, see Fundamentals of Google Genomics Implements GlobalAllianceApi.searchVariantSets

Link to this section Functions

Link to this function genomics_variantsets_create(connection, opts \\ []) View Source
genomics_variantsets_create(Tesla.Env.client, keyword) ::
  {:ok, GoogleApi.Genomics.V1.Model.VariantSet.t} |
  {:error, Tesla.Env.t}

Creates a new variant set. For the definitions of variant sets and other genomics resources, see Fundamentals of Google Genomics 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
  • opts (KeywordList): [optional] Optional parameters

    • :fields (String): Selector specifying which fields to include in a partial response.
    • :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
    • :__/xgafv (String): V1 error format.
    • :callback (String): JSONP
    • :alt (String): Data format for response.
    • :access_token (String): OAuth access token.
    • :key (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.
    • :quota_user (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.
    • :pp (Boolean): Pretty-print response.
    • :bearer_token (String): OAuth bearer token.
    • :oauth_token (String): OAuth 2.0 token for the current user.
    • :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :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, opts \\ []) View Source
genomics_variantsets_delete(Tesla.Env.client, String.t, keyword) ::
  {:ok, GoogleApi.Genomics.V1.Model.Empty.t} |
  {:error, Tesla.Env.t}

Deletes a variant set including all variants, call sets, and calls within. This is not reversible. For the definitions of variant sets and other genomics resources, see Fundamentals of Google Genomics

Parameters

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

    • :fields (String): Selector specifying which fields to include in a partial response.
    • :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
    • :__/xgafv (String): V1 error format.
    • :callback (String): JSONP
    • :alt (String): Data format for response.
    • :access_token (String): OAuth access token.
    • :key (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.
    • :quota_user (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.
    • :pp (Boolean): Pretty-print response.
    • :bearer_token (String): OAuth bearer token.
    • :oauth_token (String): OAuth 2.0 token for the current user.
    • :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
    • :pretty_print (Boolean): Returns response with indentations and line breaks.

Returns

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

Link to this function genomics_variantsets_export(connection, variant_set_id, opts \\ []) View Source
genomics_variantsets_export(Tesla.Env.client, String.t, keyword) ::
  {:ok, GoogleApi.Genomics.V1.Model.Operation.t} |
  {:error, Tesla.Env.t}

Exports variant set data to an external destination. For the definitions of variant sets and other genomics resources, see Fundamentals of Google Genomics

Parameters

  • connection (GoogleApi.Genomics.V1.Connection): Connection to server
  • variant_set_id (String): 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.
  • opts (KeywordList): [optional] Optional parameters

    • :fields (String): Selector specifying which fields to include in a partial response.
    • :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
    • :__/xgafv (String): V1 error format.
    • :callback (String): JSONP
    • :alt (String): Data format for response.
    • :access_token (String): OAuth access token.
    • :key (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.
    • :quota_user (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.
    • :pp (Boolean): Pretty-print response.
    • :bearer_token (String): OAuth bearer token.
    • :oauth_token (String): OAuth 2.0 token for the current user.
    • :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :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, opts \\ []) View Source
genomics_variantsets_get(Tesla.Env.client, String.t, keyword) ::
  {:ok, GoogleApi.Genomics.V1.Model.VariantSet.t} |
  {:error, Tesla.Env.t}

Gets a variant set by ID. For the definitions of variant sets and other genomics resources, see Fundamentals of Google Genomics

Parameters

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

    • :fields (String): Selector specifying which fields to include in a partial response.
    • :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
    • :__/xgafv (String): V1 error format.
    • :callback (String): JSONP
    • :alt (String): Data format for response.
    • :access_token (String): OAuth access token.
    • :key (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.
    • :quota_user (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.
    • :pp (Boolean): Pretty-print response.
    • :bearer_token (String): OAuth bearer token.
    • :oauth_token (String): OAuth 2.0 token for the current user.
    • :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
    • :pretty_print (Boolean): Returns response with indentations and line breaks.

Returns

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

Link to this function genomics_variantsets_patch(connection, variant_set_id, opts \\ []) View Source
genomics_variantsets_patch(Tesla.Env.client, String.t, keyword) ::
  {:ok, GoogleApi.Genomics.V1.Model.VariantSet.t} |
  {:error, Tesla.Env.t}

Updates a variant set using patch semantics. For the definitions of variant sets and other genomics resources, see Fundamentals of Google Genomics

Parameters

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

    • :fields (String): Selector specifying which fields to include in a partial response.
    • :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
    • :__/xgafv (String): V1 error format.
    • :callback (String): JSONP
    • :alt (String): Data format for response.
    • :access_token (String): OAuth access token.
    • :key (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.
    • :quota_user (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.
    • :pp (Boolean): Pretty-print response.
    • :bearer_token (String): OAuth bearer token.
    • :oauth_token (String): OAuth 2.0 token for the current user.
    • :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :update_mask (String): 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, opts \\ []) View Source
genomics_variantsets_search(Tesla.Env.client, keyword) ::
  {:ok, GoogleApi.Genomics.V1.Model.SearchVariantSetsResponse.t} |
  {:error, Tesla.Env.t}

Returns a list of all variant sets matching search criteria. For the definitions of variant sets and other genomics resources, see Fundamentals of Google Genomics Implements GlobalAllianceApi.searchVariantSets.

Parameters

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

    • :fields (String): Selector specifying which fields to include in a partial response.
    • :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
    • :__/xgafv (String): V1 error format.
    • :callback (String): JSONP
    • :alt (String): Data format for response.
    • :access_token (String): OAuth access token.
    • :key (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.
    • :quota_user (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.
    • :pp (Boolean): Pretty-print response.
    • :bearer_token (String): OAuth bearer token.
    • :oauth_token (String): OAuth 2.0 token for the current user.
    • :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :body (SearchVariantSetsRequest):

Returns

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