Class CloudSchedulerGrpc.CloudSchedulerFutureStub (2.52.0)

publicstaticfinalclass CloudSchedulerGrpc.CloudSchedulerFutureStubextendsAbstractFutureStub<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.CloudSchedulerFutureStub

Inherited Members

io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)
io.grpc.stub.AbstractFutureStub.<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.withOnReadyThreshold(int)
io.grpc.stub.AbstractStub.withWaitForReady()

Methods

build(Channel channel, CallOptions callOptions)

protectedCloudSchedulerGrpc.CloudSchedulerFutureStubbuild(Channelchannel,CallOptionscallOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
CloudSchedulerGrpc.CloudSchedulerFutureStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createJob(CreateJobRequest request)

publicListenableFuture<Job>createJob(CreateJobRequestrequest)

Creates a job.

Parameter
Name Description
request CreateJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Job>

deleteJob(DeleteJobRequest request)

publicListenableFuture<Empty>deleteJob(DeleteJobRequestrequest)

Deletes a job.

Parameter
Name Description
request DeleteJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

getJob(GetJobRequest request)

publicListenableFuture<Job>getJob(GetJobRequestrequest)

Gets a job.

Parameter
Name Description
request GetJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Job>

listJobs(ListJobsRequest request)

publicListenableFuture<ListJobsResponse>listJobs(ListJobsRequestrequest)

Lists jobs.

Parameter
Name Description
request ListJobsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListJobsResponse>

pauseJob(PauseJobRequest request)

publicListenableFuture<Job>pauseJob(PauseJobRequestrequest)

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)

publicListenableFuture<Job>resumeJob(ResumeJobRequestrequest)

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)

publicListenableFuture<Job>runJob(RunJobRequestrequest)

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)

publicListenableFuture<Job>updateJob(UpdateJobRequestrequest)

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>

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.