Method: googleapis.cloudscheduler.v1.projects.locations.jobs.pause

Pauses a job. If a job is paused then the system will stop executing the job until it is re-enabled via ResumeJob. The state of the job is stored in state; if paused it will be set to Job.State.PAUSED. A job must be in Job.State.ENABLED to be paused.

Arguments

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

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 contains an instance of Job.

Subworkflow snippet

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

YAML

- pause:
    call: googleapis.cloudscheduler.v1.projects.locations.jobs.pause
    args:
        name: ...
    result: pauseResult

JSON

[
  {
    "pause": {
      "call": "googleapis.cloudscheduler.v1.projects.locations.jobs.pause",
      "args": {
        "name": "..."
      },
      "result": "pauseResult"
    }
  }
]