- 3.10.0 (latest)
- 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 sealed class PipelineServiceClientImpl : PipelineServiceClientPipelineService client wrapper implementation, for convenient use.
Namespace
Google.Cloud.AIPlatform.V1Assembly
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(PipelineService.PipelineServiceClient, PipelineServiceSettings)
public PipelineServiceClientImpl(PipelineService.PipelineServiceClient grpcClient, PipelineServiceSettings settings)Constructs a client wrapper for the PipelineService service, with the specified gRPC client and settings.
| Parameters | |
|---|---|
| Name | Description |
grpcClient | PipelineService.PipelineServiceClientThe underlying gRPC client. |
settings | PipelineServiceSettingsThe base PipelineServiceSettings used within this client. |
Properties
DeletePipelineJobOperationsClient
public override OperationsClient DeletePipelineJobOperationsClient { get; }The long-running operations client for DeletePipelineJob.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
DeleteTrainingPipelineOperationsClient
public override OperationsClient DeleteTrainingPipelineOperationsClient { get; }The long-running operations client for DeleteTrainingPipeline.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
GrpcClient
public override PipelineService.PipelineServiceClient GrpcClient { get; }The underlying gRPC PipelineService client
| Property Value | |
|---|---|
| Type | Description |
PipelineService.PipelineServiceClient | |
Methods
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 | CancelPipelineJobRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
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 | CancelPipelineJobRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
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 | CancelTrainingPipelineRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
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 | CancelTrainingPipelineRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
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 | CreatePipelineJobRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PipelineJob | The RPC response. |
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 | CreatePipelineJobRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<PipelineJob> | A Task containing the RPC response. |
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 | CreateTrainingPipelineRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TrainingPipeline | The RPC response. |
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 | CreateTrainingPipelineRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<TrainingPipeline> | A Task containing the RPC response. |
DeletePipelineJob(DeletePipelineJobRequest, CallSettings)
public override Operation<Empty, DeleteOperationMetadata> DeletePipelineJob(DeletePipelineJobRequest request, CallSettings callSettings = null)Deletes a PipelineJob.
| Parameters | |
|---|---|
| Name | Description |
request | DeletePipelineJobRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Operation<Empty, DeleteOperationMetadata> | The RPC response. |
DeletePipelineJobAsync(DeletePipelineJobRequest, CallSettings)
public override Task<Operation<Empty, DeleteOperationMetadata>> DeletePipelineJobAsync(DeletePipelineJobRequest request, CallSettings callSettings = null)Deletes a PipelineJob.
| Parameters | |
|---|---|
| Name | Description |
request | DeletePipelineJobRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Operation<Empty, DeleteOperationMetadata>> | A Task containing the RPC response. |
DeleteTrainingPipeline(DeleteTrainingPipelineRequest, CallSettings)
public override Operation<Empty, DeleteOperationMetadata> DeleteTrainingPipeline(DeleteTrainingPipelineRequest request, CallSettings callSettings = null)Deletes a TrainingPipeline.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteTrainingPipelineRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Operation<Empty, DeleteOperationMetadata> | The RPC response. |
DeleteTrainingPipelineAsync(DeleteTrainingPipelineRequest, CallSettings)
public override Task<Operation<Empty, DeleteOperationMetadata>> DeleteTrainingPipelineAsync(DeleteTrainingPipelineRequest request, CallSettings callSettings = null)Deletes a TrainingPipeline.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteTrainingPipelineRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Operation<Empty, DeleteOperationMetadata>> | A Task containing the RPC response. |
GetPipelineJob(GetPipelineJobRequest, CallSettings)
public override PipelineJob GetPipelineJob(GetPipelineJobRequest request, CallSettings callSettings = null)Gets a PipelineJob.
| Parameters | |
|---|---|
| Name | Description |
request | GetPipelineJobRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PipelineJob | The RPC response. |
GetPipelineJobAsync(GetPipelineJobRequest, CallSettings)
public override Task<PipelineJob> GetPipelineJobAsync(GetPipelineJobRequest request, CallSettings callSettings = null)Gets a PipelineJob.
| Parameters | |
|---|---|
| Name | Description |
request | GetPipelineJobRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<PipelineJob> | A Task containing the RPC response. |
GetTrainingPipeline(GetTrainingPipelineRequest, CallSettings)
public override TrainingPipeline GetTrainingPipeline(GetTrainingPipelineRequest request, CallSettings callSettings = null)Gets a TrainingPipeline.
| Parameters | |
|---|---|
| Name | Description |
request | GetTrainingPipelineRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TrainingPipeline | The RPC response. |
GetTrainingPipelineAsync(GetTrainingPipelineRequest, CallSettings)
public override Task<TrainingPipeline> GetTrainingPipelineAsync(GetTrainingPipelineRequest request, CallSettings callSettings = null)Gets a TrainingPipeline.
| Parameters | |
|---|---|
| Name | Description |
request | GetTrainingPipelineRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<TrainingPipeline> | A Task containing the RPC response. |
ListPipelineJobs(ListPipelineJobsRequest, CallSettings)
public override PagedEnumerable<ListPipelineJobsResponse, PipelineJob> ListPipelineJobs(ListPipelineJobsRequest request, CallSettings callSettings = null)Lists PipelineJobs in a Location.
| Parameters | |
|---|---|
| Name | Description |
request | ListPipelineJobsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerable<ListPipelineJobsResponse, PipelineJob> | A pageable sequence of PipelineJob resources. |
ListPipelineJobsAsync(ListPipelineJobsRequest, CallSettings)
public override PagedAsyncEnumerable<ListPipelineJobsResponse, PipelineJob> ListPipelineJobsAsync(ListPipelineJobsRequest request, CallSettings callSettings = null)Lists PipelineJobs in a Location.
| Parameters | |
|---|---|
| Name | Description |
request | ListPipelineJobsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerable<ListPipelineJobsResponse, PipelineJob> | A pageable asynchronous sequence of PipelineJob resources. |
ListTrainingPipelines(ListTrainingPipelinesRequest, CallSettings)
public override PagedEnumerable<ListTrainingPipelinesResponse, TrainingPipeline> ListTrainingPipelines(ListTrainingPipelinesRequest request, CallSettings callSettings = null)Lists TrainingPipelines in a Location.
| Parameters | |
|---|---|
| Name | Description |
request | ListTrainingPipelinesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerable<ListTrainingPipelinesResponse, TrainingPipeline> | A pageable sequence of TrainingPipeline resources. |
ListTrainingPipelinesAsync(ListTrainingPipelinesRequest, CallSettings)
public override PagedAsyncEnumerable<ListTrainingPipelinesResponse, TrainingPipeline> ListTrainingPipelinesAsync(ListTrainingPipelinesRequest request, CallSettings callSettings = null)Lists TrainingPipelines in a Location.
| Parameters | |
|---|---|
| Name | Description |
request | ListTrainingPipelinesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerable<ListTrainingPipelinesResponse, TrainingPipeline> | A pageable asynchronous sequence of TrainingPipeline resources. |