GoogleApi.BigQuery.V2.Api.Jobs.bigquery_jobs_cancel

You're seeing just the function bigquery_jobs_cancel, go back to GoogleApi.BigQuery.V2.Api.Jobs module for more information.
Link to this function

bigquery_jobs_cancel(connection, project_id, job_id, optional_params \\ [], opts \\ [])

View Source

Specs

bigquery_jobs_cancel(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQuery.V2.Model.JobCancelResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Requests that a job be cancelled. This call will return immediately, and the client will need to poll for the job status to see if the cancel completed successfully. Cancelled jobs may still incur costs.

Parameters

  • connection (type: GoogleApi.BigQuery.V2.Connection.t) - Connection to server
  • project_id (type: String.t) - [Required] Project ID of the job to cancel
  • job_id (type: String.t) - [Required] Job ID of the job to cancel
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :location (type: String.t) - The geographic location of the job. Required except for US and EU. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.BigQuery.V2.Model.JobCancelResponse{}} on success
  • {:error, info} on failure