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

API calls for all endpoints tagged References.

Link to this section Summary

Link to this section Functions

Link to this function

genomics_references_bases_list(connection, reference_id, optional_params \\ [], opts \\ []) View Source

Lists the bases in a reference, optionally restricted to a range. Implements GlobalAllianceApi.getReferenceBases.

Parameters

  • connection (GoogleApi.Genomics.V1.Connection): Connection to server
  • reference_id (String.t): The ID of the reference.
  • 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").
    • :end (String.t): The end position (0-based, exclusive) of this query. Defaults to the length of this reference.
    • :pageSize (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).
    • :pageToken (String.t): 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.
    • :start (String.t): The start position (0-based) of this query. Defaults to 0.

Returns

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

Link to this function

genomics_references_get(connection, reference_id, optional_params \\ [], opts \\ []) View Source

Gets a reference. Implements GlobalAllianceApi.getReference.

Parameters

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

Link to this function

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

Searches for references which match the given criteria. Implements GlobalAllianceApi.searchReferences.

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

Returns

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