ProjectsLocationsJobs
class ProjectsLocationsJobs extends Resource (View source)
The "jobs" collection of methods.
Typical usage is:
$cloudschedulerService = new Google\Service\CloudScheduler(...);
$jobs = $cloudschedulerService->projects_locations_jobs;Methods
Deletes a job. (jobs.delete)
Lists jobs. (jobs.listProjectsLocationsJobs)
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. (jobs.pause)
Resume a job. This method reenables a job after it has been Job.State.PAUSED.
Forces a job to run now. When this method is called, Cloud Scheduler will dispatch the job, even if the job is already running. (jobs.run)
Details
CloudschedulerEmpty
delete(string $name, array $optParams = [])
Deletes a job. (jobs.delete)
Job
get(string $name, array $optParams = [])
Gets a job. (jobs.get)
ListJobsResponse
listProjectsLocationsJobs(string $parent, array $optParams = [])
Lists jobs. (jobs.listProjectsLocationsJobs)
Job
patch(string $name, Job $postBody, array $optParams = [])
Updates a job. If successful, the updated Job is returned. If the job does
not exist, NOT_FOUND is returned. If UpdateJob does not successfully
return, it is possible for the job to be in an Job.State.UPDATE_FAILED state.
A job in this state may not be executed. If this happens, retry the UpdateJob request until a successful response is received. (jobs.patch)
Job
pause(string $name, PauseJobRequest $postBody, array $optParams = [])
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. (jobs.pause)
Job
resume(string $name, ResumeJobRequest $postBody, array $optParams = [])
Resume a job. This method reenables a job after it has been Job.State.PAUSED.
The state of a job is stored in Job.state; after calling this method it will be set to Job.State.ENABLED. A job must be in Job.State.PAUSED to be resumed. (jobs.resume)
Job
run(string $name, RunJobRequest $postBody, array $optParams = [])
Forces a job to run now. When this method is called, Cloud Scheduler will dispatch the job, even if the job is already running. (jobs.run)