google_api_genomics v0.0.1 GoogleApi.Genomics.V1.Api.References View Source

API calls for all endpoints tagged References.

Link to this section Summary

Functions

Lists the bases in a reference, optionally restricted to a range. For the definitions of references and other genomics resources, see Fundamentals of Google Genomics Implements GlobalAllianceApi.getReferenceBases

Gets a reference. For the definitions of references and other genomics resources, see Fundamentals of Google Genomics Implements GlobalAllianceApi.getReference

Searches for references which match the given criteria. For the definitions of references and other genomics resources, see Fundamentals of Google Genomics Implements GlobalAllianceApi.searchReferences

Link to this section Functions

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

Lists the bases in a reference, optionally restricted to a range. For the definitions of references and other genomics resources, see Fundamentals of Google Genomics Implements GlobalAllianceApi.getReferenceBases.

Parameters

  • connection (GoogleApi.Genomics.V1.Connection): Connection to server
  • reference_id (String): The ID of the reference.
  • 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.
    • :page_token (String): 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.
    • :page_size (Integer): The maximum number of bases to return in a single page. If unspecified, defaults to 200Kbp (kilo base pairs). The maximum value is 10Mbp (mega base pairs).
    • :start (String): The start position (0-based) of this query. Defaults to 0.
    • :end (String): The end position (0-based, exclusive) of this query. Defaults to the length of this reference.

Returns

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

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

Gets a reference. For the definitions of references and other genomics resources, see Fundamentals of Google Genomics Implements GlobalAllianceApi.getReference.

Parameters

  • connection (GoogleApi.Genomics.V1.Connection): Connection to server
  • reference_id (String): The ID of the reference.
  • 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.Reference{}} on success {:error, info} on failure

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

Searches for references which match the given criteria. For the definitions of references and other genomics resources, see Fundamentals of Google Genomics Implements GlobalAllianceApi.searchReferences.

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 (SearchReferencesRequest):

Returns

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