google_api_genomics v0.11.0 GoogleApi.Genomics.V1.Api.Operations View Source

API calls for all endpoints tagged Operations.

Link to this section Summary

Functions

genomics_operations_cancel(connection, name, optional_params \\ [], opts \\ [])

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation. Authorization requires the following Google IAM permission:

genomics_operations_get(connection, name, optional_params \\ [], opts \\ [])

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. Authorization requires the following Google IAM permission:

genomics_operations_list(connection, name, optional_params \\ [], opts \\ [])

Lists operations that match the specified filter in the request. Authorization requires the following Google IAM permission:

Link to this section Functions

genomics_operations_cancel(connection, name, optional_params \\ [], opts \\ [])

genomics_operations_cancel(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Genomics.V1.Model.Empty.t()} | {:error, Tesla.Env.t()}

genomics.operations.cancel

Parameters

connection (type: GoogleApi.Genomics.V1.Connection.t) - Connection to server
name (type: String.t) - The name of the operation resource to be cancelled.
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.V1.Model.CancelOperationRequest.t) -
opts (type: keyword()) - Call options

Returns

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

genomics_operations_get(connection, name, optional_params \\ [], opts \\ [])

genomics_operations_get(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Genomics.V1.Model.Operation.t()} | {:error, Tesla.Env.t()}

genomics.operations.get

Parameters

connection (type: GoogleApi.Genomics.V1.Connection.t) - Connection to server
name (type: String.t) - The name of the operation resource.
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").
opts (type: keyword()) - Call options

Returns

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

genomics_operations_list(connection, name, optional_params \\ [], opts \\ [])

genomics_operations_list(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Genomics.V1.Model.ListOperationsResponse.t()}
  | {:error, Tesla.Env.t()}

Lists operations that match the specified filter in the request. Authorization requires the following Google IAM permission:

genomics.operations.list

Parameters

connection (type: GoogleApi.Genomics.V1.Connection.t) - Connection to server
name (type: String.t) - The name of the operation's parent resource.
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").
- :filter (type: String.t) - A string for filtering Operations. In v2alpha1, the following filter fields are supported:
  - createTime: The time this job was created
  - events: The set of event (names) that have occurred while running the pipeline. The : operator can be used to determine if a particular event has occurred.
  - error: If the pipeline is running, this value is NULL. Once the pipeline finishes, the value is the standard Google error code.
  - labels.key or labels."key with space" where key is a label key.
  - done: If the pipeline is running, this value is false. Once the pipeline finishes, the value is true.
  In v1 and v1alpha2, the following filter fields are supported:
  - projectId: Required. Corresponds to OperationMetadata.projectId.
  - createTime: The time this job was created, in seconds from the epoch. Can use >= and/or <= operators.
  - status: Can be RUNNING, SUCCESS, FAILURE, or CANCELED. Only one status may be specified.
  - labels.key where key is a label key.
  Examples:
  - projectId = my-project AND createTime >= 1432140000
  - projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING
  - projectId = my-project AND labels.color = *
  - projectId = my-project AND labels.color = red
- :pageSize (type: integer()) - The maximum number of results to return. The maximum value is 256.
- :pageToken (type: String.t) - The standard list page token.
opts (type: keyword()) - Call options

Returns

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