Class DatasetServiceClient (2.26.0-rc)

Version latest

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

The service that manages Vertex AI Dataset and its child resources.

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

DatasetServiceClient(DatasetServiceClient const &)

Copy and move support

Parameter
Name	Description
	DatasetServiceClient const &

DatasetServiceClient(DatasetServiceClient &&)

Copy and move support

Parameter
Name	Description
	DatasetServiceClient &&

DatasetServiceClient(std::shared_ptr< DatasetServiceConnection >, Options)

Parameters
Name	Description
connection	std::shared_ptr< DatasetServiceConnection >
opts	Options

Operators

operator=(DatasetServiceClient const &)

Copy and move support

Parameter
Name	Description
	DatasetServiceClient const &

Returns
Type	Description
DatasetServiceClient &

operator=(DatasetServiceClient &&)

Copy and move support

Parameter
Name	Description
	DatasetServiceClient &&

Returns
Type	Description
DatasetServiceClient &

Functions

CreateDataset(std::string const &, google::cloud::aiplatform::v1::Dataset const &, Options)

Creates a Dataset.

Parameters
Name	Description
parent	std::string const & Required. The resource name of the Location to create the Dataset in. Format: projects/{project}/locations/{location}
dataset	google::cloud::aiplatform::v1::Dataset const & Required. The Dataset to create.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::aiplatform::v1::Dataset > >	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.Dataset proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateDataset(ExperimentalTag, NoAwaitTag, std::string const &, google::cloud::aiplatform::v1::Dataset const &, Options)

Parameters
Name	Description
	ExperimentalTag
	NoAwaitTag
parent	std::string const &
dataset	google::cloud::aiplatform::v1::Dataset const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

CreateDataset(google::cloud::aiplatform::v1::CreateDatasetRequest const &, Options)

Creates a Dataset.

Parameters
Name	Description
request	google::cloud::aiplatform::v1::CreateDatasetRequest 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.CreateDatasetRequest. 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::Dataset > >	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.Dataset proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateDataset(ExperimentalTag, NoAwaitTag, google::cloud::aiplatform::v1::CreateDatasetRequest const &, Options)

Parameters
Name	Description
	ExperimentalTag
	NoAwaitTag
request	google::cloud::aiplatform::v1::CreateDatasetRequest const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

CreateDataset(ExperimentalTag, google::longrunning::Operation const &, Options)

Parameters
Name	Description
	ExperimentalTag
operation	google::longrunning::Operation const &
opts	Options

Returns
Type	Description
future< StatusOr< google::cloud::aiplatform::v1::Dataset > >

GetDataset(std::string const &, Options)

Gets a Dataset.

Parameters
Name	Description
name	std::string const & Required. The name of the Dataset resource.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::aiplatform::v1::Dataset >	the result of the RPC. The response message type (google.cloud.aiplatform.v1.Dataset) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetDataset(google::cloud::aiplatform::v1::GetDatasetRequest const &, Options)

Gets a Dataset.

Parameters
Name	Description
request	google::cloud::aiplatform::v1::GetDatasetRequest 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.GetDatasetRequest. 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::Dataset >	the result of the RPC. The response message type (google.cloud.aiplatform.v1.Dataset) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateDataset(google::cloud::aiplatform::v1::Dataset const &, google::protobuf::FieldMask const &, Options)

Updates a Dataset.

Parameters
Name	Description
dataset	google::cloud::aiplatform::v1::Dataset const & Required. The Dataset which replaces the resource on the server.
update_mask	google::protobuf::FieldMask const & Required. The update mask applies to the resource. For the FieldMask definition, see google.protobuf.FieldMask. Updatable fields: display_name description labels
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::aiplatform::v1::Dataset >	the result of the RPC. The response message type (google.cloud.aiplatform.v1.Dataset) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateDataset(google::cloud::aiplatform::v1::UpdateDatasetRequest const &, Options)

Updates a Dataset.

Parameters
Name	Description
request	google::cloud::aiplatform::v1::UpdateDatasetRequest 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.UpdateDatasetRequest. 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::Dataset >	the result of the RPC. The response message type (google.cloud.aiplatform.v1.Dataset) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListDatasets(std::string const &, Options)

