Class CloudSchedulerGrpc.CloudSchedulerImplBase (2.2.0)

public abstract static class CloudSchedulerGrpc.CloudSchedulerImplBase implements BindableService

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

Inheritance

java.lang.Object > CloudSchedulerGrpc.CloudSchedulerImplBase

Implements

io.grpc.BindableService

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Constructors

CloudSchedulerImplBase()

public CloudSchedulerImplBase()

Methods

bindService()

public final ServerServiceDefinition bindService()

Returns

Type	Description
io.grpc.ServerServiceDefinition

createJob(CreateJobRequest request, StreamObserver<Job> responseObserver)

public void createJob(CreateJobRequest request, StreamObserver<Job> responseObserver)

Creates a job.

Parameters

Name	Description
request	`CreateJobRequest`
responseObserver	`io.grpc.stub.StreamObserver<Job>`

deleteJob(DeleteJobRequest request, StreamObserver<Empty> responseObserver)

public void deleteJob(DeleteJobRequest request, StreamObserver<Empty> responseObserver)

Deletes a job.

Parameters

Name	Description
request	`DeleteJobRequest`
responseObserver	`io.grpc.stub.StreamObserver<Empty>`

getJob(GetJobRequest request, StreamObserver<Job> responseObserver)

public void getJob(GetJobRequest request, StreamObserver<Job> responseObserver)

Gets a job.

Parameters

Name	Description
request	`GetJobRequest`
responseObserver	`io.grpc.stub.StreamObserver<Job>`

listJobs(ListJobsRequest request, StreamObserver<ListJobsResponse> responseObserver)

public void listJobs(ListJobsRequest request, StreamObserver<ListJobsResponse> responseObserver)

Lists jobs.

Parameters

Name	Description
request	`ListJobsRequest`
responseObserver	`io.grpc.stub.StreamObserver<ListJobsResponse>`

pauseJob(PauseJobRequest request, StreamObserver<Job> responseObserver)

public void pauseJob(PauseJobRequest request, StreamObserver<Job> responseObserver)

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.

Parameters

Name	Description
request	`PauseJobRequest`
responseObserver	`io.grpc.stub.StreamObserver<Job>`

resumeJob(ResumeJobRequest request, StreamObserver<Job> responseObserver)

public void resumeJob(ResumeJobRequest request, StreamObserver<Job> responseObserver)

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.

Parameters

Name	Description
request	`ResumeJobRequest`
responseObserver	`io.grpc.stub.StreamObserver<Job>`

runJob(RunJobRequest request, StreamObserver<Job> responseObserver)

public void runJob(RunJobRequest request, StreamObserver<Job> responseObserver)

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

Parameters

Name	Description
request	`RunJobRequest`
responseObserver	`io.grpc.stub.StreamObserver<Job>`

updateJob(UpdateJobRequest request, StreamObserver<Job> responseObserver)

public void updateJob(UpdateJobRequest request, StreamObserver<Job> responseObserver)

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.

Parameters

Name	Description
request	`UpdateJobRequest`
responseObserver	`io.grpc.stub.StreamObserver<Job>`