Class FeatureRegistryServiceClient (2.24.0)

The service that handles CRUD and List for resources for FeatureRegistry.

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

FeatureRegistryServiceClient(FeatureRegistryServiceClient const &)

Copy and move support

Parameter
Name	Description
	`FeatureRegistryServiceClient const &`

FeatureRegistryServiceClient(FeatureRegistryServiceClient &&)

Copy and move support

Parameter
Name	Description
	`FeatureRegistryServiceClient &&`

FeatureRegistryServiceClient(std::shared_ptr< FeatureRegistryServiceConnection >, Options)

Parameters
Name	Description
`connection`	`std::shared_ptr< FeatureRegistryServiceConnection >`
`opts`	`Options`

Operators

operator=(FeatureRegistryServiceClient const &)

Copy and move support

Parameter
Name	Description
	`FeatureRegistryServiceClient const &`

Returns
Type	Description
`FeatureRegistryServiceClient &`

operator=(FeatureRegistryServiceClient &&)

Copy and move support

Parameter
Name	Description
	`FeatureRegistryServiceClient &&`

Returns
Type	Description
`FeatureRegistryServiceClient &`

Functions

CreateFeatureGroup(std::string const &, google::cloud::aiplatform::v1::FeatureGroup const &, std::string const &, Options)

Creates a new FeatureGroup in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. The resource name of the Location to create FeatureGroups. Format: `projects/{project}/locations/{location}`
`feature_group`	`google::cloud::aiplatform::v1::FeatureGroup const &` Required. The FeatureGroup to create.
`feature_group_id`	`std::string const &` Required. The ID to use for this FeatureGroup, which will become the final component of the FeatureGroup'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

Type Description

future< StatusOr< google::cloud::aiplatform::v1::FeatureGroup > >

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

CreateFeatureGroup(google::cloud::aiplatform::v1::CreateFeatureGroupRequest const &, Options)

Creates a new FeatureGroup in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::aiplatform::v1::CreateFeatureGroupRequest 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.CreateFeatureGroupRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::aiplatform::v1::FeatureGroup > >

GetFeatureGroup(std::string const &, Options)

Gets details of a single FeatureGroup.

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

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

GetFeatureGroup(google::cloud::aiplatform::v1::GetFeatureGroupRequest const &, Options)

Gets details of a single FeatureGroup.

Parameters
Name	Description
`request`	`google::cloud::aiplatform::v1::GetFeatureGroupRequest 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.GetFeatureGroupRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

ListFeatureGroups(std::string const &, Options)

Lists FeatureGroups in a given project and location.

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

Returns

Type Description

StreamRange< google::cloud::aiplatform::v1::FeatureGroup >

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

ListFeatureGroups(google::cloud::aiplatform::v1::ListFeatureGroupsRequest, Options)

Lists FeatureGroups in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::aiplatform::v1::ListFeatureGroupsRequest` 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.ListFeatureGroupsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::aiplatform::v1::FeatureGroup >

UpdateFeatureGroup(google::cloud::aiplatform::v1::FeatureGroup const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single FeatureGroup.

Parameters
Name	Description
`feature_group`	`google::cloud::aiplatform::v1::FeatureGroup const &` Required. The FeatureGroup's `name` field is used to identify the FeatureGroup to be updated. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}`
`update_mask`	`google::protobuf::FieldMask const &` Field mask is used to specify the fields to be overwritten in the FeatureGroup 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`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::aiplatform::v1::FeatureGroup > >

UpdateFeatureGroup(google::cloud::aiplatform::v1::UpdateFeatureGroupRequest const &, Options)

Updates the parameters of a single FeatureGroup.

Parameters
Name	Description
`request`	`google::cloud::aiplatform::v1::UpdateFeatureGroupRequest 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.UpdateFeatureGroupRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::aiplatform::v1::FeatureGroup > >

DeleteFeatureGroup(std::string const &, bool, Options)

Deletes a single FeatureGroup.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the FeatureGroup to be deleted. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}`
`force`	`bool` If set to true, any Features under this FeatureGroup will also be deleted. (Otherwise, the request will only work if the FeatureGroup 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 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.

DeleteFeatureGroup(google::cloud::aiplatform::v1::DeleteFeatureGroupRequest const &, Options)

Deletes a single FeatureGroup.

Parameters
Name	Description
`request`	`google::cloud::aiplatform::v1::DeleteFeatureGroupRequest 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.DeleteFeatureGroupRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > >

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

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

Creates a new Feature in a given FeatureGroup.

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: `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

Type Description

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

Parameters
Name	Description
`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

Type Description

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.

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: `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
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 `StatusOr` contains the error details.

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

ListFeatures(std::string const &, Options)

Lists Features in a given FeatureGroup.

Parameters
Name	Description
`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

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

Parameters
Name	Description
`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

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 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
Name	Description
`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

Type Description

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.

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 `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

Type Description

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.

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: 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

Type Description

future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > >

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

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 `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

Type Description

future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > >

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