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

Version 3.6.0

• 3.11.0 (latest)
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.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

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

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).