Lists Datasets in a Location.

Parameters
Name	Description
parent	std::string const & Required. The name of the Dataset's parent resource. 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::Dataset >	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.Dataset, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListDatasets(google::cloud::aiplatform::v1::ListDatasetsRequest, Options)

Lists Datasets in a Location.

Parameters
Name	Description
request	google::cloud::aiplatform::v1::ListDatasetsRequest 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.ListDatasetsRequest. 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::Dataset >	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.Dataset, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

DeleteDataset(std::string const &, Options)

Deletes a Dataset.

Parameters
Name	Description
name	std::string const & Required. The resource name of the Dataset to delete. Format: projects/{project}/locations/{location}/datasets/{dataset}
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.

DeleteDataset(ExperimentalTag, NoAwaitTag, std::string const &, Options)

Parameters
Name	Description
	ExperimentalTag
	NoAwaitTag
name	std::string const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

DeleteDataset(google::cloud::aiplatform::v1::DeleteDatasetRequest const &, Options)

Deletes a Dataset.

Parameters
Name	Description
request	google::cloud::aiplatform::v1::DeleteDatasetRequest 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.DeleteDatasetRequest. 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.

DeleteDataset(ExperimentalTag, NoAwaitTag, google::cloud::aiplatform::v1::DeleteDatasetRequest const &, Options)

Parameters
Name	Description
	ExperimentalTag
	NoAwaitTag
request	google::cloud::aiplatform::v1::DeleteDatasetRequest const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

DeleteDataset(ExperimentalTag, google::longrunning::Operation const &, Options)

Parameters
Name	Description
	ExperimentalTag
operation	google::longrunning::Operation const &
opts	Options

Returns
Type	Description
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > >

ImportData(std::string const &, std::vector< google::cloud::aiplatform::v1::ImportDataConfig > const &, Options)

Imports data into a Dataset.

Parameters
Name	Description
name	std::string const & Required. The name of the Dataset resource. Format: projects/{project}/locations/{location}/datasets/{dataset}
import_configs	std::vector< google::cloud::aiplatform::v1::ImportDataConfig > const & Required. The desired input locations. The contents of all input locations will be imported in one batch.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::aiplatform::v1::ImportDataResponse > >	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.ImportDataResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ImportData(ExperimentalTag, NoAwaitTag, std::string const &, std::vector< google::cloud::aiplatform::v1::ImportDataConfig > const &, Options)

Parameters
Name	Description
	ExperimentalTag
	NoAwaitTag
name	std::string const &
import_configs	std::vector< google::cloud::aiplatform::v1::ImportDataConfig > const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

ImportData(google::cloud::aiplatform::v1::ImportDataRequest const &, Options)

Imports data into a Dataset.

Parameters
Name	Description
request	google::cloud::aiplatform::v1::ImportDataRequest 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.ImportDataRequest. 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::ImportDataResponse > >	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.ImportDataResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ImportData(ExperimentalTag, NoAwaitTag, google::cloud::aiplatform::v1::ImportDataRequest const &, Options)

Parameters
Name	Description
	ExperimentalTag
	NoAwaitTag
request	google::cloud::aiplatform::v1::ImportDataRequest const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

ImportData(ExperimentalTag, google::longrunning::Operation const &, Options)

Parameters
Name	Description
	ExperimentalTag
operation	google::longrunning::Operation const &
opts	Options

Returns
Type	Description
future< StatusOr< google::cloud::aiplatform::v1::ImportDataResponse > >

ExportData(std::string const &, google::cloud::aiplatform::v1::ExportDataConfig const &, Options)

Exports data from a Dataset.

Parameters
Name	Description
name	std::string const & Required. The name of the Dataset resource. Format: projects/{project}/locations/{location}/datasets/{dataset}
export_config	google::cloud::aiplatform::v1::ExportDataConfig const & Required. The desired output location.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::aiplatform::v1::ExportDataResponse > >	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.ExportDataResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ExportData(ExperimentalTag, NoAwaitTag, std::string const &, google::cloud::aiplatform::v1::ExportDataConfig const &, Options)

Parameters
Name	Description
	ExperimentalTag
	NoAwaitTag
name	std::string const &
export_config	google::cloud::aiplatform::v1::ExportDataConfig const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

ExportData(google::cloud::aiplatform::v1::ExportDataRequest const &, Options)

Exports data from a Dataset.

Parameters
Name	Description
request	google::cloud::aiplatform::v1::ExportDataRequest 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.ExportDataRequest. 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::ExportDataResponse > >	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.ExportDataResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ExportData(ExperimentalTag, NoAwaitTag, google::cloud::aiplatform::v1::ExportDataRequest const &, Options)

Parameters
Name	Description
	ExperimentalTag
	NoAwaitTag
request	google::cloud::aiplatform::v1::ExportDataRequest const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

ExportData(ExperimentalTag, google::longrunning::Operation const &, Options)

Parameters
Name	Description
	ExperimentalTag
operation	google::longrunning::Operation const &
opts	Options

Returns
Type	Description
future< StatusOr< google::cloud::aiplatform::v1::ExportDataResponse > >

CreateDatasetVersion(std::string const &, google::cloud::aiplatform::v1::DatasetVersion const &, Options)

Create a version from a Dataset.

Parameters
Name	Description
parent	std::string const & Required. The name of the Dataset resource. Format: projects/{project}/locations/{location}/datasets/{dataset}
dataset_version	google::cloud::aiplatform::v1::DatasetVersion const & Required. The version to be created. The same CMEK policies with the original Dataset will be applied the dataset version. So here we don't need to specify the EncryptionSpecType here.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::aiplatform::v1::DatasetVersion > >	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.DatasetVersion proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateDatasetVersion(ExperimentalTag, NoAwaitTag, std::string const &, google::cloud::aiplatform::v1::DatasetVersion const &, Options)

Parameters
Name	Description
	ExperimentalTag
	NoAwaitTag
parent	std::string const &
dataset_version	google::cloud::aiplatform::v1::DatasetVersion const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

CreateDatasetVersion(google::cloud::aiplatform::v1::CreateDatasetVersionRequest const &, Options)

Create a version from a Dataset.

Parameters
Name	Description
request	google::cloud::aiplatform::v1::CreateDatasetVersionRequest 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.CreateDatasetVersionRequest. 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::DatasetVersion > >	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.DatasetVersion proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateDatasetVersion(ExperimentalTag, NoAwaitTag, google::cloud::aiplatform::v1::CreateDatasetVersionRequest const &, Options)

Parameters
Name	Description
	ExperimentalTag
	NoAwaitTag
request	google::cloud::aiplatform::v1::CreateDatasetVersionRequest const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

CreateDatasetVersion(ExperimentalTag, google::longrunning::Operation const &, Options)

Parameters
Name	Description
	ExperimentalTag
operation	google::longrunning::Operation const &
opts	Options

Returns
Type	Description
future< StatusOr< google::cloud::aiplatform::v1::DatasetVersion > >

UpdateDatasetVersion(google::cloud::aiplatform::v1::DatasetVersion const &, google::protobuf::FieldMask const &, Options)

Updates a DatasetVersion.

Parameters
Name	Description
dataset_version	google::cloud::aiplatform::v1::DatasetVersion const & Required. The DatasetVersion which replaces the resource on the server.
update_mask	google::protobuf::FieldMask const & Required. The update mask applies to the resource. For the FieldMask definition, see google.protobuf.FieldMask. Updatable fields: display_name
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::aiplatform::v1::DatasetVersion >	the result of the RPC. The response message type (google.cloud.aiplatform.v1.DatasetVersion) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateDatasetVersion(google::cloud::aiplatform::v1::UpdateDatasetVersionRequest const &, Options)

Updates a DatasetVersion.

Parameters
Name	Description
request	google::cloud::aiplatform::v1::UpdateDatasetVersionRequest 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.UpdateDatasetVersionRequest. 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::DatasetVersion >	the result of the RPC. The response message type (google.cloud.aiplatform.v1.DatasetVersion) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteDatasetVersion(std::string const &, Options)

Deletes a Dataset version.

