Cloud AI Platform v1 API - Class ScheduleService.ScheduleServiceClient (3.13.0)

Version latest

• 3.13.0 (latest)
• 3.12.0
• 3.11.0
• 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 class ScheduleService.ScheduleServiceClient : ClientBase<ScheduleService.ScheduleServiceClient>

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

Client for ScheduleService

Inheritance

object > ClientBase > ClientBaseScheduleServiceScheduleServiceClient > ScheduleService.ScheduleServiceClient

Inherited Members

ClientBase<ScheduleService.ScheduleServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

ScheduleServiceClient()

protected ScheduleServiceClient()

Protected parameterless constructor to allow creation of test doubles.

ScheduleServiceClient(CallInvoker)

public ScheduleServiceClient(CallInvoker callInvoker)

Creates a new client for ScheduleService that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

ScheduleServiceClient(ChannelBase)

public ScheduleServiceClient(ChannelBase channel)

Creates a new client for ScheduleService

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

ScheduleServiceClient(ClientBaseConfiguration)

protected ScheduleServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

CreateIAMPolicyClient()

public virtual IAMPolicy.IAMPolicyClient CreateIAMPolicyClient()

Creates a new instance of IAMPolicy.IAMPolicyClient using the same call invoker as this client.

Returns
Type	Description
IAMPolicyIAMPolicyClient	A new IAMPolicy.IAMPolicyClient for the same target as this client.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type	Description
LocationsLocationsClient	A new Locations.LocationsClient for the same target as this client.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type	Description
OperationsOperationsClient	A new Operations client for the same target as this client.

CreateSchedule(CreateScheduleRequest, CallOptions)

public virtual Schedule CreateSchedule(CreateScheduleRequest request, CallOptions options)

Creates a Schedule.

Parameters
Name	Description
request	CreateScheduleRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Schedule	The response received from the server.

CreateSchedule(CreateScheduleRequest, Metadata, DateTime?, CancellationToken)

