Class FeaturestoreServiceClient (2.23.0-rc)

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
NameDescription
FeaturestoreServiceClient const &

FeaturestoreServiceClient(FeaturestoreServiceClient &&)

Copy and move support

Parameter
NameDescription
FeaturestoreServiceClient &&

FeaturestoreServiceClient(std::shared_ptr< FeaturestoreServiceConnection >, Options)

Parameters
NameDescription
connection std::shared_ptr< FeaturestoreServiceConnection >
opts Options

Operators

operator=(FeaturestoreServiceClient const &)

Copy and move support

Parameter
NameDescription
FeaturestoreServiceClient const &
Returns
TypeDescription
FeaturestoreServiceClient &

operator=(FeaturestoreServiceClient &&)

Copy and move support

Parameter
NameDescription
FeaturestoreServiceClient &&
Returns
TypeDescription
FeaturestoreServiceClient &

Functions

CreateFeaturestore(std::string const &, google::cloud::aiplatform::v1::Featurestore const &, Options)

Creates a new Featurestore in a given project and location.

Parameters
NameDescription
parent std::string const &

Required. The resource name of the Location to create Featurestores. Format: projects/{project}/locations/{location}

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
TypeDescription
future< StatusOr< google::cloud::aiplatform::v1::Featurestore > >

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.Featurestore proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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
NameDescription
parent std::string const &

Required. The resource name of the Location to create Featurestores. Format: projects/{project}/locations/{location}

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.
This value may be up to 60 characters, and valid characters are [a-z0-9_]. The first character cannot be a number.
The value must be unique within the project and location.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::aiplatform::v1::Featurestore > >

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.Featurestore proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateFeaturestore(google::cloud::aiplatform::v1::CreateFeaturestoreRequest const &, Options)

Creates a new Featurestore in a given project and location.

Parameters
NameDescription
request google::cloud::aiplatform::v1::CreateFeaturestoreRequest 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.CreateFeaturestoreRequest. 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
TypeDescription
future< StatusOr< google::cloud::aiplatform::v1::Featurestore > >

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.Featurestore proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

GetFeaturestore(std::string const &, Options)

Gets details of a single Featurestore.

Parameters
NameDescription
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
TypeDescription
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 StatusOr contains the error details.

GetFeaturestore(google::cloud::aiplatform::v1::GetFeaturestoreRequest const &, Options)

Gets details of a single Featurestore.

Parameters
NameDescription
request google::cloud::aiplatform::v1::GetFeaturestoreRequest 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.GetFeaturestoreRequest. 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
TypeDescription
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 StatusOr contains the error details.

ListFeaturestores(std::string const &, Options)

Lists Featurestores in a given project and location.

Parameters
NameDescription
parent std::string const &

Required. The resource name of the Location to list Featurestores. Format: projects/{project}/locations/{location}

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
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 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.Featurestore, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListFeaturestores(google::cloud::aiplatform::v1::ListFeaturestoresRequest, Options)

Lists Featurestores in a given project and location.

Parameters
NameDescription
request google::cloud::aiplatform::v1::ListFeaturestoresRequest

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.ListFeaturestoresRequest. 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
TypeDescription
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 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.Featurestore, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