Parameters
Name	Description
name	std::string const & Required. The resource name of the Dataset version to delete. Format: projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}
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.

DeleteDatasetVersion(ExperimentalTag, NoAwaitTag, std::string const &, Options)

Parameters
Name	Description
	ExperimentalTag
	NoAwaitTag
name	std::string const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

DeleteDatasetVersion(google::cloud::aiplatform::v1::DeleteDatasetVersionRequest const &, Options)

Deletes a Dataset version.

Parameters
Name	Description
request	google::cloud::aiplatform::v1::DeleteDatasetVersionRequest 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.DeleteDatasetVersionRequest. 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.

DeleteDatasetVersion(ExperimentalTag, NoAwaitTag, google::cloud::aiplatform::v1::DeleteDatasetVersionRequest const &, Options)

Parameters
Name	Description
	ExperimentalTag
	NoAwaitTag
request	google::cloud::aiplatform::v1::DeleteDatasetVersionRequest const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

DeleteDatasetVersion(ExperimentalTag, google::longrunning::Operation const &, Options)

Parameters
Name	Description
	ExperimentalTag
operation	google::longrunning::Operation const &
opts	Options

Returns
Type	Description
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > >

GetDatasetVersion(std::string const &, Options)

Gets a Dataset version.

Parameters
Name	Description
name	std::string const & Required. The resource name of the Dataset version to delete. Format: projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::aiplatform::v1::DatasetVersion >	the result of the RPC. The response message type (google.cloud.aiplatform.v1.DatasetVersion) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetDatasetVersion(google::cloud::aiplatform::v1::GetDatasetVersionRequest const &, Options)

Gets a Dataset version.

Parameters
Name	Description
request	google::cloud::aiplatform::v1::GetDatasetVersionRequest 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.GetDatasetVersionRequest. 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::DatasetVersion >	the result of the RPC. The response message type (google.cloud.aiplatform.v1.DatasetVersion) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListDatasetVersions(std::string const &, Options)

Lists DatasetVersions in a Dataset.

Parameters
Name	Description
parent	std::string const & Required. The resource name of the Dataset to list DatasetVersions from. Format: projects/{project}/locations/{location}/datasets/{dataset}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::aiplatform::v1::DatasetVersion >	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.DatasetVersion, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListDatasetVersions(google::cloud::aiplatform::v1::ListDatasetVersionsRequest, Options)

Lists DatasetVersions in a Dataset.

Parameters
Name	Description
request	google::cloud::aiplatform::v1::ListDatasetVersionsRequest 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.ListDatasetVersionsRequest. 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::DatasetVersion >	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.DatasetVersion, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

RestoreDatasetVersion(std::string const &, Options)

Restores a dataset version.

Parameters
Name	Description
name	std::string const & Required. The name of the DatasetVersion resource. Format: projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::aiplatform::v1::DatasetVersion > >	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.DatasetVersion proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

RestoreDatasetVersion(ExperimentalTag, NoAwaitTag, std::string const &, Options)

Parameters
Name	Description
	ExperimentalTag
	NoAwaitTag
name	std::string const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

RestoreDatasetVersion(google::cloud::aiplatform::v1::RestoreDatasetVersionRequest const &, Options)

Restores a dataset version.

Parameters
Name	Description
request	google::cloud::aiplatform::v1::RestoreDatasetVersionRequest 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.RestoreDatasetVersionRequest. 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::DatasetVersion > >	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.DatasetVersion proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

RestoreDatasetVersion(ExperimentalTag, NoAwaitTag, google::cloud::aiplatform::v1::RestoreDatasetVersionRequest const &, Options)

Parameters
Name	Description
	ExperimentalTag
	NoAwaitTag
request	google::cloud::aiplatform::v1::RestoreDatasetVersionRequest const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

RestoreDatasetVersion(ExperimentalTag, google::longrunning::Operation const &, Options)

Parameters
Name	Description
	ExperimentalTag
operation	google::longrunning::Operation const &
opts	Options

Returns
Type	Description
future< StatusOr< google::cloud::aiplatform::v1::DatasetVersion > >

ListDataItems(std::string const &, Options)

Lists DataItems in a Dataset.

