Show / Hide Table of Contents

Class ProjectsResource.LocationsResource.SchedulesResource

The "schedules" collection of methods.

Inheritance
object
ProjectsResource.LocationsResource.SchedulesResource
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Aiplatform.v1beta1
Assembly: Google.Apis.Aiplatform.v1beta1.dll
Syntax
public class ProjectsResource.LocationsResource.SchedulesResource

Constructors

SchedulesResource(IClientService)

Constructs a new resource.

Declaration
public SchedulesResource(IClientService service)
Parameters
Type Name Description
IClientService service

Properties

Operations

Gets the Operations resource.

Declaration
public virtual ProjectsResource.LocationsResource.SchedulesResource.OperationsResource Operations { get; }
Property Value
Type Description
ProjectsResource.LocationsResource.SchedulesResource.OperationsResource

Methods

Create(GoogleCloudAiplatformV1beta1Schedule, string)

Creates a Schedule.

Declaration
public virtual ProjectsResource.LocationsResource.SchedulesResource.CreateRequest Create(GoogleCloudAiplatformV1beta1Schedule body, string parent)
Parameters
Type Name Description
GoogleCloudAiplatformV1beta1Schedule body

The body of the request.

string parent

Required. The resource name of the Location to create the Schedule in. Format: projects/{project}/locations/{location}

Returns
Type Description
ProjectsResource.LocationsResource.SchedulesResource.CreateRequest

Delete(string)

Deletes a Schedule.

Declaration
public virtual ProjectsResource.LocationsResource.SchedulesResource.DeleteRequest Delete(string name)
Parameters
Type Name Description
string name

Required. The name of the Schedule resource to be deleted. Format: projects/{project}/locations/{location}/schedules/{schedule}

Returns
Type Description
ProjectsResource.LocationsResource.SchedulesResource.DeleteRequest

Get(string)

Gets a Schedule.

Declaration
public virtual ProjectsResource.LocationsResource.SchedulesResource.GetRequest Get(string name)
Parameters
Type Name Description
string name

Required. The name of the Schedule resource. Format: projects/{project}/locations/{location}/schedules/{schedule}

Returns
Type Description
ProjectsResource.LocationsResource.SchedulesResource.GetRequest

List(string)

Lists Schedules in a Location.

Declaration
public virtual ProjectsResource.LocationsResource.SchedulesResource.ListRequest List(string parent)
Parameters
Type Name Description
string parent

Required. The resource name of the Location to list the Schedules from. Format: projects/{project}/locations/{location}

Returns
Type Description
ProjectsResource.LocationsResource.SchedulesResource.ListRequest

Patch(GoogleCloudAiplatformV1beta1Schedule, string)

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.

Declaration
public virtual ProjectsResource.LocationsResource.SchedulesResource.PatchRequest Patch(GoogleCloudAiplatformV1beta1Schedule body, string name)
Parameters
Type Name Description
GoogleCloudAiplatformV1beta1Schedule body

The body of the request.

string name

Immutable. The resource name of the Schedule.

Returns
Type Description
ProjectsResource.LocationsResource.SchedulesResource.PatchRequest

Pause(GoogleCloudAiplatformV1beta1PauseScheduleRequest, string)

Pauses a Schedule. Will mark Schedule.state to 'PAUSED'. If the schedule is paused, no new runs will be created. Already created runs will NOT be paused or canceled.

Declaration
public virtual ProjectsResource.LocationsResource.SchedulesResource.PauseRequest Pause(GoogleCloudAiplatformV1beta1PauseScheduleRequest body, string name)
Parameters
Type Name Description
GoogleCloudAiplatformV1beta1PauseScheduleRequest body

The body of the request.

string name

Required. The name of the Schedule resource to be paused. Format: projects/{project}/locations/{location}/schedules/{schedule}

Returns
Type Description
ProjectsResource.LocationsResource.SchedulesResource.PauseRequest

Resume(GoogleCloudAiplatformV1beta1ResumeScheduleRequest, string)

Resumes a paused Schedule to start scheduling new runs. Will mark 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 is set up true, all missed runs will be scheduled for backfill first.

Declaration
public virtual ProjectsResource.LocationsResource.SchedulesResource.ResumeRequest Resume(GoogleCloudAiplatformV1beta1ResumeScheduleRequest body, string name)
Parameters
Type Name Description
GoogleCloudAiplatformV1beta1ResumeScheduleRequest body

The body of the request.

string name

Required. The name of the Schedule resource to be resumed. Format: projects/{project}/locations/{location}/schedules/{schedule}

Returns
Type Description
ProjectsResource.LocationsResource.SchedulesResource.ResumeRequest
In this article
Back to top Generated by DocFX