Class PipelineServiceClient (2.23.0-rc)

Version latest

• 2.25.0-rc (latest)
• 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.1
• 2.14.0
• 2.13.0
• 2.12.0

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: projects/{project}/locations/{location}
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.CreateTrainingPipelineRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

GetTrainingPipeline(std::string const &, Options)

Gets a TrainingPipeline.

Parameters
Name	Description
name	std::string const & Required. The name of the TrainingPipeline resource. Format: projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.GetTrainingPipelineRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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: projects/{project}/locations/{location}
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.aiplatform.v1.TrainingPipeline, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.ListTrainingPipelinesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.aiplatform.v1.TrainingPipeline, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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: projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}
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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.DeleteOperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.DeleteTrainingPipelineRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.DeleteOperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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: projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
Status	a Status object. If the request failed, the status contains the details of the failure.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.CancelTrainingPipelineRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
Status	a Status object. If the request failed, the status contains the details of the failure.

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: projects/{project}/locations/{location}
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. This value should be less than 128 characters, and valid characters are /[a-z][0-9]-/.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.CreatePipelineJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

GetPipelineJob(std::string const &, Options)

Gets a PipelineJob.

Parameters
Name	Description
name	std::string const & Required. The name of the PipelineJob resource. Format: projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.GetPipelineJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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: projects/{project}/locations/{location}
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.aiplatform.v1.PipelineJob, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.ListPipelineJobsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.aiplatform.v1.PipelineJob, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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: projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}
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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.DeleteOperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.DeletePipelineJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.DeleteOperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

BatchDeletePipelineJobs(std::string const &, std::vector< std::string > const &, Options)

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
parent	std::string const & Required. The name of the PipelineJobs' parent resource. Format: projects/{project}/locations/{location}
names	std::vector< std::string > const & Required. The names of the PipelineJobs to delete. A maximum of 32 PipelineJobs can be deleted in a batch. Format: projects/{project}/locations/{location}/pipelineJobs/{pipelineJob}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::aiplatform::v1::BatchDeletePipelineJobsResponse > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.BatchDeletePipelineJobsResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

BatchDeletePipelineJobs(google::cloud::aiplatform::v1::BatchDeletePipelineJobsRequest const &, Options)

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	google::cloud::aiplatform::v1::BatchDeletePipelineJobsRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.BatchDeletePipelineJobsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::aiplatform::v1::BatchDeletePipelineJobsResponse > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.BatchDeletePipelineJobsResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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: projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
Status	a Status object. If the request failed, the status contains the details of the failure.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.CancelPipelineJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
Status	a Status object. If the request failed, the status contains the details of the failure.

BatchCancelPipelineJobs(std::string const &, std::vector< std::string > const &, Options)

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
parent	std::string const & Required. The name of the PipelineJobs' parent resource. Format: projects/{project}/locations/{location}
names	std::vector< std::string > const & Required. The names of the PipelineJobs to cancel. A maximum of 32 PipelineJobs can be cancelled in a batch. Format: projects/{project}/locations/{location}/pipelineJobs/{pipelineJob}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::aiplatform::v1::BatchCancelPipelineJobsResponse > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.BatchCancelPipelineJobsResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

BatchCancelPipelineJobs(google::cloud::aiplatform::v1::BatchCancelPipelineJobsRequest const &, Options)

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	google::cloud::aiplatform::v1::BatchCancelPipelineJobsRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.BatchCancelPipelineJobsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::aiplatform::v1::BatchCancelPipelineJobsResponse > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.BatchCancelPipelineJobsResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.