GoogleApi.LifeSciences.V2beta.Api.Projects.lifesciences_projects_locations_operations_cancel

You're seeing just the function lifesciences_projects_locations_operations_cancel, go back to GoogleApi.LifeSciences.V2beta.Api.Projects module for more information.
Link to this function

lifesciences_projects_locations_operations_cancel(connection, projects_id, locations_id, operations_id, optional_params \\ [], opts \\ [])

View Source

Specs

lifesciences_projects_locations_operations_cancel(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.LifeSciences.V2beta.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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: * lifesciences.operations.cancel

Parameters

  • connection (type: GoogleApi.LifeSciences.V2beta.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of name. The name of the operation resource to be cancelled.
  • locations_id (type: String.t) - Part of name. See documentation of projectsId.
  • operations_id (type: String.t) - Part of name. See documentation of projectsId.
  • 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.LifeSciences.V2beta.Model.CancelOperationRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.LifeSciences.V2beta.Model.Empty{}} on success
  • {:error, info} on failure