Class ScheduleServiceGrpc.ScheduleServiceStub (3.43.0)

public static final class ScheduleServiceGrpc.ScheduleServiceStub extends AbstractAsyncStub<ScheduleServiceGrpc.ScheduleServiceStub>

A stub to allow clients to do asynchronous 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.AbstractAsyncStub > ScheduleServiceGrpc.ScheduleServiceStub

Methods

build(Channel channel, CallOptions callOptions)

protected ScheduleServiceGrpc.ScheduleServiceStub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
ScheduleServiceGrpc.ScheduleServiceStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createSchedule(CreateScheduleRequest request, StreamObserver<Schedule> responseObserver)

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

Creates a Schedule.

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

deleteSchedule(DeleteScheduleRequest request, StreamObserver<Operation> responseObserver)

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

Deletes a Schedule.

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

getSchedule(GetScheduleRequest request, StreamObserver<Schedule> responseObserver)

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

Gets a Schedule.

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

listSchedules(ListSchedulesRequest request, StreamObserver<ListSchedulesResponse> responseObserver)

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

Lists Schedules in a Location.

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

pauseSchedule(PauseScheduleRequest request, StreamObserver<Empty> responseObserver)

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

resumeSchedule(ResumeScheduleRequest request, StreamObserver<Empty> responseObserver)

public 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
Name Description
request ResumeScheduleRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

updateSchedule(UpdateScheduleRequest request, StreamObserver<Schedule> responseObserver)

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