Parameters
Name	Description
parent	std::string const & Required. The resource name of the Dataset to list DataItems from. Format: projects/{project}/locations/{location}/datasets/{dataset}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::aiplatform::v1::DataItem >	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.DataItem, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListDataItems(google::cloud::aiplatform::v1::ListDataItemsRequest, Options)

Lists DataItems in a Dataset.

Parameters
Name	Description
request	google::cloud::aiplatform::v1::ListDataItemsRequest 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.ListDataItemsRequest. 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::DataItem >	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.DataItem, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

SearchDataItems(google::cloud::aiplatform::v1::SearchDataItemsRequest, Options)

Searches DataItems in a Dataset.

Parameters
Name	Description
request	google::cloud::aiplatform::v1::SearchDataItemsRequest 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.SearchDataItemsRequest. 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::DataItemView >	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.DataItemView, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListSavedQueries(std::string const &, Options)

Lists SavedQueries in a Dataset.

Parameters
Name	Description
parent	std::string const & Required. The resource name of the Dataset to list SavedQueries from. Format: projects/{project}/locations/{location}/datasets/{dataset}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::aiplatform::v1::SavedQuery >	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.SavedQuery, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListSavedQueries(google::cloud::aiplatform::v1::ListSavedQueriesRequest, Options)

Lists SavedQueries in a Dataset.

Parameters
Name	Description
request	google::cloud::aiplatform::v1::ListSavedQueriesRequest 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.ListSavedQueriesRequest. 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::SavedQuery >	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.SavedQuery, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

DeleteSavedQuery(std::string const &, Options)

Deletes a SavedQuery.

Parameters
Name	Description
name	std::string const & Required. The resource name of the SavedQuery to delete. Format: projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}
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.

DeleteSavedQuery(ExperimentalTag, NoAwaitTag, std::string const &, Options)

Parameters
Name	Description
	ExperimentalTag
	NoAwaitTag
name	std::string const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

DeleteSavedQuery(google::cloud::aiplatform::v1::DeleteSavedQueryRequest const &, Options)

Deletes a SavedQuery.

Parameters
Name	Description
request	google::cloud::aiplatform::v1::DeleteSavedQueryRequest 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.DeleteSavedQueryRequest. 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.

DeleteSavedQuery(ExperimentalTag, NoAwaitTag, google::cloud::aiplatform::v1::DeleteSavedQueryRequest const &, Options)

Parameters
Name	Description
	ExperimentalTag
	NoAwaitTag
request	google::cloud::aiplatform::v1::DeleteSavedQueryRequest const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

DeleteSavedQuery(ExperimentalTag, google::longrunning::Operation const &, Options)

Parameters
Name	Description
	ExperimentalTag
operation	google::longrunning::Operation const &
opts	Options

Returns
Type	Description
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > >

GetAnnotationSpec(std::string const &, Options)

Gets an AnnotationSpec.

Parameters
Name	Description
name	std::string const & Required. The name of the AnnotationSpec resource. Format: projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::aiplatform::v1::AnnotationSpec >	the result of the RPC. The response message type (google.cloud.aiplatform.v1.AnnotationSpec) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetAnnotationSpec(google::cloud::aiplatform::v1::GetAnnotationSpecRequest const &, Options)

Gets an AnnotationSpec.

Parameters
Name	Description
request	google::cloud::aiplatform::v1::GetAnnotationSpecRequest 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.GetAnnotationSpecRequest. 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::AnnotationSpec >	the result of the RPC. The response message type (google.cloud.aiplatform.v1.AnnotationSpec) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListAnnotations(std::string const &, Options)

Lists Annotations belongs to a dataitem.

Parameters
Name	Description
parent	std::string const & Required. The resource name of the DataItem to list Annotations from. Format: projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::aiplatform::v1::Annotation >	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.Annotation, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListAnnotations(google::cloud::aiplatform::v1::ListAnnotationsRequest, Options)

Lists Annotations belongs to a dataitem.

Parameters
Name	Description
request	google::cloud::aiplatform::v1::ListAnnotationsRequest 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.ListAnnotationsRequest. 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::Annotation >	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.Annotation, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.