Show / Hide Table of Contents

Class ProjectsResource.LocationsResource.TrainingPipelinesResource

The "trainingPipelines" collection of methods.

Inheritance
object
ProjectsResource.LocationsResource.TrainingPipelinesResource
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.TrainingPipelinesResource

Constructors

TrainingPipelinesResource(IClientService)

Constructs a new resource.

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

Properties

Operations

Gets the Operations resource.

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

Methods

Cancel(GoogleCloudAiplatformV1beta1CancelTrainingPipelineRequest, string)

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

Declaration
public virtual ProjectsResource.LocationsResource.TrainingPipelinesResource.CancelRequest Cancel(GoogleCloudAiplatformV1beta1CancelTrainingPipelineRequest body, string name)
Parameters
Type Name Description
GoogleCloudAiplatformV1beta1CancelTrainingPipelineRequest body

The body of the request.

string name

Required. The name of the TrainingPipeline to cancel. Format: projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}

Returns
Type Description
ProjectsResource.LocationsResource.TrainingPipelinesResource.CancelRequest

Create(GoogleCloudAiplatformV1beta1TrainingPipeline, string)

Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.

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

The body of the request.

string parent

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

Returns
Type Description
ProjectsResource.LocationsResource.TrainingPipelinesResource.CreateRequest

Delete(string)

Deletes a TrainingPipeline.

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

Required. The name of the TrainingPipeline resource to be deleted. Format: projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}

Returns
Type Description
ProjectsResource.LocationsResource.TrainingPipelinesResource.DeleteRequest

Get(string)

Gets a TrainingPipeline.

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

Required. The name of the TrainingPipeline resource. Format: projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}

Returns
Type Description
ProjectsResource.LocationsResource.TrainingPipelinesResource.GetRequest

List(string)

Lists TrainingPipelines in a Location.

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

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

Returns
Type Description
ProjectsResource.LocationsResource.TrainingPipelinesResource.ListRequest
In this article
Back to top Generated by DocFX