Class ProjectsResource.LocationsResource.PipelineJobsResource

The "pipelineJobs" collection of methods.

Inheritance

object

ProjectsResource.LocationsResource.PipelineJobsResource

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

Constructors

PipelineJobsResource(IClientService)

Constructs a new resource.

Declaration

public PipelineJobsResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Properties

Operations

Gets the Operations resource.

Declaration

public virtual ProjectsResource.LocationsResource.PipelineJobsResource.OperationsResource Operations { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.PipelineJobsResource.OperationsResource

Methods

BatchCancel(GoogleCloudAiplatformV1beta1BatchCancelPipelineJobsRequest, string)

Batch cancel PipelineJobs. Firstly the server will check if all the jobs are in non-terminal states, and skip the jobs that are already terminated. If the operation failed, none of the pipeline jobs are cancelled. The server will poll the states of all the pipeline jobs periodically to check the cancellation status. This operation will return an LRO.

Declaration

public virtual ProjectsResource.LocationsResource.PipelineJobsResource.BatchCancelRequest BatchCancel(GoogleCloudAiplatformV1beta1BatchCancelPipelineJobsRequest body, string parent)

Parameters

Type	Name	Description
GoogleCloudAiplatformV1beta1BatchCancelPipelineJobsRequest	body	The body of the request.
string	parent	Required. The name of the PipelineJobs' parent resource. Format: projects/{project}/locations/{location}

Returns

Type	Description
ProjectsResource.LocationsResource.PipelineJobsResource.BatchCancelRequest

BatchDelete(GoogleCloudAiplatformV1beta1BatchDeletePipelineJobsRequest, string)

Batch deletes PipelineJobs The Operation is atomic. If it fails, none of the PipelineJobs are deleted. If it succeeds, all of the PipelineJobs are deleted.

Declaration

public virtual ProjectsResource.LocationsResource.PipelineJobsResource.BatchDeleteRequest BatchDelete(GoogleCloudAiplatformV1beta1BatchDeletePipelineJobsRequest body, string parent)

Parameters

Type	Name	Description
GoogleCloudAiplatformV1beta1BatchDeletePipelineJobsRequest	body	The body of the request.
string	parent	Required. The name of the PipelineJobs' parent resource. Format: projects/{project}/locations/{location}

Returns

Type	Description
ProjectsResource.LocationsResource.PipelineJobsResource.BatchDeleteRequest

Cancel(GoogleCloudAiplatformV1beta1CancelPipelineJobRequest, string)

Cancels a PipelineJob. Starts asynchronous cancellation on the PipelineJob. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetPipelineJob or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the PipelineJob is not deleted; instead it becomes a pipeline with a PipelineJob.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and PipelineJob.state is set to CANCELLED.

Declaration

public virtual ProjectsResource.LocationsResource.PipelineJobsResource.CancelRequest Cancel(GoogleCloudAiplatformV1beta1CancelPipelineJobRequest body, string name)

Parameters

Type	Name	Description
GoogleCloudAiplatformV1beta1CancelPipelineJobRequest	body	The body of the request.
string	name	Required. The name of the PipelineJob to cancel. Format: projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}

Returns

Type	Description
ProjectsResource.LocationsResource.PipelineJobsResource.CancelRequest

Create(GoogleCloudAiplatformV1beta1PipelineJob, string)

Creates a PipelineJob. A PipelineJob will run immediately when created.

Declaration

public virtual ProjectsResource.LocationsResource.PipelineJobsResource.CreateRequest Create(GoogleCloudAiplatformV1beta1PipelineJob body, string parent)

Parameters

Type	Name	Description
GoogleCloudAiplatformV1beta1PipelineJob	body	The body of the request.
string	parent	Required. The resource name of the Location to create the PipelineJob in. Format: projects/{project}/locations/{location}

Returns

Type	Description
ProjectsResource.LocationsResource.PipelineJobsResource.CreateRequest

Delete(string)

Deletes a PipelineJob.

Declaration

public virtual ProjectsResource.LocationsResource.PipelineJobsResource.DeleteRequest Delete(string name)

Parameters

Type	Name	Description
string	name	Required. The name of the PipelineJob resource to be deleted. Format: projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}

Returns

Type	Description
ProjectsResource.LocationsResource.PipelineJobsResource.DeleteRequest

Get(string)

Gets a PipelineJob.

Declaration

public virtual ProjectsResource.LocationsResource.PipelineJobsResource.GetRequest Get(string name)

Parameters

Type	Name	Description
string	name	Required. The name of the PipelineJob resource. Format: projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}

Returns

Type	Description
ProjectsResource.LocationsResource.PipelineJobsResource.GetRequest

List(string)

Lists PipelineJobs in a Location.

Declaration

public virtual ProjectsResource.LocationsResource.PipelineJobsResource.ListRequest List(string parent)

Parameters

Type	Name	Description
string	parent	Required. The resource name of the Location to list the PipelineJobs from. Format: projects/{project}/locations/{location}

Returns

Type	Description
ProjectsResource.LocationsResource.PipelineJobsResource.ListRequest