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).
Equality
Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection>
objects compare equal. Objects that compare equal share the same underlying resources.
Performance
Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.
Thread Safety
Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.
Constructors
PipelineServiceClient(PipelineServiceClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
PipelineServiceClient const &
|
PipelineServiceClient(PipelineServiceClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
PipelineServiceClient &&
|
PipelineServiceClient(std::shared_ptr< PipelineServiceConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< PipelineServiceConnection >
|
opts |
Options
|
Operators
operator=(PipelineServiceClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
PipelineServiceClient const &
|
Returns | |
---|---|
Type | Description |
PipelineServiceClient & |
operator=(PipelineServiceClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
PipelineServiceClient &&
|
Returns | |
---|---|
Type | Description |
PipelineServiceClient & |
Functions
CreateTrainingPipeline(std::string const &, google::cloud::aiplatform::v1::TrainingPipeline const &, Options)
Creates a TrainingPipeline.
A created TrainingPipeline right away will be attempted to be run.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the Location to create the TrainingPipeline in. Format: |
training_pipeline |
google::cloud::aiplatform::v1::TrainingPipeline const &
Required. The TrainingPipeline to create. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::TrainingPipeline > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.TrainingPipeline) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateTrainingPipeline(google::cloud::aiplatform::v1::CreateTrainingPipelineRequest const &, Options)
Creates a TrainingPipeline.
A created TrainingPipeline right away will be attempted to be run.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::CreateTrainingPipelineRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::TrainingPipeline > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.TrainingPipeline) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetTrainingPipeline(std::string const &, Options)
Gets a TrainingPipeline.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the TrainingPipeline resource. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::TrainingPipeline > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.TrainingPipeline) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetTrainingPipeline(google::cloud::aiplatform::v1::GetTrainingPipelineRequest const &, Options)
Gets a TrainingPipeline.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::GetTrainingPipelineRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::TrainingPipeline > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.TrainingPipeline) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListTrainingPipelines(std::string const &, Options)
Lists TrainingPipelines in a Location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the Location to list the TrainingPipelines from. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::aiplatform::v1::TrainingPipeline > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListTrainingPipelines(google::cloud::aiplatform::v1::ListTrainingPipelinesRequest, Options)
Lists TrainingPipelines in a Location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::ListTrainingPipelinesRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::aiplatform::v1::TrainingPipeline > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
DeleteTrainingPipeline(std::string const &, Options)
Deletes a TrainingPipeline.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the TrainingPipeline resource to be deleted. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > > |
A |
DeleteTrainingPipeline(google::cloud::aiplatform::v1::DeleteTrainingPipelineRequest const &, Options)
Deletes a TrainingPipeline.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::DeleteTrainingPipelineRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > > |
A |
CancelTrainingPipeline(std::string const &, Options)
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
.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the TrainingPipeline to cancel. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
CancelTrainingPipeline(google::cloud::aiplatform::v1::CancelTrainingPipelineRequest const &, Options)
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
.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::CancelTrainingPipelineRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
CreatePipelineJob(std::string const &, google::cloud::aiplatform::v1::PipelineJob const &, std::string const &, Options)
Creates a PipelineJob.
A PipelineJob will run immediately when created.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the Location to create the PipelineJob in. Format: |
pipeline_job |
google::cloud::aiplatform::v1::PipelineJob const &
Required. The PipelineJob to create. |
pipeline_job_id |
std::string const &
The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::PipelineJob > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.PipelineJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreatePipelineJob(google::cloud::aiplatform::v1::CreatePipelineJobRequest const &, Options)
Creates a PipelineJob.
A PipelineJob will run immediately when created.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::CreatePipelineJobRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::PipelineJob > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.PipelineJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetPipelineJob(std::string const &, Options)
Gets a PipelineJob.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the PipelineJob resource. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::PipelineJob > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.PipelineJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetPipelineJob(google::cloud::aiplatform::v1::GetPipelineJobRequest const &, Options)
Gets a PipelineJob.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::GetPipelineJobRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::PipelineJob > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.PipelineJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListPipelineJobs(std::string const &, Options)
Lists PipelineJobs in a Location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the Location to list the PipelineJobs from. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::aiplatform::v1::PipelineJob > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListPipelineJobs(google::cloud::aiplatform::v1::ListPipelineJobsRequest, Options)
Lists PipelineJobs in a Location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::ListPipelineJobsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::aiplatform::v1::PipelineJob > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
DeletePipelineJob(std::string const &, Options)
Deletes a PipelineJob.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the PipelineJob resource to be deleted. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > > |
A |
DeletePipelineJob(google::cloud::aiplatform::v1::DeletePipelineJobRequest const &, Options)
Deletes a PipelineJob.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::DeletePipelineJobRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > > |
A |
CancelPipelineJob(std::string const &, Options)
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
.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the PipelineJob to cancel. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
CancelPipelineJob(google::cloud::aiplatform::v1::CancelPipelineJobRequest const &, Options)
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
.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::CancelPipelineJobRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |