The service that handles CRUD and List for resources for Featurestore.
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
FeaturestoreServiceClient(FeaturestoreServiceClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
FeaturestoreServiceClient const &
|
FeaturestoreServiceClient(FeaturestoreServiceClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
FeaturestoreServiceClient &&
|
FeaturestoreServiceClient(std::shared_ptr< FeaturestoreServiceConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< FeaturestoreServiceConnection >
|
opts |
Options
|
Operators
operator=(FeaturestoreServiceClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
FeaturestoreServiceClient const &
|
Returns | |
---|---|
Type | Description |
FeaturestoreServiceClient & |
operator=(FeaturestoreServiceClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
FeaturestoreServiceClient &&
|
Returns | |
---|---|
Type | Description |
FeaturestoreServiceClient & |
Functions
CreateFeaturestore(std::string const &, google::cloud::aiplatform::v1::Featurestore const &, Options)
Creates a new Featurestore in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the Location to create Featurestores. Format: |
featurestore |
google::cloud::aiplatform::v1::Featurestore const &
Required. The Featurestore 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::Featurestore > > | A |
CreateFeaturestore(std::string const &, google::cloud::aiplatform::v1::Featurestore const &, std::string const &, Options)
Creates a new Featurestore in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the Location to create Featurestores. Format: |
featurestore |
google::cloud::aiplatform::v1::Featurestore const &
Required. The Featurestore to create. |
featurestore_id |
std::string const &
Required. The ID to use for this Featurestore, which will become the final component of the Featurestore's resource name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::Featurestore > > | A |
CreateFeaturestore(google::cloud::aiplatform::v1::CreateFeaturestoreRequest const &, Options)
Creates a new Featurestore in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::CreateFeaturestoreRequest 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::Featurestore > > | A |
GetFeaturestore(std::string const &, Options)
Gets details of a single Featurestore.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the Featurestore resource. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::Featurestore > | the result of the RPC. The response message type (google.cloud.aiplatform.v1.Featurestore) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetFeaturestore(google::cloud::aiplatform::v1::GetFeaturestoreRequest const &, Options)
Gets details of a single Featurestore.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::GetFeaturestoreRequest 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::Featurestore > | the result of the RPC. The response message type (google.cloud.aiplatform.v1.Featurestore) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListFeaturestores(std::string const &, Options)
Lists Featurestores in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the Location to list Featurestores. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::aiplatform::v1::Featurestore > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListFeaturestores(google::cloud::aiplatform::v1::ListFeaturestoresRequest, Options)
Lists Featurestores in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::ListFeaturestoresRequest
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::Featurestore > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
UpdateFeaturestore(google::cloud::aiplatform::v1::Featurestore const &, google::protobuf::FieldMask const &, Options)
Updates the parameters of a single Featurestore.
Parameters | |
---|---|
Name | Description |
featurestore |
google::cloud::aiplatform::v1::Featurestore const &
Required. The Featurestore's |
update_mask |
google::protobuf::FieldMask const &
Field mask is used to specify the fields to be overwritten in the Featurestore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to
|
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::Featurestore > > | A |
UpdateFeaturestore(google::cloud::aiplatform::v1::UpdateFeaturestoreRequest const &, Options)
Updates the parameters of a single Featurestore.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::UpdateFeaturestoreRequest 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::Featurestore > > | A |
DeleteFeaturestore(std::string const &, Options)
Deletes a single Featurestore.
The Featurestore must not contain any EntityTypes or force
must be set to true for the request to succeed.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the Featurestore to be deleted. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > > | A |
DeleteFeaturestore(std::string const &, bool, Options)
Deletes a single Featurestore.
The Featurestore must not contain any EntityTypes or force
must be set to true for the request to succeed.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the Featurestore to be deleted. Format: |
force |
bool
If set to true, any EntityTypes and Features for this Featurestore will also be deleted. (Otherwise, the request will only work if the Featurestore has no EntityTypes.) |
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 |
DeleteFeaturestore(google::cloud::aiplatform::v1::DeleteFeaturestoreRequest const &, Options)
Deletes a single Featurestore.
The Featurestore must not contain any EntityTypes or force
must be set to true for the request to succeed.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::DeleteFeaturestoreRequest 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 |
CreateEntityType(std::string const &, google::cloud::aiplatform::v1::EntityType const &, Options)
Creates a new EntityType in a given Featurestore.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the Featurestore to create EntityTypes. Format: |
entity_type |
google::cloud::aiplatform::v1::EntityType const &
The EntityType 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::EntityType > > | A |
CreateEntityType(std::string const &, google::cloud::aiplatform::v1::EntityType const &, std::string const &, Options)
Creates a new EntityType in a given Featurestore.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the Featurestore to create EntityTypes. Format: |
entity_type |
google::cloud::aiplatform::v1::EntityType const &
The EntityType to create. |
entity_type_id |
std::string const &
Required. The ID to use for the EntityType, which will become the final component of the EntityType's resource name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::EntityType > > | A |
CreateEntityType(google::cloud::aiplatform::v1::CreateEntityTypeRequest const &, Options)
Creates a new EntityType in a given Featurestore.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::CreateEntityTypeRequest 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::EntityType > > | A |
GetEntityType(std::string const &, Options)
Gets details of a single EntityType.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the EntityType resource. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::EntityType > | the result of the RPC. The response message type (google.cloud.aiplatform.v1.EntityType) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetEntityType(google::cloud::aiplatform::v1::GetEntityTypeRequest const &, Options)
Gets details of a single EntityType.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::GetEntityTypeRequest 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::EntityType > | the result of the RPC. The response message type (google.cloud.aiplatform.v1.EntityType) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListEntityTypes(std::string const &, Options)
Lists EntityTypes in a given Featurestore.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the Featurestore to list EntityTypes. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::aiplatform::v1::EntityType > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListEntityTypes(google::cloud::aiplatform::v1::ListEntityTypesRequest, Options)
Lists EntityTypes in a given Featurestore.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::ListEntityTypesRequest
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::EntityType > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
UpdateEntityType(google::cloud::aiplatform::v1::EntityType const &, google::protobuf::FieldMask const &, Options)
Updates the parameters of a single EntityType.
Parameters | |
---|---|
Name | Description |
entity_type |
google::cloud::aiplatform::v1::EntityType const &
Required. The EntityType's |
update_mask |
google::protobuf::FieldMask const &
Field mask is used to specify the fields to be overwritten in the EntityType resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to
|
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::EntityType > | the result of the RPC. The response message type (google.cloud.aiplatform.v1.EntityType) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateEntityType(google::cloud::aiplatform::v1::UpdateEntityTypeRequest const &, Options)
Updates the parameters of a single EntityType.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::UpdateEntityTypeRequest 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::EntityType > | the result of the RPC. The response message type (google.cloud.aiplatform.v1.EntityType) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteEntityType(std::string const &, Options)
Deletes a single EntityType.
The EntityType must not have any Features or force
must be set to true for the request to succeed.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the EntityType to be deleted. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > > | A |
DeleteEntityType(std::string const &, bool, Options)
Deletes a single EntityType.
The EntityType must not have any Features or force
must be set to true for the request to succeed.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the EntityType to be deleted. Format: |
force |
bool
If set to true, any Features for this EntityType will also be deleted. (Otherwise, the request will only work if the EntityType has no Features.) |
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 |
DeleteEntityType(google::cloud::aiplatform::v1::DeleteEntityTypeRequest const &, Options)
Deletes a single EntityType.
The EntityType must not have any Features or force
must be set to true for the request to succeed.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::DeleteEntityTypeRequest 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 |
CreateFeature(std::string const &, google::cloud::aiplatform::v1::Feature const &, Options)
Creates a new Feature in a given EntityType.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: |
feature |
google::cloud::aiplatform::v1::Feature const &
Required. The Feature 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::Feature > > | A |
CreateFeature(std::string const &, google::cloud::aiplatform::v1::Feature const &, std::string const &, Options)
Creates a new Feature in a given EntityType.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: |
feature |
google::cloud::aiplatform::v1::Feature const &
Required. The Feature to create. |
feature_id |
std::string const &
Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::Feature > > | A |
CreateFeature(google::cloud::aiplatform::v1::CreateFeatureRequest const &, Options)
Creates a new Feature in a given EntityType.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::CreateFeatureRequest 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::Feature > > | A |
BatchCreateFeatures(std::string const &, std::vector< google::cloud::aiplatform::v1::CreateFeatureRequest > const &, Options)
Creates a batch of Features in a given EntityType.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the EntityType to create the batch of Features under. Format: |
requests |
std::vector< google::cloud::aiplatform::v1::CreateFeatureRequest > const &
Required. The request message specifying the Features to create. All Features must be created under the same parent EntityType. The |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::BatchCreateFeaturesResponse > > | A |
BatchCreateFeatures(google::cloud::aiplatform::v1::BatchCreateFeaturesRequest const &, Options)
Creates a batch of Features in a given EntityType.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::BatchCreateFeaturesRequest 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::BatchCreateFeaturesResponse > > | A |
GetFeature(std::string const &, Options)
Gets details of a single Feature.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the Feature resource. Format for entity_type as parent: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::Feature > | the result of the RPC. The response message type (google.cloud.aiplatform.v1.Feature) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetFeature(google::cloud::aiplatform::v1::GetFeatureRequest const &, Options)
Gets details of a single Feature.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::GetFeatureRequest 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::Feature > | the result of the RPC. The response message type (google.cloud.aiplatform.v1.Feature) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListFeatures(std::string const &, Options)
Lists Features in a given EntityType.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the Location to list Features. Format for entity_type as parent: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::aiplatform::v1::Feature > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListFeatures(google::cloud::aiplatform::v1::ListFeaturesRequest, Options)
Lists Features in a given EntityType.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::ListFeaturesRequest
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::Feature > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
UpdateFeature(google::cloud::aiplatform::v1::Feature const &, google::protobuf::FieldMask const &, Options)
Updates the parameters of a single Feature.
Parameters | |
---|---|
Name | Description |
feature |
google::cloud::aiplatform::v1::Feature const &
Required. The Feature's |
update_mask |
google::protobuf::FieldMask const &
Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to
|
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::Feature > | the result of the RPC. The response message type (google.cloud.aiplatform.v1.Feature) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateFeature(google::cloud::aiplatform::v1::UpdateFeatureRequest const &, Options)
Updates the parameters of a single Feature.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::UpdateFeatureRequest 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::Feature > | the result of the RPC. The response message type (google.cloud.aiplatform.v1.Feature) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteFeature(std::string const &, Options)
Deletes a single Feature.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the Features to be deleted. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > > | A |
DeleteFeature(google::cloud::aiplatform::v1::DeleteFeatureRequest const &, Options)
Deletes a single Feature.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::DeleteFeatureRequest 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 |
ImportFeatureValues(std::string const &, Options)
Imports Feature values into the Featurestore from a source storage.
The progress of the import is tracked by the returned operation. The imported features are guaranteed to be visible to subsequent read operations after the operation is marked as successfully done.
If an import operation fails, the Feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same import request again and wait till the new operation returned is marked as successfully done.
There are also scenarios where the caller can cause inconsistency.
- Source data for import contains multiple distinct Feature values for the same entity ID and timestamp.
- Source is modified during an import. This includes adding, updating, or removing source data and/or metadata. Examples of updating metadata include but are not limited to changing storage location, storage class, or retention policy.
- Online serving cluster is under-provisioned.
Parameters | |
---|---|
Name | Description |
entity_type |
std::string const &
Required. The resource name of the EntityType grouping the Features for which values are being imported. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::ImportFeatureValuesResponse > > | A |
ImportFeatureValues(google::cloud::aiplatform::v1::ImportFeatureValuesRequest const &, Options)
Imports Feature values into the Featurestore from a source storage.
The progress of the import is tracked by the returned operation. The imported features are guaranteed to be visible to subsequent read operations after the operation is marked as successfully done.
If an import operation fails, the Feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same import request again and wait till the new operation returned is marked as successfully done.
There are also scenarios where the caller can cause inconsistency.
- Source data for import contains multiple distinct Feature values for the same entity ID and timestamp.
- Source is modified during an import. This includes adding, updating, or removing source data and/or metadata. Examples of updating metadata include but are not limited to changing storage location, storage class, or retention policy.
- Online serving cluster is under-provisioned.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::ImportFeatureValuesRequest 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::ImportFeatureValuesResponse > > | A |
BatchReadFeatureValues(std::string const &, Options)
Batch reads Feature values from a Featurestore.
This API enables batch reading Feature values, where each read instance in the batch may read Feature values of entities from one or more EntityTypes. Point-in-time correctness is guaranteed for Feature values of each read instance as of each instance's read timestamp.
Parameters | |
---|---|
Name | Description |
featurestore |
std::string const &
Required. The resource name of the Featurestore from which to query Feature values. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::BatchReadFeatureValuesResponse > > | A |
BatchReadFeatureValues(google::cloud::aiplatform::v1::BatchReadFeatureValuesRequest const &, Options)
Batch reads Feature values from a Featurestore.
This API enables batch reading Feature values, where each read instance in the batch may read Feature values of entities from one or more EntityTypes. Point-in-time correctness is guaranteed for Feature values of each read instance as of each instance's read timestamp.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::BatchReadFeatureValuesRequest 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::BatchReadFeatureValuesResponse > > | A |
ExportFeatureValues(std::string const &, Options)
Exports Feature values from all the entities of a target EntityType.
Parameters | |
---|---|
Name | Description |
entity_type |
std::string const &
Required. The resource name of the EntityType from which to export Feature values. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::ExportFeatureValuesResponse > > | A |
ExportFeatureValues(google::cloud::aiplatform::v1::ExportFeatureValuesRequest const &, Options)
Exports Feature values from all the entities of a target EntityType.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::ExportFeatureValuesRequest 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::ExportFeatureValuesResponse > > | A |
DeleteFeatureValues(std::string const &, Options)
Delete Feature values from Featurestore.
The progress of the deletion is tracked by the returned operation. The deleted feature values are guaranteed to be invisible to subsequent read operations after the operation is marked as successfully done.
If a delete feature values operation fails, the feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same delete request again and wait till the new operation returned is marked as successfully done.
Parameters | |
---|---|
Name | Description |
entity_type |
std::string const &
Required. The resource name of the EntityType grouping the Features for which values are being deleted from. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::DeleteFeatureValuesResponse > > | A |
DeleteFeatureValues(google::cloud::aiplatform::v1::DeleteFeatureValuesRequest const &, Options)
Delete Feature values from Featurestore.
The progress of the deletion is tracked by the returned operation. The deleted feature values are guaranteed to be invisible to subsequent read operations after the operation is marked as successfully done.
If a delete feature values operation fails, the feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same delete request again and wait till the new operation returned is marked as successfully done.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::DeleteFeatureValuesRequest 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::DeleteFeatureValuesResponse > > | A |
SearchFeatures(std::string const &, Options)
Searches Features matching a query in a given project.
Parameters | |
---|---|
Name | Description |
location |
std::string const &
Required. The resource name of the Location to search Features. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::aiplatform::v1::Feature > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
SearchFeatures(std::string const &, std::string const &, Options)
Searches Features matching a query in a given project.
Parameters | |
---|---|
Name | Description |
location |
std::string const &
Required. The resource name of the Location to search Features. Format: |
query |
std::string const &
Query string that is a conjunction of field-restricted queries and/or field-restricted filters. Field-restricted queries and filters can be combined using |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::aiplatform::v1::Feature > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
SearchFeatures(google::cloud::aiplatform::v1::SearchFeaturesRequest, Options)
Searches Features matching a query in a given project.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::SearchFeaturesRequest
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::Feature > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |