Cloud AI Platform v1 API - Class PipelineServiceClientImpl (2.27.0) 

public sealed class PipelineServiceClientImpl : PipelineServiceClient

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

PipelineService client wrapper implementation, for convenient use.

Inheritance

object > PipelineServiceClient > PipelineServiceClientImpl

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Remarks

A service for creating and managing Vertex AI's pipelines. This includes both TrainingPipeline resources (used for AutoML and custom training) and PipelineJob resources (used for Vertex AI Pipelines).

Constructors

PipelineServiceClientImpl(PipelineServiceClient, PipelineServiceSettings, ILogger)

public PipelineServiceClientImpl(PipelineService.PipelineServiceClient grpcClient, PipelineServiceSettings settings, ILogger logger)

Constructs a client wrapper for the PipelineService service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient PipelineServicePipelineServiceClient

The underlying gRPC client.
settings PipelineServiceSettings

The base PipelineServiceSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

BatchCancelPipelineJobsOperationsClient

public override OperationsClient BatchCancelPipelineJobsOperationsClient { get; }

The long-running operations client for BatchCancelPipelineJobs.

Property Value
Type Description
OperationsClient
Overrides

BatchDeletePipelineJobsOperationsClient

public override OperationsClient BatchDeletePipelineJobsOperationsClient { get; }

The long-running operations client for BatchDeletePipelineJobs.

Property Value
Type Description
OperationsClient
Overrides

DeletePipelineJobOperationsClient

public override OperationsClient DeletePipelineJobOperationsClient { get; }

The long-running operations client for DeletePipelineJob.

Property Value
Type Description
OperationsClient
Overrides

DeleteTrainingPipelineOperationsClient

public override OperationsClient DeleteTrainingPipelineOperationsClient { get; }

The long-running operations client for DeleteTrainingPipeline.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override PipelineService.PipelineServiceClient GrpcClient { get; }

The underlying gRPC PipelineService client

Property Value
Type Description
PipelineServicePipelineServiceClient
Overrides

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type Description
IAMPolicyClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

Methods

BatchCancelPipelineJobs(BatchCancelPipelineJobsRequest, CallSettings)

public override Operation<BatchCancelPipelineJobsResponse, BatchCancelPipelineJobsOperationMetadata> BatchCancelPipelineJobs(BatchCancelPipelineJobsRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request BatchCancelPipelineJobsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationBatchCancelPipelineJobsResponseBatchCancelPipelineJobsOperationMetadata

The RPC response.
Overrides

BatchCancelPipelineJobsAsync(BatchCancelPipelineJobsRequest, CallSettings)

public override Task<Operation<BatchCancelPipelineJobsResponse, BatchCancelPipelineJobsOperationMetadata>> BatchCancelPipelineJobsAsync(BatchCancelPipelineJobsRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request BatchCancelPipelineJobsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationBatchCancelPipelineJobsResponseBatchCancelPipelineJobsOperationMetadata

A Task containing the RPC response.
Overrides

BatchDeletePipelineJobs(BatchDeletePipelineJobsRequest, CallSettings)

public override Operation<BatchDeletePipelineJobsResponse, DeleteOperationMetadata> BatchDeletePipelineJobs(BatchDeletePipelineJobsRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request BatchDeletePipelineJobsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationBatchDeletePipelineJobsResponseDeleteOperationMetadata

The RPC response.
Overrides

BatchDeletePipelineJobsAsync(BatchDeletePipelineJobsRequest, CallSettings)

public override Task<Operation<BatchDeletePipelineJobsResponse, DeleteOperationMetadata>> BatchDeletePipelineJobsAsync(BatchDeletePipelineJobsRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request BatchDeletePipelineJobsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationBatchDeletePipelineJobsResponseDeleteOperationMetadata

A Task containing the RPC response.
Overrides

CancelPipelineJob(CancelPipelineJobRequest, CallSettings)

public override void CancelPipelineJob(CancelPipelineJobRequest request, CallSettings callSettings = null)

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][google.cloud.aiplatform.v1.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][google.cloud.aiplatform.v1.PipelineJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to Code.CANCELLED, and [PipelineJob.state][google.cloud.aiplatform.v1.PipelineJob.state] is set to CANCELLED.

Parameters
Name Description
request CancelPipelineJobRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

CancelPipelineJobAsync(CancelPipelineJobRequest, CallSettings)

public override Task CancelPipelineJobAsync(CancelPipelineJobRequest request, CallSettings callSettings = null)

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][google.cloud.aiplatform.v1.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][google.cloud.aiplatform.v1.PipelineJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to Code.CANCELLED, and [PipelineJob.state][google.cloud.aiplatform.v1.PipelineJob.state] is set to CANCELLED.

Parameters
Name Description
request CancelPipelineJobRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

CancelTrainingPipeline(CancelTrainingPipelineRequest, CallSettings)

public override void CancelTrainingPipeline(CancelTrainingPipelineRequest request, CallSettings callSettings = null)

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][google.cloud.aiplatform.v1.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][google.cloud.aiplatform.v1.TrainingPipeline.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to Code.CANCELLED, and [TrainingPipeline.state][google.cloud.aiplatform.v1.TrainingPipeline.state] is set to CANCELLED.

Parameters
Name Description
request CancelTrainingPipelineRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

CancelTrainingPipelineAsync(CancelTrainingPipelineRequest, CallSettings)

public override Task CancelTrainingPipelineAsync(CancelTrainingPipelineRequest request, CallSettings callSettings = null)

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][google.cloud.aiplatform.v1.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][google.cloud.aiplatform.v1.TrainingPipeline.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to Code.CANCELLED, and [TrainingPipeline.state][google.cloud.aiplatform.v1.TrainingPipeline.state] is set to CANCELLED.

Parameters
Name Description
request CancelTrainingPipelineRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

CreatePipelineJob(CreatePipelineJobRequest, CallSettings)

public override PipelineJob CreatePipelineJob(CreatePipelineJobRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request CreatePipelineJobRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PipelineJob

The RPC response.
Overrides

CreatePipelineJobAsync(CreatePipelineJobRequest, CallSettings)

public override Task<PipelineJob> CreatePipelineJobAsync(CreatePipelineJobRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request CreatePipelineJobRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskPipelineJob

A Task containing the RPC response.
Overrides

CreateTrainingPipeline(CreateTrainingPipelineRequest, CallSettings)

public override TrainingPipeline CreateTrainingPipeline(CreateTrainingPipelineRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request CreateTrainingPipelineRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TrainingPipeline

The RPC response.
Overrides

CreateTrainingPipelineAsync(CreateTrainingPipelineRequest, CallSettings)

public override Task<TrainingPipeline> CreateTrainingPipelineAsync(CreateTrainingPipelineRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request CreateTrainingPipelineRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskTrainingPipeline

A Task containing the RPC response.
Overrides

DeletePipelineJob(DeletePipelineJobRequest, CallSettings)

public override Operation<Empty, DeleteOperationMetadata> DeletePipelineJob(DeletePipelineJobRequest request, CallSettings callSettings = null)

Deletes a PipelineJob.

Parameters
Name Description
request DeletePipelineJobRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyDeleteOperationMetadata

The RPC response.
Overrides

DeletePipelineJobAsync(DeletePipelineJobRequest, CallSettings)

public override Task<Operation<Empty, DeleteOperationMetadata>> DeletePipelineJobAsync(DeletePipelineJobRequest request, CallSettings callSettings = null)

Deletes a PipelineJob.

Parameters
Name Description
request DeletePipelineJobRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.
Overrides

DeleteTrainingPipeline(DeleteTrainingPipelineRequest, CallSettings)

public override Operation<Empty, DeleteOperationMetadata> DeleteTrainingPipeline(DeleteTrainingPipelineRequest request, CallSettings callSettings = null)

Deletes a TrainingPipeline.

Parameters
Name Description
request DeleteTrainingPipelineRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyDeleteOperationMetadata

The RPC response.
Overrides

DeleteTrainingPipelineAsync(DeleteTrainingPipelineRequest, CallSettings)

public override Task<Operation<Empty, DeleteOperationMetadata>> DeleteTrainingPipelineAsync(DeleteTrainingPipelineRequest request, CallSettings callSettings = null)

Deletes a TrainingPipeline.

Parameters
Name Description
request DeleteTrainingPipelineRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.
Overrides

GetPipelineJob(GetPipelineJobRequest, CallSettings)

public override PipelineJob GetPipelineJob(GetPipelineJobRequest request, CallSettings callSettings = null)

Gets a PipelineJob.

Parameters
Name Description
request GetPipelineJobRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PipelineJob

The RPC response.
Overrides

GetPipelineJobAsync(GetPipelineJobRequest, CallSettings)

public override Task<PipelineJob> GetPipelineJobAsync(GetPipelineJobRequest request, CallSettings callSettings = null)

Gets a PipelineJob.

Parameters
Name Description
request GetPipelineJobRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskPipelineJob

A Task containing the RPC response.
Overrides

GetTrainingPipeline(GetTrainingPipelineRequest, CallSettings)

public override TrainingPipeline GetTrainingPipeline(GetTrainingPipelineRequest request, CallSettings callSettings = null)

Gets a TrainingPipeline.

Parameters
Name Description
request GetTrainingPipelineRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TrainingPipeline

The RPC response.
Overrides

GetTrainingPipelineAsync(GetTrainingPipelineRequest, CallSettings)

public override Task<TrainingPipeline> GetTrainingPipelineAsync(GetTrainingPipelineRequest request, CallSettings callSettings = null)

Gets a TrainingPipeline.

Parameters
Name Description
request GetTrainingPipelineRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskTrainingPipeline

A Task containing the RPC response.
Overrides

ListPipelineJobs(ListPipelineJobsRequest, CallSettings)

public override PagedEnumerable<ListPipelineJobsResponse, PipelineJob> ListPipelineJobs(ListPipelineJobsRequest request, CallSettings callSettings = null)

Lists PipelineJobs in a Location.

Parameters
Name Description
request ListPipelineJobsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListPipelineJobsResponsePipelineJob

A pageable sequence of PipelineJob resources.
Overrides

ListPipelineJobsAsync(ListPipelineJobsRequest, CallSettings)

public override PagedAsyncEnumerable<ListPipelineJobsResponse, PipelineJob> ListPipelineJobsAsync(ListPipelineJobsRequest request, CallSettings callSettings = null)

Lists PipelineJobs in a Location.

Parameters
Name Description
request ListPipelineJobsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListPipelineJobsResponsePipelineJob

A pageable asynchronous sequence of PipelineJob resources.
Overrides

ListTrainingPipelines(ListTrainingPipelinesRequest, CallSettings)

public override PagedEnumerable<ListTrainingPipelinesResponse, TrainingPipeline> ListTrainingPipelines(ListTrainingPipelinesRequest request, CallSettings callSettings = null)

Lists TrainingPipelines in a Location.

Parameters
Name Description
request ListTrainingPipelinesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListTrainingPipelinesResponseTrainingPipeline

A pageable sequence of TrainingPipeline resources.
Overrides

ListTrainingPipelinesAsync(ListTrainingPipelinesRequest, CallSettings)

public override PagedAsyncEnumerable<ListTrainingPipelinesResponse, TrainingPipeline> ListTrainingPipelinesAsync(ListTrainingPipelinesRequest request, CallSettings callSettings = null)

Lists TrainingPipelines in a Location.

Parameters
Name Description
request ListTrainingPipelinesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListTrainingPipelinesResponseTrainingPipeline

A pageable asynchronous sequence of TrainingPipeline resources.
Overrides