Class ScheduleServiceGrpc.ScheduleServiceFutureStub (3.31.0)

public static final class ScheduleServiceGrpc.ScheduleServiceFutureStub extends AbstractFutureStub<ScheduleServiceGrpc.ScheduleServiceFutureStub>

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

A service for creating and managing Vertex AI's Schedule resources to periodically launch shceudled runs to make API calls.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > ScheduleServiceGrpc.ScheduleServiceFutureStub

Methods

build(Channel channel, CallOptions callOptions)

protected ScheduleServiceGrpc.ScheduleServiceFutureStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
ScheduleServiceGrpc.ScheduleServiceFutureStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createSchedule(CreateScheduleRequest request)

public ListenableFuture<Schedule> createSchedule(CreateScheduleRequest request)

Creates a Schedule.

Parameter
NameDescription
requestCreateScheduleRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Schedule>

deleteSchedule(DeleteScheduleRequest request)

public ListenableFuture<Operation> deleteSchedule(DeleteScheduleRequest request)

Deletes a Schedule.

Parameter
NameDescription
requestDeleteScheduleRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

getSchedule(GetScheduleRequest request)

public ListenableFuture<Schedule> getSchedule(GetScheduleRequest request)

Gets a Schedule.

Parameter
NameDescription
requestGetScheduleRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Schedule>

listSchedules(ListSchedulesRequest request)

public ListenableFuture<ListSchedulesResponse> listSchedules(ListSchedulesRequest request)

Lists Schedules in a Location.

Parameter
NameDescription
requestListSchedulesRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListSchedulesResponse>

pauseSchedule(PauseScheduleRequest request)

public ListenableFuture<Empty> pauseSchedule(PauseScheduleRequest request)

Pauses a Schedule. Will mark Schedule.state to 'PAUSED'. If the schedule is paused, no new runs will be created. Already created runs will NOT be paused or canceled.

Parameter
NameDescription
requestPauseScheduleRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

resumeSchedule(ResumeScheduleRequest request)

public ListenableFuture<Empty> resumeSchedule(ResumeScheduleRequest request)

Resumes a paused Schedule to start scheduling new runs. Will mark Schedule.state to 'ACTIVE'. Only paused Schedule can be resumed. When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. If [Schedule.catchUp][] is set up true, all missed runs will be scheduled for backfill first.

Parameter
NameDescription
requestResumeScheduleRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

updateSchedule(UpdateScheduleRequest request)

public ListenableFuture<Schedule> updateSchedule(UpdateScheduleRequest request)

Updates an active or paused Schedule. When the Schedule is updated, new runs will be scheduled starting from the updated next execution time after the update time based on the time_specification in the updated Schedule. All unstarted runs before the update time will be skipped while already created runs will NOT be paused or canceled.

Parameter
NameDescription
requestUpdateScheduleRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Schedule>