Class CloudSchedulerGrpc.CloudSchedulerBlockingStub (2.48.0) 

public static final class CloudSchedulerGrpc.CloudSchedulerBlockingStub extends AbstractBlockingStub<CloudSchedulerGrpc.CloudSchedulerBlockingStub>

A stub to allow clients to do synchronous rpc calls to service CloudScheduler.

The Cloud Scheduler API allows external entities to reliably schedule asynchronous jobs.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > CloudSchedulerGrpc.CloudSchedulerBlockingStub

Methods

build(Channel channel, CallOptions callOptions)

protected CloudSchedulerGrpc.CloudSchedulerBlockingStub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
CloudSchedulerGrpc.CloudSchedulerBlockingStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createJob(CreateJobRequest request)

public Job createJob(CreateJobRequest request)

Creates a job.

Parameter
Name Description
request CreateJobRequest
Returns
Type Description
Job

deleteJob(DeleteJobRequest request)

public Empty deleteJob(DeleteJobRequest request)

Deletes a job.

Parameter
Name Description
request DeleteJobRequest
Returns
Type Description
Empty

getJob(GetJobRequest request)

public Job getJob(GetJobRequest request)

Gets a job.

Parameter
Name Description
request GetJobRequest
Returns
Type Description
Job

listJobs(ListJobsRequest request)

public ListJobsResponse listJobs(ListJobsRequest request)

Lists jobs.

Parameter
Name Description
request ListJobsRequest
Returns
Type Description
ListJobsResponse

pauseJob(PauseJobRequest request)

public Job pauseJob(PauseJobRequest request)

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.

Parameter
Name Description
request PauseJobRequest
Returns
Type Description
Job

resumeJob(ResumeJobRequest request)

public Job resumeJob(ResumeJobRequest request)

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.

Parameter
Name Description
request ResumeJobRequest
Returns
Type Description
Job

runJob(RunJobRequest request)

public Job runJob(RunJobRequest request)

Forces a job to run now. When this method is called, Cloud Scheduler will dispatch the job, even if the job is already running.

Parameter
Name Description
request RunJobRequest
Returns
Type Description
Job

updateJob(UpdateJobRequest request)

public Job updateJob(UpdateJobRequest request)

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.

Parameter
Name Description
request UpdateJobRequest
Returns
Type Description
Job