com.google.cloud.scheduler.v1

Class CloudSchedulerGrpc.CloudSchedulerStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractAsyncStub<CloudSchedulerGrpc.CloudSchedulerStub>

com.google.cloud.scheduler.v1.CloudSchedulerGrpc.CloudSchedulerStub

Enclosing class:

CloudSchedulerGrpc

public static final class CloudSchedulerGrpc.CloudSchedulerStub
extends AbstractAsyncStub<CloudSchedulerGrpc.CloudSchedulerStub>

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

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

AbstractStub.StubFactory<T extends AbstractStub<T>>

Method Summary

Modifier and Type	Method and Description
protected CloudSchedulerGrpc.CloudSchedulerStub	build(Channel channel, CallOptions callOptions)
void	createJob(CreateJobRequest request, StreamObserver<Job> responseObserver) Creates a job.
void	deleteJob(DeleteJobRequest request, StreamObserver<Empty> responseObserver) Deletes a job.
void	getJob(GetJobRequest request, StreamObserver<Job> responseObserver) Gets a job.
void	listJobs(ListJobsRequest request, StreamObserver<ListJobsResponse> responseObserver) Lists jobs.
void	pauseJob(PauseJobRequest request, StreamObserver<Job> responseObserver) Pauses a job.
void	resumeJob(ResumeJobRequest request, StreamObserver<Job> responseObserver) Resume a job.
void	runJob(RunJobRequest request, StreamObserver<Job> responseObserver) Forces a job to run now.
void	updateJob(UpdateJobRequest request, StreamObserver<Job> responseObserver) Updates a job.

Methods inherited from class io.grpc.stub.AbstractAsyncStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

build

protected CloudSchedulerGrpc.CloudSchedulerStub build(Channel channel,
                                                      CallOptions callOptions)

Specified by:

build in class AbstractStub<CloudSchedulerGrpc.CloudSchedulerStub>

listJobs

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

 Lists jobs.
 

getJob

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

 Gets a job.
 

createJob

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

 Creates a job.
 

updateJob

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

 Updates a job.
 If successful, the updated [Job][google.cloud.scheduler.v1.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][google.cloud.scheduler.v1.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.
 

deleteJob

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

 Deletes a job.
 

pauseJob

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][google.cloud.scheduler.v1.CloudScheduler.ResumeJob]. The
 state of the job is stored in [state][google.cloud.scheduler.v1.Job.state]; if paused it
 will be set to [Job.State.PAUSED][google.cloud.scheduler.v1.Job.State.PAUSED]. A job must be in [Job.State.ENABLED][google.cloud.scheduler.v1.Job.State.ENABLED]
 to be paused.
 

resumeJob

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

 Resume a job.
 This method reenables a job after it has been [Job.State.PAUSED][google.cloud.scheduler.v1.Job.State.PAUSED]. The
 state of a job is stored in [Job.state][google.cloud.scheduler.v1.Job.state]; after calling this method it
 will be set to [Job.State.ENABLED][google.cloud.scheduler.v1.Job.State.ENABLED]. A job must be in
 [Job.State.PAUSED][google.cloud.scheduler.v1.Job.State.PAUSED] to be resumed.
 

runJob

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.