google_api_genomics v0.0.1 GoogleApi.Genomics.V1.Api.Operations View Source
API calls for all endpoints tagged Operations
.
Link to this section Summary
Functions
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
Lists operations that match the specified filter in the request
Link to this section Functions
genomics_operations_cancel(Tesla.Env.client, String.t, keyword) :: {:ok, GoogleApi.Genomics.V1.Model.Empty.t} | {:error, Tesla.Env.t}
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.
Parameters
- connection (GoogleApi.Genomics.V1.Connection): Connection to server
- name (String): The name of the operation resource to be cancelled.
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 (CancelOperationRequest):
Returns
{:ok, %GoogleApi.Genomics.V1.Model.Empty{}} on success {:error, info} on failure
genomics_operations_list(Tesla.Env.client, String.t, keyword) :: {:ok, GoogleApi.Genomics.V1.Model.ListOperationsResponse.t} | {:error, Tesla.Env.t}
Lists operations that match the specified filter in the request.
Parameters
- connection (GoogleApi.Genomics.V1.Connection): Connection to server
- name (String): The name of the operation's parent resource.
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.
- :filter (String): A string for filtering Operations. 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`
- :page_token (String): The standard list page token.
- :page_size (Integer): The maximum number of results to return. If unspecified, defaults to 256. The maximum value is 2048.
Returns
{:ok, %GoogleApi.Genomics.V1.Model.ListOperationsResponse{}} on success {:error, info} on failure