GoogleApi.Jobs.V2.Api.Jobs.jobs_jobs_delete

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

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

View Source

Specs

jobs_jobs_delete(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Jobs.V2.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Deletes the specified job.

Typically, the job becomes unsearchable within 10 seconds, but it may take up to 5 minutes.

Parameters

  • connection (type: GoogleApi.Jobs.V2.Connection.t) - Connection to server

  • name (type: String.t) - Required. The resource name of the job to be deleted, such as "jobs/11111111".

  • 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").

    • :disableFastProcess (type: boolean()) - Deprecated. This field is not working anymore.

      Optional. If set to true, this call waits for all processing steps to complete before the job is cleaned up. Otherwise, the call returns while some steps are still taking place asynchronously, hence faster.

  • opts (type: keyword()) - Call options

Returns

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