UpdateFeaturestore(google::cloud::aiplatform::v1::Featurestore const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Featurestore.

Parameters
NameDescription
featurestore google::cloud::aiplatform::v1::Featurestore const &

Required. The Featurestore's name field is used to identify the Featurestore to be updated. Format: projects/{project}/locations/{location}/featurestores/{featurestore}

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 * to override all fields.
Updatable fields:

  • labels
  • online_serving_config.fixed_node_count
  • online_serving_config.scaling
  • online_storage_ttl_days
opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::aiplatform::v1::Featurestore > >

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.Featurestore proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateFeaturestore(google::cloud::aiplatform::v1::UpdateFeaturestoreRequest const &, Options)

Updates the parameters of a single Featurestore.

Parameters
NameDescription
request google::cloud::aiplatform::v1::UpdateFeaturestoreRequest 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.UpdateFeaturestoreRequest. 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
TypeDescription
future< StatusOr< google::cloud::aiplatform::v1::Featurestore > >

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.Featurestore proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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
NameDescription
name std::string const &

Required. The name of the Featurestore to be deleted. Format: projects/{project}/locations/{location}/featurestores/{featurestore}

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
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.

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
NameDescription
name std::string const &

Required. The name of the Featurestore to be deleted. Format: projects/{project}/locations/{location}/featurestores/{featurestore}

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
TypeDescription
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.

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
NameDescription
request google::cloud::aiplatform::v1::DeleteFeaturestoreRequest 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.DeleteFeaturestoreRequest. 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
TypeDescription
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.

CreateEntityType(std::string const &, google::cloud::aiplatform::v1::EntityType const &, Options)

Creates a new EntityType in a given Featurestore.

Parameters
NameDescription
parent std::string const &

Required. The resource name of the Featurestore to create EntityTypes. Format: projects/{project}/locations/{location}/featurestores/{featurestore}

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
TypeDescription
future< StatusOr< google::cloud::aiplatform::v1::EntityType > >

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.EntityType proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateEntityType(std::string const &, google::cloud::aiplatform::v1::EntityType const &, std::string const &, Options)

Creates a new EntityType in a given Featurestore.

Parameters
NameDescription
parent std::string const &

Required. The resource name of the Featurestore to create EntityTypes. Format: projects/{project}/locations/{location}/featurestores/{featurestore}

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.
This value may be up to 60 characters, and valid characters are [a-z0-9_]. The first character cannot be a number.
The value must be unique within a featurestore.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::aiplatform::v1::EntityType > >

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.EntityType proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateEntityType(google::cloud::aiplatform::v1::CreateEntityTypeRequest const &, Options)

Creates a new EntityType in a given Featurestore.

Parameters
NameDescription
request google::cloud::aiplatform::v1::CreateEntityTypeRequest 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.CreateEntityTypeRequest. 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
TypeDescription
future< StatusOr< google::cloud::aiplatform::v1::EntityType > >

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.EntityType proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

GetEntityType(std::string const &, Options)

Gets details of a single EntityType.

Parameters
NameDescription
name std::string const &

Required. The name of the EntityType resource. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
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 StatusOr contains the error details.

GetEntityType(google::cloud::aiplatform::v1::GetEntityTypeRequest const &, Options)

Gets details of a single EntityType.

Parameters
NameDescription
request google::cloud::aiplatform::v1::GetEntityTypeRequest 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.GetEntityTypeRequest. 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
TypeDescription
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 StatusOr contains the error details.

ListEntityTypes(std::string const &, Options)

Lists EntityTypes in a given Featurestore.

Parameters
NameDescription
parent std::string const &

Required. The resource name of the Featurestore to list EntityTypes. Format: projects/{project}/locations/{location}/featurestores/{featurestore}

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
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 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.EntityType, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListEntityTypes(google::cloud::aiplatform::v1::ListEntityTypesRequest, Options)

Lists EntityTypes in a given Featurestore.

Parameters
NameDescription
request google::cloud::aiplatform::v1::ListEntityTypesRequest

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.ListEntityTypesRequest. 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
TypeDescription
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 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.EntityType, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

UpdateEntityType(google::cloud::aiplatform::v1::EntityType const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single EntityType.

Parameters
NameDescription
entity_type google::cloud::aiplatform::v1::EntityType const &

Required. The EntityType's name field is used to identify the EntityType to be updated. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}

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 * to override all fields.
Updatable fields:

  • description
  • labels
  • monitoring_config.snapshot_analysis.disabled
  • monitoring_config.snapshot_analysis.monitoring_interval_days
  • monitoring_config.snapshot_analysis.staleness_days
  • monitoring_config.import_features_analysis.state
  • monitoring_config.import_features_analysis.anomaly_detection_baseline
  • monitoring_config.numerical_threshold_config.value
  • monitoring_config.categorical_threshold_config.value
  • offline_storage_ttl_days
opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
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 StatusOr contains the error details.

UpdateEntityType(google::cloud::aiplatform::v1::UpdateEntityTypeRequest const &, Options)

Updates the parameters of a single EntityType.

Parameters
NameDescription
request google::cloud::aiplatform::v1::UpdateEntityTypeRequest 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.UpdateEntityTypeRequest. 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
TypeDescription
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 StatusOr contains the error details.

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
NameDescription
name std::string const &

Required. The name of the EntityType to be deleted. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
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.

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
NameDescription
name std::string const &

Required. The name of the EntityType to be deleted. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}

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
TypeDescription
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.

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
NameDescription
request google::cloud::aiplatform::v1::DeleteEntityTypeRequest 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.DeleteEntityTypeRequest. 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
TypeDescription
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.

CreateFeature(std::string const &, google::cloud::aiplatform::v1::Feature const &, Options)

Creates a new Feature in a given EntityType.

Parameters
NameDescription
parent std::string const &

Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type} Format for feature_group as parent: projects/{project}/locations/{location}/featureGroups/{feature_group}

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
TypeDescription
future< StatusOr< google::cloud::aiplatform::v1::Feature > >

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.Feature proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateFeature(std::string const &, google::cloud::aiplatform::v1::Feature const &, std::string const &, Options)

