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
Inherited Members
io.grpc.stub.AbstractBlockingStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)
io.grpc.stub.AbstractBlockingStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)
io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
io.grpc.stub.AbstractStub.getCallOptions()
io.grpc.stub.AbstractStub.getChannel()
io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)
io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)
io.grpc.stub.AbstractStub.withCompression(java.lang.String)
io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)
io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)
io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)
io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)
io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)
io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)
io.grpc.stub.AbstractStub.withWaitForReady()
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
|
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
createJob(CreateJobRequest request)
public Job createJob(CreateJobRequest request)
| Returns |
|---|
| Type | Description |
Job | |
deleteJob(DeleteJobRequest request)
public Empty deleteJob(DeleteJobRequest request)
| Returns |
|---|
| Type | Description |
Empty | |
getJob(GetJobRequest request)
public Job getJob(GetJobRequest request)
| Returns |
|---|
| Type | Description |
Job | |
listJobs(ListJobsRequest request)
public ListJobsResponse listJobs(ListJobsRequest request)
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.
| 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.
| 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.
| 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.
| Returns |
|---|
| Type | Description |
Job | |
