Interface ScheduleServiceGrpc.AsyncService (3.64.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 responseObserver)

public default void createSchedule(CreateScheduleRequest request, StreamObserver responseObserver)

Creates a Schedule.

Parameters
Name Description
request CreateScheduleRequest
responseObserver io.grpc.stub.StreamObserver<Schedule>

deleteSchedule(DeleteScheduleRequest request, StreamObserver responseObserver)

public default void deleteSchedule(DeleteScheduleRequest request, StreamObserver responseObserver)

Deletes a Schedule.

Parameters
Name Description
request DeleteScheduleRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

getSchedule(GetScheduleRequest request, StreamObserver responseObserver)

public default void getSchedule(GetScheduleRequest request, StreamObserver responseObserver)

Gets a Schedule.

Parameters
Name Description
request GetScheduleRequest
responseObserver io.grpc.stub.StreamObserver<Schedule>

listSchedules(ListSchedulesRequest request, StreamObserver responseObserver)

public default void listSchedules(ListSchedulesRequest request, StreamObserver responseObserver)

Lists Schedules in a Location.

Parameters
Name Description
request ListSchedulesRequest
responseObserver io.grpc.stub.StreamObserver<ListSchedulesResponse>

pauseSchedule(PauseScheduleRequest request, StreamObserver responseObserver)

public default void pauseSchedule(PauseScheduleRequest request, StreamObserver 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
Name Description
request PauseScheduleRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

resumeSchedule(ResumeScheduleRequest request, StreamObserver responseObserver)

public default void resumeSchedule(ResumeScheduleRequest request, StreamObserver 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.catch_up is set up true, all missed runs will be scheduled for backfill first.

Parameters
Name Description
request ResumeScheduleRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

updateSchedule(UpdateScheduleRequest request, StreamObserver responseObserver)

public default void updateSchedule(UpdateScheduleRequest request, StreamObserver 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
Name Description
request UpdateScheduleRequest
responseObserver io.grpc.stub.StreamObserver<Schedule>