- 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
public sealed class ScheduleServiceClientImpl : ScheduleServiceClientReference documentation and code samples for the Cloud AI Platform v1 API class ScheduleServiceClientImpl.
ScheduleService client wrapper implementation, for convenient use.
Namespace
Google.Cloud.AIPlatform.V1Assembly
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 | ScheduleServiceScheduleServiceClientThe underlying gRPC client. |
settings | ScheduleServiceSettingsThe base ScheduleServiceSettings used within this client. |
logger | ILoggerOptional 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 | |
GrpcClient
public override ScheduleService.ScheduleServiceClient GrpcClient { get; }The underlying gRPC ScheduleService client
| Property Value | |
|---|---|
| Type | Description |
ScheduleServiceScheduleServiceClient | |
IAMPolicyClient
public override IAMPolicyClient IAMPolicyClient { get; }The IAMPolicyClient associated with this client.
| Property Value | |
|---|---|
| Type | Description |
IAMPolicyClient | |
LocationsClient
public override LocationsClient LocationsClient { get; }The LocationsClient associated with this client.
| Property Value | |
|---|---|
| Type | Description |
LocationsClient | |
Methods
CreateSchedule(CreateScheduleRequest, CallSettings)
public override Schedule CreateSchedule(CreateScheduleRequest request, CallSettings callSettings = null)Creates a Schedule.
| Parameters | |
|---|---|
| Name | Description |
request | CreateScheduleRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Schedule | The RPC response. |
CreateScheduleAsync(CreateScheduleRequest, CallSettings)
public override Task<Schedule> CreateScheduleAsync(CreateScheduleRequest request, CallSettings callSettings = null)Creates a Schedule.
| Parameters | |
|---|---|
| Name | Description |
request | CreateScheduleRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskSchedule | A Task containing the RPC response. |
DeleteSchedule(DeleteScheduleRequest, CallSettings)
public override Operation<Empty, DeleteOperationMetadata> DeleteSchedule(DeleteScheduleRequest request, CallSettings callSettings = null)Deletes a Schedule.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteScheduleRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationEmptyDeleteOperationMetadata | The RPC response. |
DeleteScheduleAsync(DeleteScheduleRequest, CallSettings)
public override Task<Operation<Empty, DeleteOperationMetadata>> DeleteScheduleAsync(DeleteScheduleRequest request, CallSettings callSettings = null)Deletes a Schedule.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteScheduleRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyDeleteOperationMetadata | A Task containing the RPC response. |
GetSchedule(GetScheduleRequest, CallSettings)
public override Schedule GetSchedule(GetScheduleRequest request, CallSettings callSettings = null)Gets a Schedule.
| Parameters | |
|---|---|
| Name | Description |
request | GetScheduleRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Schedule | The RPC response. |
GetScheduleAsync(GetScheduleRequest, CallSettings)
public override Task<Schedule> GetScheduleAsync(GetScheduleRequest request, CallSettings callSettings = null)Gets a Schedule.
| Parameters | |
|---|---|
| Name | Description |
request | GetScheduleRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskSchedule | A Task containing the RPC response. |
ListSchedules(ListSchedulesRequest, CallSettings)
public override PagedEnumerable<ListSchedulesResponse, Schedule> ListSchedules(ListSchedulesRequest request, CallSettings callSettings = null)Lists Schedules in a Location.
| Parameters | |
|---|---|
| Name | Description |
request | ListSchedulesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListSchedulesResponseSchedule | A pageable sequence of Schedule resources. |
ListSchedulesAsync(ListSchedulesRequest, CallSettings)
public override PagedAsyncEnumerable<ListSchedulesResponse, Schedule> ListSchedulesAsync(ListSchedulesRequest request, CallSettings callSettings = null)Lists Schedules in a Location.
| Parameters | |
|---|---|
| Name | Description |
request | ListSchedulesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListSchedulesResponseSchedule | A pageable asynchronous sequence of Schedule resources. |
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 | PauseScheduleRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
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 | PauseScheduleRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
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 | ResumeScheduleRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
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 | ResumeScheduleRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
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 | UpdateScheduleRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Schedule | The RPC response. |
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 | UpdateScheduleRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskSchedule | A Task containing the RPC response. |