Cloud AI Platform v1 API - Class ScheduleService.ScheduleServiceBase (3.9.0) 

[BindServiceMethod(typeof(ScheduleService), "BindService")]
public abstract class ScheduleService.ScheduleServiceBase

Reference documentation and code samples for the Cloud AI Platform v1 API class ScheduleService.ScheduleServiceBase.

Base class for server-side implementations of ScheduleService

Inheritance

object > ScheduleService.ScheduleServiceBase

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Methods

CreateSchedule(CreateScheduleRequest, ServerCallContext)

public virtual Task<Schedule> CreateSchedule(CreateScheduleRequest request, ServerCallContext context)

Creates a Schedule.

Parameters
Name Description
request CreateScheduleRequest

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskSchedule

The response to send back to the client (wrapped by a task).

DeleteSchedule(DeleteScheduleRequest, ServerCallContext)

public virtual Task<Operation> DeleteSchedule(DeleteScheduleRequest request, ServerCallContext context)

Deletes a Schedule.

Parameters
Name Description
request DeleteScheduleRequest

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

GetSchedule(GetScheduleRequest, ServerCallContext)

public virtual Task<Schedule> GetSchedule(GetScheduleRequest request, ServerCallContext context)

Gets a Schedule.

Parameters
Name Description
request GetScheduleRequest

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskSchedule

The response to send back to the client (wrapped by a task).

ListSchedules(ListSchedulesRequest, ServerCallContext)

public virtual Task<ListSchedulesResponse> ListSchedules(ListSchedulesRequest request, ServerCallContext context)

Lists Schedules in a Location.

Parameters
Name Description
request ListSchedulesRequest

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskListSchedulesResponse

The response to send back to the client (wrapped by a task).

PauseSchedule(PauseScheduleRequest, ServerCallContext)

public virtual Task<Empty> PauseSchedule(PauseScheduleRequest request, ServerCallContext context)

Pauses a Schedule. Will mark [Schedule.state][google.cloud.aiplatform.v1.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

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskEmpty

The response to send back to the client (wrapped by a task).

ResumeSchedule(ResumeScheduleRequest, ServerCallContext)

public virtual Task<Empty> ResumeSchedule(ResumeScheduleRequest request, ServerCallContext context)

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

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskEmpty

The response to send back to the client (wrapped by a task).

UpdateSchedule(UpdateScheduleRequest, ServerCallContext)

public virtual Task<Schedule> UpdateSchedule(UpdateScheduleRequest request, ServerCallContext context)

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

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskSchedule

The response to send back to the client (wrapped by a task).