GoogleApi.Genomics.V2alpha1.Api.Workers (google_api_genomics v0.18.0) View Source

API calls for all endpoints tagged Workers.

Link to this section Summary

Functions

The worker uses this method to retrieve the assigned operation and provide periodic status updates.

Link to this section Functions

Link to this function

genomics_workers_check_in(connection, id, optional_params \\ [], opts \\ [])

View Source

Specs

genomics_workers_check_in(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Genomics.V2alpha1.Model.CheckInResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

The worker uses this method to retrieve the assigned operation and provide periodic status updates.

Parameters

  • connection (type: GoogleApi.Genomics.V2alpha1.Connection.t) - Connection to server
  • id (type: String.t) - The VM identity token for authenticating the VM instance. https://cloud.google.com/compute/docs/instances/verifying-instance-identity
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Genomics.V2alpha1.Model.CheckInRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Genomics.V2alpha1.Model.CheckInResponse{}} on success
  • {:error, info} on failure