Creates a new Feature in a given EntityType.

Parameters
NameDescription
parent std::string const &

Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type} Format for feature_group as parent: projects/{project}/locations/{location}/featureGroups/{feature_group}

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.
This value may be up to 128 characters, and valid characters are [a-z0-9_]. The first character cannot be a number.
The value must be unique within an EntityType/FeatureGroup.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::aiplatform::v1::Feature > >

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.Feature proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateFeature(google::cloud::aiplatform::v1::CreateFeatureRequest const &, Options)

Creates a new Feature in a given EntityType.

Parameters
NameDescription
request google::cloud::aiplatform::v1::CreateFeatureRequest 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.CreateFeatureRequest. 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
TypeDescription
future< StatusOr< google::cloud::aiplatform::v1::Feature > >

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.Feature proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Creates a batch of Features in a given EntityType.

Parameters
NameDescription
parent std::string const &

Required. The resource name of the EntityType to create the batch of Features under. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}

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 parent field in each child request message can be omitted. If parent is set in a child request, then the value must match the parent value in this request message.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::aiplatform::v1::BatchCreateFeaturesResponse > >

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.BatchCreateFeaturesResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

BatchCreateFeatures(google::cloud::aiplatform::v1::BatchCreateFeaturesRequest const &, Options)

Creates a batch of Features in a given EntityType.

Parameters
NameDescription
request google::cloud::aiplatform::v1::BatchCreateFeaturesRequest 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.BatchCreateFeaturesRequest. 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
TypeDescription
future< StatusOr< google::cloud::aiplatform::v1::BatchCreateFeaturesResponse > >

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.BatchCreateFeaturesResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

GetFeature(std::string const &, Options)

Gets details of a single Feature.

Parameters
NameDescription
name std::string const &

Required. The name of the Feature resource. Format for entity_type as parent: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type} Format for feature_group as parent: projects/{project}/locations/{location}/featureGroups/{feature_group}

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
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 StatusOr contains the error details.

GetFeature(google::cloud::aiplatform::v1::GetFeatureRequest const &, Options)

Gets details of a single Feature.

Parameters
NameDescription
request google::cloud::aiplatform::v1::GetFeatureRequest 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.GetFeatureRequest. 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
TypeDescription
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 StatusOr contains the error details.

ListFeatures(std::string const &, Options)

Lists Features in a given EntityType.

Parameters
NameDescription
parent std::string const &

Required. The resource name of the Location to list Features. Format for entity_type as parent: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type} Format for feature_group as parent: projects/{project}/locations/{location}/featureGroups/{feature_group}

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
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 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.Feature, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListFeatures(google::cloud::aiplatform::v1::ListFeaturesRequest, Options)

Lists Features in a given EntityType.

Parameters
NameDescription
request google::cloud::aiplatform::v1::ListFeaturesRequest

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.ListFeaturesRequest. 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
TypeDescription
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 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.Feature, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

