Package com.google.cloud.scheduler.v1beta1

Class CloudSchedulerGrpc.CloudSchedulerFutureStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractFutureStub<CloudSchedulerGrpc.CloudSchedulerFutureStub>

com.google.cloud.scheduler.v1beta1.CloudSchedulerGrpc.CloudSchedulerFutureStub

Enclosing class:

CloudSchedulerGrpc

public static final class CloudSchedulerGrpc.CloudSchedulerFutureStub
extends io.grpc.stub.AbstractFutureStub<CloudSchedulerGrpc.CloudSchedulerFutureStub>

A stub to allow clients to do ListenableFuture-style rpc calls to service CloudScheduler.

 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

io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

Method Summary

Modifier and Type	Method	Description
protected CloudSchedulerGrpc.CloudSchedulerFutureStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
com.google.common.util.concurrent.ListenableFuture<Job>	createJob(CreateJobRequest request)	Creates a job.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	deleteJob(DeleteJobRequest request)	Deletes a job.
com.google.common.util.concurrent.ListenableFuture<Job>	getJob(GetJobRequest request)	Gets a job.
com.google.common.util.concurrent.ListenableFuture<ListJobsResponse>	listJobs(ListJobsRequest request)	Lists jobs.
com.google.common.util.concurrent.ListenableFuture<Job>	pauseJob(PauseJobRequest request)	Pauses a job.
com.google.common.util.concurrent.ListenableFuture<Job>	resumeJob(ResumeJobRequest request)	Resume a job.
com.google.common.util.concurrent.ListenableFuture<Job>	runJob(RunJobRequest request)	Forces a job to run now.
com.google.common.util.concurrent.ListenableFuture<Job>	updateJob(UpdateJobRequest request)	Updates a job.

Methods inherited from class io.grpc.stub.AbstractFutureStub

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.CloudSchedulerFutureStub build(io.grpc.Channel channel,
                                                            io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<CloudSchedulerGrpc.CloudSchedulerFutureStub>

listJobs

public com.google.common.util.concurrent.ListenableFuture<ListJobsResponse> listJobs(ListJobsRequest request)

 Lists jobs.
 

getJob

public com.google.common.util.concurrent.ListenableFuture<Job> getJob(GetJobRequest request)

 Gets a job.
 

createJob

public com.google.common.util.concurrent.ListenableFuture<Job> createJob(CreateJobRequest request)

 Creates a job.
 

updateJob

public com.google.common.util.concurrent.ListenableFuture<Job> updateJob(UpdateJobRequest request)

 Updates a job.
 If successful, the updated [Job][google.cloud.scheduler.v1beta1.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.v1beta1.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 com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteJob(DeleteJobRequest request)

 Deletes a job.
 

pauseJob

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

resumeJob

public com.google.common.util.concurrent.ListenableFuture<Job> resumeJob(ResumeJobRequest request)

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

runJob

public com.google.common.util.concurrent.ListenableFuture<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.