Method: googleapis.cloudscheduler.v1beta1.projects.locations.jobs.delete

Deletes a job.

Arguments

Parameters
name

string

Required. The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.

legacyAppEngineCron

boolean

This field is used to manage the legacy App Engine Cron jobs using the Cloud Scheduler API. If the field is set to true, the job in the __cron queue with the corresponding name will be deleted instead.

Raised exceptions

Exceptions
ConnectionError In case of a network problem (such as DNS failure or refused connection).
HttpError If the response status is >= 400 (excluding 429 and 503).
TimeoutError If a long-running operation takes longer to finish than the specified timeout limit.
TypeError If an operation or function receives an argument of the wrong type.
ValueError If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

If successful, the response will be empty.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- delete:
    call: googleapis.cloudscheduler.v1beta1.projects.locations.jobs.delete
    args:
        name: ...
        legacyAppEngineCron: ...
    result: deleteResult

JSON

[
  {
    "delete": {
      "call": "googleapis.cloudscheduler.v1beta1.projects.locations.jobs.delete",
      "args": {
        "name": "...",
        "legacyAppEngineCron": "..."
      },
      "result": "deleteResult"
    }
  }
]