UpdateFeature(google::cloud::aiplatform::v1::Feature const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Feature.

Parameters
NameDescription
feature google::cloud::aiplatform::v1::Feature const &

Required. The Feature's name field is used to identify the Feature to be updated. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}``projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}

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 * to override all fields.
Updatable fields:

  • description
  • labels
  • disable_monitoring (Not supported for FeatureRegistry Feature)
opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
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 StatusOr contains the error details.

UpdateFeature(google::cloud::aiplatform::v1::UpdateFeatureRequest const &, Options)

Updates the parameters of a single Feature.

Parameters
NameDescription
request google::cloud::aiplatform::v1::UpdateFeatureRequest 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.UpdateFeatureRequest. 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
TypeDescription
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 StatusOr contains the error details.

DeleteFeature(std::string const &, Options)

Deletes a single Feature.

Parameters
NameDescription
name std::string const &

Required. The name of the Features to be deleted. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}``projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
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.

DeleteFeature(google::cloud::aiplatform::v1::DeleteFeatureRequest const &, Options)

Deletes a single Feature.

Parameters
NameDescription
request google::cloud::aiplatform::v1::DeleteFeatureRequest 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.DeleteFeatureRequest. 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
TypeDescription
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.

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
NameDescription
entity_type std::string const &

Required. The resource name of the EntityType grouping the Features for which values are being imported. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::aiplatform::v1::ImportFeatureValuesResponse > >

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.ImportFeatureValuesResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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
NameDescription
request google::cloud::aiplatform::v1::ImportFeatureValuesRequest 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.ImportFeatureValuesRequest. 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
TypeDescription
future< StatusOr< google::cloud::aiplatform::v1::ImportFeatureValuesResponse > >

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.ImportFeatureValuesResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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
NameDescription
featurestore std::string const &

Required. The resource name of the Featurestore from which to query Feature values. Format: projects/{project}/locations/{location}/featurestores/{featurestore}

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::aiplatform::v1::BatchReadFeatureValuesResponse > >

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.BatchReadFeatureValuesResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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
NameDescription
request google::cloud::aiplatform::v1::BatchReadFeatureValuesRequest 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.BatchReadFeatureValuesRequest. 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
TypeDescription
future< StatusOr< google::cloud::aiplatform::v1::BatchReadFeatureValuesResponse > >

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.BatchReadFeatureValuesResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ExportFeatureValues(std::string const &, Options)

Exports Feature values from all the entities of a target EntityType.

Parameters
NameDescription
entity_type std::string const &

Required. The resource name of the EntityType from which to export Feature values. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::aiplatform::v1::ExportFeatureValuesResponse > >

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.ExportFeatureValuesResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ExportFeatureValues(google::cloud::aiplatform::v1::ExportFeatureValuesRequest const &, Options)

Exports Feature values from all the entities of a target EntityType.

Parameters
NameDescription
request google::cloud::aiplatform::v1::ExportFeatureValuesRequest 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.ExportFeatureValuesRequest. 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
TypeDescription
future< StatusOr< google::cloud::aiplatform::v1::ExportFeatureValuesResponse > >

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.ExportFeatureValuesResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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
NameDescription
entity_type std::string const &

Required. The resource name of the EntityType grouping the Features for which values are being deleted from. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::aiplatform::v1::DeleteFeatureValuesResponse > >

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.DeleteFeatureValuesResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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
NameDescription
request google::cloud::aiplatform::v1::DeleteFeatureValuesRequest 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.DeleteFeatureValuesRequest. 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
TypeDescription
future< StatusOr< google::cloud::aiplatform::v1::DeleteFeatureValuesResponse > >

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.DeleteFeatureValuesResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

SearchFeatures(std::string const &, Options)

Searches Features matching a query in a given project.

Parameters
NameDescription
location std::string const &

Required. The resource name of the Location to search Features. Format: projects/{project}/locations/{location}

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
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 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.Feature, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

SearchFeatures(std::string const &, std::string const &, Options)

Searches Features matching a query in a given project.

Parameters
NameDescription
location std::string const &

Required. The resource name of the Location to search Features. Format: projects/{project}/locations/{location}

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 AND to form a conjunction.
For more information, see SearchFeaturesRequest.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
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 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.Feature, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

SearchFeatures(google::cloud::aiplatform::v1::SearchFeaturesRequest, Options)

Searches Features matching a query in a given project.

Parameters
NameDescription
request google::cloud::aiplatform::v1::SearchFeaturesRequest

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.SearchFeaturesRequest. 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
TypeDescription
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 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.Feature, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.