- 2.51.0 (latest)
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.13
- 2.2.0
- 2.1.23
public static final class CloudSchedulerGrpc.CloudSchedulerFutureStub extends 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.
Inheritance
java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > CloudSchedulerGrpc.CloudSchedulerFutureStubMethods
build(Channel channel, CallOptions callOptions)
protected CloudSchedulerGrpc.CloudSchedulerFutureStub build(Channel channel, CallOptions callOptions)
Parameters | |
---|---|
Name | Description |
channel | io.grpc.Channel |
callOptions | io.grpc.CallOptions |
Returns | |
---|---|
Type | Description |
CloudSchedulerGrpc.CloudSchedulerFutureStub |
createJob(CreateJobRequest request)
public ListenableFuture<Job> createJob(CreateJobRequest request)
Creates a job.
Parameter | |
---|---|
Name | Description |
request | CreateJobRequest |
Returns | |
---|---|
Type | Description |
com.google.common.util.concurrent.ListenableFuture<Job> |
deleteJob(DeleteJobRequest request)
public ListenableFuture<Empty> deleteJob(DeleteJobRequest request)
Deletes a job.
Parameter | |
---|---|
Name | Description |
request | DeleteJobRequest |
Returns | |
---|---|
Type | Description |
com.google.common.util.concurrent.ListenableFuture<Empty> |
getJob(GetJobRequest request)
public ListenableFuture<Job> getJob(GetJobRequest request)
Gets a job.
Parameter | |
---|---|
Name | Description |
request | GetJobRequest |
Returns | |
---|---|
Type | Description |
com.google.common.util.concurrent.ListenableFuture<Job> |
listJobs(ListJobsRequest request)
public ListenableFuture<ListJobsResponse> listJobs(ListJobsRequest request)
Lists jobs.
Parameter | |
---|---|
Name | Description |
request | ListJobsRequest |
Returns | |
---|---|
Type | Description |
com.google.common.util.concurrent.ListenableFuture<ListJobsResponse> |
pauseJob(PauseJobRequest request)
public 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. 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.
Parameter | |
---|---|
Name | Description |
request | PauseJobRequest |
Returns | |
---|---|
Type | Description |
com.google.common.util.concurrent.ListenableFuture<Job> |
resumeJob(ResumeJobRequest request)
public ListenableFuture<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.
Parameter | |
---|---|
Name | Description |
request | ResumeJobRequest |
Returns | |
---|---|
Type | Description |
com.google.common.util.concurrent.ListenableFuture<Job> |
runJob(RunJobRequest request)
public 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.
Parameter | |
---|---|
Name | Description |
request | RunJobRequest |
Returns | |
---|---|
Type | Description |
com.google.common.util.concurrent.ListenableFuture<Job> |
updateJob(UpdateJobRequest request)
public ListenableFuture<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.
Parameter | |
---|---|
Name | Description |
request | UpdateJobRequest |
Returns | |
---|---|
Type | Description |
com.google.common.util.concurrent.ListenableFuture<Job> |