Cloud AI Platform v1 API - Class ScheduleServiceClientImpl (2.27.0) 

public sealed class ScheduleServiceClientImpl : ScheduleServiceClient

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

ScheduleService client wrapper implementation, for convenient use.

Inheritance

object > ScheduleServiceClient > ScheduleServiceClientImpl

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Remarks

A service for creating and managing Vertex AI's Schedule resources to periodically launch shceudled runs to make API calls.

Constructors

ScheduleServiceClientImpl(ScheduleServiceClient, ScheduleServiceSettings, ILogger)

public ScheduleServiceClientImpl(ScheduleService.ScheduleServiceClient grpcClient, ScheduleServiceSettings settings, ILogger logger)

Constructs a client wrapper for the ScheduleService service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient ScheduleServiceScheduleServiceClient

The underlying gRPC client.
settings ScheduleServiceSettings

The base ScheduleServiceSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

DeleteScheduleOperationsClient

public override OperationsClient DeleteScheduleOperationsClient { get; }

The long-running operations client for DeleteSchedule.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override ScheduleService.ScheduleServiceClient GrpcClient { get; }

The underlying gRPC ScheduleService client

Property Value
Type Description
ScheduleServiceScheduleServiceClient
Overrides

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type Description
IAMPolicyClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

Methods

CreateSchedule(CreateScheduleRequest, CallSettings)

public override Schedule CreateSchedule(CreateScheduleRequest request, CallSettings callSettings = null)

Creates a Schedule.

Parameters
Name Description
request CreateScheduleRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Schedule

The RPC response.
Overrides

CreateScheduleAsync(CreateScheduleRequest, CallSettings)

public override Task<Schedule> CreateScheduleAsync(CreateScheduleRequest request, CallSettings callSettings = null)

Creates a Schedule.

Parameters
Name Description
request CreateScheduleRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskSchedule

A Task containing the RPC response.
Overrides

DeleteSchedule(DeleteScheduleRequest, CallSettings)

public override Operation<Empty, DeleteOperationMetadata> DeleteSchedule(DeleteScheduleRequest request, CallSettings callSettings = null)

Deletes a Schedule.

Parameters
Name Description
request DeleteScheduleRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyDeleteOperationMetadata

The RPC response.
Overrides

DeleteScheduleAsync(DeleteScheduleRequest, CallSettings)

public override Task<Operation<Empty, DeleteOperationMetadata>> DeleteScheduleAsync(DeleteScheduleRequest request, CallSettings callSettings = null)

Deletes a Schedule.

Parameters
Name Description
request DeleteScheduleRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.
Overrides

GetSchedule(GetScheduleRequest, CallSettings)

public override Schedule GetSchedule(GetScheduleRequest request, CallSettings callSettings = null)

Gets a Schedule.

Parameters
Name Description
request GetScheduleRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Schedule

The RPC response.
Overrides

GetScheduleAsync(GetScheduleRequest, CallSettings)

public override Task<Schedule> GetScheduleAsync(GetScheduleRequest request, CallSettings callSettings = null)

Gets a Schedule.

Parameters
Name Description
request GetScheduleRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskSchedule

A Task containing the RPC response.
Overrides

ListSchedules(ListSchedulesRequest, CallSettings)

public override PagedEnumerable<ListSchedulesResponse, Schedule> ListSchedules(ListSchedulesRequest request, CallSettings callSettings = null)

Lists Schedules in a Location.

Parameters
Name Description
request ListSchedulesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListSchedulesResponseSchedule

A pageable sequence of Schedule resources.
Overrides

ListSchedulesAsync(ListSchedulesRequest, CallSettings)

public override PagedAsyncEnumerable<ListSchedulesResponse, Schedule> ListSchedulesAsync(ListSchedulesRequest request, CallSettings callSettings = null)

Lists Schedules in a Location.

Parameters
Name Description
request ListSchedulesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListSchedulesResponseSchedule

A pageable asynchronous sequence of Schedule resources.
Overrides

PauseSchedule(PauseScheduleRequest, CallSettings)

public override void PauseSchedule(PauseScheduleRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

PauseScheduleAsync(PauseScheduleRequest, CallSettings)

public override Task PauseScheduleAsync(PauseScheduleRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

ResumeSchedule(ResumeScheduleRequest, CallSettings)

public override void ResumeSchedule(ResumeScheduleRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

ResumeScheduleAsync(ResumeScheduleRequest, CallSettings)

public override Task ResumeScheduleAsync(ResumeScheduleRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

UpdateSchedule(UpdateScheduleRequest, CallSettings)

public override Schedule UpdateSchedule(UpdateScheduleRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Schedule

The RPC response.
Overrides

UpdateScheduleAsync(UpdateScheduleRequest, CallSettings)

public override Task<Schedule> UpdateScheduleAsync(UpdateScheduleRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskSchedule

A Task containing the RPC response.
Overrides