public virtual Schedule CreateSchedule(CreateScheduleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a Schedule.

Parameters
Name	Description
request	CreateScheduleRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Schedule	The response received from the server.

CreateScheduleAsync(CreateScheduleRequest, CallOptions)

public virtual AsyncUnaryCall<Schedule> CreateScheduleAsync(CreateScheduleRequest request, CallOptions options)

Creates a Schedule.

Parameters
Name	Description
request	CreateScheduleRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallSchedule	The call object.

CreateScheduleAsync(CreateScheduleRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Schedule> CreateScheduleAsync(CreateScheduleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a Schedule.

Parameters
Name	Description
request	CreateScheduleRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallSchedule	The call object.

DeleteSchedule(DeleteScheduleRequest, CallOptions)

public virtual Operation DeleteSchedule(DeleteScheduleRequest request, CallOptions options)

Deletes a Schedule.

Parameters
Name	Description
request	DeleteScheduleRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

DeleteSchedule(DeleteScheduleRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteSchedule(DeleteScheduleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a Schedule.

Parameters
Name	Description
request	DeleteScheduleRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

DeleteScheduleAsync(DeleteScheduleRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteScheduleAsync(DeleteScheduleRequest request, CallOptions options)

Deletes a Schedule.

Parameters
Name	Description
request	DeleteScheduleRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteScheduleAsync(DeleteScheduleRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteScheduleAsync(DeleteScheduleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a Schedule.

Parameters
Name	Description
request	DeleteScheduleRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

GetSchedule(GetScheduleRequest, CallOptions)

public virtual Schedule GetSchedule(GetScheduleRequest request, CallOptions options)

Gets a Schedule.

Parameters
Name	Description
request	GetScheduleRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Schedule	The response received from the server.

GetSchedule(GetScheduleRequest, Metadata, DateTime?, CancellationToken)

public virtual Schedule GetSchedule(GetScheduleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a Schedule.

Parameters
Name	Description
request	GetScheduleRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Schedule	The response received from the server.

GetScheduleAsync(GetScheduleRequest, CallOptions)

public virtual AsyncUnaryCall<Schedule> GetScheduleAsync(GetScheduleRequest request, CallOptions options)

Gets a Schedule.

Parameters
Name	Description
request	GetScheduleRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallSchedule	The call object.

GetScheduleAsync(GetScheduleRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Schedule> GetScheduleAsync(GetScheduleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a Schedule.

Parameters
Name	Description
request	GetScheduleRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallSchedule	The call object.

ListSchedules(ListSchedulesRequest, CallOptions)

public virtual ListSchedulesResponse ListSchedules(ListSchedulesRequest request, CallOptions options)

Lists Schedules in a Location.

Parameters
Name	Description
request	ListSchedulesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListSchedulesResponse	The response received from the server.

ListSchedules(ListSchedulesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListSchedulesResponse ListSchedules(ListSchedulesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists Schedules in a Location.

Parameters
Name	Description
request	ListSchedulesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListSchedulesResponse	The response received from the server.

ListSchedulesAsync(ListSchedulesRequest, CallOptions)

public virtual AsyncUnaryCall<ListSchedulesResponse> ListSchedulesAsync(ListSchedulesRequest request, CallOptions options)

Lists Schedules in a Location.

Parameters
Name	Description
request	ListSchedulesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListSchedulesResponse	The call object.

ListSchedulesAsync(ListSchedulesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListSchedulesResponse> ListSchedulesAsync(ListSchedulesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists Schedules in a Location.

Parameters
Name	Description
request	ListSchedulesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListSchedulesResponse	The call object.

NewInstance(ClientBaseConfiguration)

protected override ScheduleService.ScheduleServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
ScheduleServiceScheduleServiceClient

Overrides

Grpc.Core.ClientBase<Google.Cloud.AIPlatform.V1.ScheduleService.ScheduleServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

PauseSchedule(PauseScheduleRequest, CallOptions)

public virtual Empty PauseSchedule(PauseScheduleRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Empty	The response received from the server.

PauseSchedule(PauseScheduleRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty PauseSchedule(PauseScheduleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Empty	The response received from the server.

PauseScheduleAsync(PauseScheduleRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> PauseScheduleAsync(PauseScheduleRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

PauseScheduleAsync(PauseScheduleRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> PauseScheduleAsync(PauseScheduleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

ResumeSchedule(ResumeScheduleRequest, CallOptions)

public virtual Empty ResumeSchedule(ResumeScheduleRequest request, CallOptions options)

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.catch_up][google.cloud.aiplatform.v1.Schedule.catch_up] is set up true, all missed runs will be scheduled for backfill first.

Parameters
Name	Description
request	ResumeScheduleRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Empty	The response received from the server.

ResumeSchedule(ResumeScheduleRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty ResumeSchedule(ResumeScheduleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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.catch_up][google.cloud.aiplatform.v1.Schedule.catch_up] is set up true, all missed runs will be scheduled for backfill first.

Parameters
Name	Description
request	ResumeScheduleRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Empty	The response received from the server.

ResumeScheduleAsync(ResumeScheduleRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> ResumeScheduleAsync(ResumeScheduleRequest request, CallOptions options)

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.catch_up][google.cloud.aiplatform.v1.Schedule.catch_up] is set up true, all missed runs will be scheduled for backfill first.

Parameters
Name	Description
request	ResumeScheduleRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

ResumeScheduleAsync(ResumeScheduleRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> ResumeScheduleAsync(ResumeScheduleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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.catch_up][google.cloud.aiplatform.v1.Schedule.catch_up] is set up true, all missed runs will be scheduled for backfill first.

Parameters
Name	Description
request	ResumeScheduleRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

UpdateSchedule(UpdateScheduleRequest, CallOptions)

public virtual Schedule UpdateSchedule(UpdateScheduleRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Schedule	The response received from the server.

UpdateSchedule(UpdateScheduleRequest, Metadata, DateTime?, CancellationToken)

public virtual Schedule UpdateSchedule(UpdateScheduleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Schedule	The response received from the server.

UpdateScheduleAsync(UpdateScheduleRequest, CallOptions)

public virtual AsyncUnaryCall<Schedule> UpdateScheduleAsync(UpdateScheduleRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallSchedule	The call object.

UpdateScheduleAsync(UpdateScheduleRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Schedule> UpdateScheduleAsync(UpdateScheduleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallSchedule	The call object.