Pauses a job.
If a job is paused then the system will stop executing the job until it is re-enabled via jobs.resume
. 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.
HTTP request
POST https://cloudscheduler.googleapis.com/v1beta1/{name=projects/*/locations/*/jobs/*}:pause
The URL uses gRPC Transcoding syntax.
Path parameters
name
string
Required. The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID
.
Authorization requires the following IAM
permission on the specified resource name
:
-
cloudscheduler.jobs.pause
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of Job
.
Authorization scopes
Requires one of the following OAuth scopes:
-
https://www.googleapis.com/auth/cloud-platform -
https://www.googleapis.com/auth/cloud-scheduler
For more information, see the Authentication Overview .
