Interface ScheduleServiceGrpc.AsyncService (3.40.0)

public static interface ScheduleServiceGrpc.AsyncService

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

Methods

createSchedule(CreateScheduleRequest request, StreamObserver<Schedule> responseObserver)

public default void createSchedule(CreateScheduleRequest request, StreamObserver<Schedule> responseObserver)

Creates a Schedule.

Parameters
NameDescription
requestCreateScheduleRequest
responseObserverio.grpc.stub.StreamObserver<Schedule>

deleteSchedule(DeleteScheduleRequest request, StreamObserver<Operation> responseObserver)

public default void deleteSchedule(DeleteScheduleRequest request, StreamObserver<Operation> responseObserver)

Deletes a Schedule.

Parameters
NameDescription
requestDeleteScheduleRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

getSchedule(GetScheduleRequest request, StreamObserver<Schedule> responseObserver)

public default void getSchedule(GetScheduleRequest request, StreamObserver<Schedule> responseObserver)

Gets a Schedule.

Parameters
NameDescription
requestGetScheduleRequest
responseObserverio.grpc.stub.StreamObserver<Schedule>

listSchedules(ListSchedulesRequest request, StreamObserver<ListSchedulesResponse> responseObserver)

public default void listSchedules(ListSchedulesRequest request, StreamObserver<ListSchedulesResponse> responseObserver)

Lists Schedules in a Location.

Parameters
NameDescription
requestListSchedulesRequest
responseObserverio.grpc.stub.StreamObserver<ListSchedulesResponse>

pauseSchedule(PauseScheduleRequest request, StreamObserver<Empty> responseObserver)

public default void pauseSchedule(PauseScheduleRequest request, StreamObserver<Empty> responseObserver)

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.

Parameters
NameDescription
requestPauseScheduleRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

resumeSchedule(ResumeScheduleRequest request, StreamObserver<Empty> responseObserver)

public default void resumeSchedule(ResumeScheduleRequest request, StreamObserver<Empty> responseObserver)

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.

Parameters
NameDescription
requestResumeScheduleRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

updateSchedule(UpdateScheduleRequest request, StreamObserver<Schedule> responseObserver)

public default void updateSchedule(UpdateScheduleRequest request, StreamObserver<Schedule> responseObserver)

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.

Parameters
NameDescription
requestUpdateScheduleRequest
responseObserverio.grpc.stub.StreamObserver<Schedule>