The service that handles the CRUD of 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: |
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 |
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 |
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 |
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 |
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 |
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 |
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
|
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
GetAnnotationSpec(std::string const &, Options)
Gets an AnnotationSpec.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the AnnotationSpec resource. Format: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |