Package com.google.cloud.aiplatform.v1beta1

Class ScheduleServiceGrpc.ScheduleServiceFutureStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractFutureStub<ScheduleServiceGrpc.ScheduleServiceFutureStub>

com.google.cloud.aiplatform.v1beta1.ScheduleServiceGrpc.ScheduleServiceFutureStub

Enclosing class:

ScheduleServiceGrpc

public static final class ScheduleServiceGrpc.ScheduleServiceFutureStub
extends io.grpc.stub.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.
 

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

Method Summary

Modifier and Type	Method	Description
protected ScheduleServiceGrpc.ScheduleServiceFutureStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
com.google.common.util.concurrent.ListenableFuture<Schedule>	createSchedule(CreateScheduleRequest request)	Creates a Schedule.
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	deleteSchedule(DeleteScheduleRequest request)	Deletes a Schedule.
com.google.common.util.concurrent.ListenableFuture<Schedule>	getSchedule(GetScheduleRequest request)	Gets a Schedule.
com.google.common.util.concurrent.ListenableFuture<ListSchedulesResponse>	listSchedules(ListSchedulesRequest request)	Lists Schedules in a Location.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	pauseSchedule(PauseScheduleRequest request)	Pauses a Schedule.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	resumeSchedule(ResumeScheduleRequest request)	Resumes a paused Schedule to start scheduling new runs.
com.google.common.util.concurrent.ListenableFuture<Schedule>	updateSchedule(UpdateScheduleRequest request)	Updates an active or paused Schedule.

Methods inherited from class io.grpc.stub.AbstractFutureStub

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 ScheduleServiceGrpc.ScheduleServiceFutureStub build(io.grpc.Channel channel,
                                                              io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<ScheduleServiceGrpc.ScheduleServiceFutureStub>

createSchedule

public com.google.common.util.concurrent.ListenableFuture<Schedule> createSchedule(CreateScheduleRequest request)

 Creates a Schedule.
 

deleteSchedule

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> deleteSchedule(DeleteScheduleRequest request)

 Deletes a Schedule.
 

getSchedule

public com.google.common.util.concurrent.ListenableFuture<Schedule> getSchedule(GetScheduleRequest request)

 Gets a Schedule.
 

listSchedules

public com.google.common.util.concurrent.ListenableFuture<ListSchedulesResponse> listSchedules(ListSchedulesRequest request)

 Lists Schedules in a Location.
 

pauseSchedule

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> pauseSchedule(PauseScheduleRequest request)

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

resumeSchedule

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> resumeSchedule(ResumeScheduleRequest request)

 Resumes a paused Schedule to start scheduling new runs. Will mark
 [Schedule.state][google.cloud.aiplatform.v1beta1.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.
 

updateSchedule

public com.google.common.util.concurrent.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.