Class ScheduleServiceGrpc.ScheduleServiceBlockingStub (3.46.0)

public static final class ScheduleServiceGrpc.ScheduleServiceBlockingStub extends AbstractBlockingStub<ScheduleServiceGrpc.ScheduleServiceBlockingStub>

A stub to allow clients to do synchronous 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.AbstractBlockingStub > ScheduleServiceGrpc.ScheduleServiceBlockingStub

Methods

build(Channel channel, CallOptions callOptions)

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

createSchedule(CreateScheduleRequest request)

public Schedule createSchedule(CreateScheduleRequest request)

Creates a Schedule.

Parameter
Name Description
request CreateScheduleRequest
Returns
Type Description
Schedule

deleteSchedule(DeleteScheduleRequest request)

public Operation deleteSchedule(DeleteScheduleRequest request)

Deletes a Schedule.

Parameter
Name Description
request DeleteScheduleRequest
Returns
Type Description
Operation

getSchedule(GetScheduleRequest request)

public Schedule getSchedule(GetScheduleRequest request)

Gets a Schedule.

Parameter
Name Description
request GetScheduleRequest
Returns
Type Description
Schedule

listSchedules(ListSchedulesRequest request)

public ListSchedulesResponse listSchedules(ListSchedulesRequest request)

Lists Schedules in a Location.

Parameter
Name Description
request ListSchedulesRequest
Returns
Type Description
ListSchedulesResponse

pauseSchedule(PauseScheduleRequest request)

public 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
Name Description
request PauseScheduleRequest
Returns
Type Description
Empty

resumeSchedule(ResumeScheduleRequest request)

public 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
Name Description
request ResumeScheduleRequest
Returns
Type Description
Empty

updateSchedule(UpdateScheduleRequest request)

public 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
Name Description
request UpdateScheduleRequest
Returns
Type Description
Schedule