com.google.cloud.scheduler.v1

Class CloudSchedulerGrpc.CloudSchedulerBlockingStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractBlockingStub<CloudSchedulerGrpc.CloudSchedulerBlockingStub>

com.google.cloud.scheduler.v1.CloudSchedulerGrpc.CloudSchedulerBlockingStub

Enclosing class:

CloudSchedulerGrpc

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

 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.CloudSchedulerBlockingStub	build(Channel channel, CallOptions callOptions)
Job	createJob(CreateJobRequest request) Creates a job.
Empty	deleteJob(DeleteJobRequest request) Deletes a job.
Job	getJob(GetJobRequest request) Gets a job.
ListJobsResponse	listJobs(ListJobsRequest request) Lists jobs.
Job	pauseJob(PauseJobRequest request) Pauses a job.
Job	resumeJob(ResumeJobRequest request) Resume a job.
Job	runJob(RunJobRequest request) Forces a job to run now.
Job	updateJob(UpdateJobRequest request) Updates a job.

Methods inherited from class io.grpc.stub.AbstractBlockingStub

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

Specified by:

build in class AbstractStub<CloudSchedulerGrpc.CloudSchedulerBlockingStub>

listJobs

public ListJobsResponse listJobs(ListJobsRequest request)

 Lists jobs.
 

getJob

public Job getJob(GetJobRequest request)

 Gets a job.
 

createJob

public Job createJob(CreateJobRequest request)

 Creates a job.
 

updateJob

public Job updateJob(UpdateJobRequest request)

 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 Empty deleteJob(DeleteJobRequest request)

 Deletes a job.
 

pauseJob

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][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 Job resumeJob(ResumeJobRequest request)

 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 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.