Class FeatureOnlineStoreAdminServiceClient (2.40.0-rc)

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

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

FeatureOnlineStoreAdminServiceClient(FeatureOnlineStoreAdminServiceClient const &)

Copy and move support

Parameter
Name Description
FeatureOnlineStoreAdminServiceClient const &

FeatureOnlineStoreAdminServiceClient(FeatureOnlineStoreAdminServiceClient &&)

Copy and move support

Parameter
Name Description
FeatureOnlineStoreAdminServiceClient &&

FeatureOnlineStoreAdminServiceClient(std::shared_ptr< FeatureOnlineStoreAdminServiceConnection >, Options)

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

Operators

operator=(FeatureOnlineStoreAdminServiceClient const &)

Copy and move support

Parameter
Name Description
FeatureOnlineStoreAdminServiceClient const &
Returns
Type Description
FeatureOnlineStoreAdminServiceClient &

operator=(FeatureOnlineStoreAdminServiceClient &&)

Copy and move support

Parameter
Name Description
FeatureOnlineStoreAdminServiceClient &&
Returns
Type Description
FeatureOnlineStoreAdminServiceClient &

Functions

CreateFeatureOnlineStore(std::string const &, google::cloud::aiplatform::v1::FeatureOnlineStore const &, std::string const &, Options)

Creates a new FeatureOnlineStore in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The resource name of the Location to create FeatureOnlineStores. Format: projects/{project}/locations/{location}
feature_online_store google::cloud::aiplatform::v1::FeatureOnlineStore const &

Required. The FeatureOnlineStore to create.

feature_online_store_id std::string const &

Required. The ID to use for this FeatureOnlineStore, which will become the final component of the FeatureOnlineStore'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::FeatureOnlineStore > >

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

CreateFeatureOnlineStore(NoAwaitTag, std::string const &, google::cloud::aiplatform::v1::FeatureOnlineStore const &, std::string const &, Options)

Creates a new FeatureOnlineStore in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
parent std::string const &
feature_online_store google::cloud::aiplatform::v1::FeatureOnlineStore const &
feature_online_store_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateFeatureOnlineStore(google::cloud::aiplatform::v1::CreateFeatureOnlineStoreRequest const &, Options)

Creates a new FeatureOnlineStore in a given project and location.

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

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

CreateFeatureOnlineStore(NoAwaitTag, google::cloud::aiplatform::v1::CreateFeatureOnlineStoreRequest const &, Options)

Creates a new FeatureOnlineStore in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::aiplatform::v1::CreateFeatureOnlineStoreRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateFeatureOnlineStore(google::longrunning::Operation const &, Options)

Creates a new FeatureOnlineStore in a given project and location.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::aiplatform::v1::FeatureOnlineStore > >

GetFeatureOnlineStore(std::string const &, Options)

Gets details of a single FeatureOnlineStore.

Parameters
Name Description
name std::string const &

Required. The name of the FeatureOnlineStore resource.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::aiplatform::v1::FeatureOnlineStore >

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

GetFeatureOnlineStore(google::cloud::aiplatform::v1::GetFeatureOnlineStoreRequest const &, Options)

Gets details of a single FeatureOnlineStore.

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

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

ListFeatureOnlineStores(std::string const &, Options)

Lists FeatureOnlineStores in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The resource name of the Location to list FeatureOnlineStores. 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::FeatureOnlineStore >

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

ListFeatureOnlineStores(google::cloud::aiplatform::v1::ListFeatureOnlineStoresRequest, Options)

Lists FeatureOnlineStores in a given project and location.

Parameters
Name Description
request google::cloud::aiplatform::v1::ListFeatureOnlineStoresRequest

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.ListFeatureOnlineStoresRequest. 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::FeatureOnlineStore >

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

UpdateFeatureOnlineStore(google::cloud::aiplatform::v1::FeatureOnlineStore const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single FeatureOnlineStore.

Parameters
Name Description
feature_online_store google::cloud::aiplatform::v1::FeatureOnlineStore const &

Required. The FeatureOnlineStore's name field is used to identify the FeatureOnlineStore to be updated. Format: projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}
update_mask google::protobuf::FieldMask const &

Field mask is used to specify the fields to be overwritten in the FeatureOnlineStore 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
  • description
  • bigtable
  • bigtable.auto_scaling
  • bigtable.enable_multi_region_replica
opts Options

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

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

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

UpdateFeatureOnlineStore(NoAwaitTag, google::cloud::aiplatform::v1::FeatureOnlineStore const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single FeatureOnlineStore.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
feature_online_store google::cloud::aiplatform::v1::FeatureOnlineStore const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateFeatureOnlineStore(google::cloud::aiplatform::v1::UpdateFeatureOnlineStoreRequest const &, Options)

Updates the parameters of a single FeatureOnlineStore.

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

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

UpdateFeatureOnlineStore(NoAwaitTag, google::cloud::aiplatform::v1::UpdateFeatureOnlineStoreRequest const &, Options)

Updates the parameters of a single FeatureOnlineStore.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::aiplatform::v1::UpdateFeatureOnlineStoreRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateFeatureOnlineStore(google::longrunning::Operation const &, Options)

Updates the parameters of a single FeatureOnlineStore.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::aiplatform::v1::FeatureOnlineStore > >

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

Deletes a single FeatureOnlineStore.

The FeatureOnlineStore must not contain any FeatureViews.

Parameters
Name Description
name std::string const &

Required. The name of the FeatureOnlineStore to be deleted. Format: projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}
force bool

If set to true, any FeatureViews and Features for this FeatureOnlineStore will also be deleted. (Otherwise, the request will only work if the FeatureOnlineStore has no FeatureViews.)

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.

DeleteFeatureOnlineStore(NoAwaitTag, std::string const &, bool, Options)

Deletes a single FeatureOnlineStore.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
name std::string const &
force bool
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteFeatureOnlineStore(google::cloud::aiplatform::v1::DeleteFeatureOnlineStoreRequest const &, Options)

Deletes a single FeatureOnlineStore.

The FeatureOnlineStore must not contain any FeatureViews.

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

DeleteFeatureOnlineStore(NoAwaitTag, google::cloud::aiplatform::v1::DeleteFeatureOnlineStoreRequest const &, Options)

Deletes a single FeatureOnlineStore.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::aiplatform::v1::DeleteFeatureOnlineStoreRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteFeatureOnlineStore(google::longrunning::Operation const &, Options)

Deletes a single FeatureOnlineStore.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > >

CreateFeatureView(std::string const &, google::cloud::aiplatform::v1::FeatureView const &, std::string const &, Options)

Creates a new FeatureView in a given FeatureOnlineStore.

Parameters
Name Description
parent std::string const &

Required. The resource name of the FeatureOnlineStore to create FeatureViews. Format: projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}
feature_view google::cloud::aiplatform::v1::FeatureView const &

Required. The FeatureView to create.

feature_view_id std::string const &

Required. The ID to use for the FeatureView, which will become the final component of the FeatureView'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 FeatureOnlineStore.

opts Options

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

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

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

CreateFeatureView(NoAwaitTag, std::string const &, google::cloud::aiplatform::v1::FeatureView const &, std::string const &, Options)

Creates a new FeatureView in a given FeatureOnlineStore.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
parent std::string const &
feature_view google::cloud::aiplatform::v1::FeatureView const &
feature_view_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateFeatureView(google::cloud::aiplatform::v1::CreateFeatureViewRequest const &, Options)

Creates a new FeatureView in a given FeatureOnlineStore.

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

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

CreateFeatureView(NoAwaitTag, google::cloud::aiplatform::v1::CreateFeatureViewRequest const &, Options)

Creates a new FeatureView in a given FeatureOnlineStore.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::aiplatform::v1::CreateFeatureViewRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateFeatureView(google::longrunning::Operation const &, Options)

Creates a new FeatureView in a given FeatureOnlineStore.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::aiplatform::v1::FeatureView > >

GetFeatureView(std::string const &, Options)

Gets details of a single FeatureView.

Parameters
Name Description
name std::string const &

Required. The name of the FeatureView resource. Format: projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}
opts Options

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

Returns
Type Description
StatusOr< google::cloud::aiplatform::v1::FeatureView >

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

GetFeatureView(google::cloud::aiplatform::v1::GetFeatureViewRequest const &, Options)

Gets details of a single FeatureView.

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

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

ListFeatureViews(std::string const &, Options)

Lists FeatureViews in a given FeatureOnlineStore.

Parameters
Name Description
parent std::string const &

Required. The resource name of the FeatureOnlineStore to list FeatureViews. Format: projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}
opts Options

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

Returns
Type Description
StreamRange< google::cloud::aiplatform::v1::FeatureView >

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

ListFeatureViews(google::cloud::aiplatform::v1::ListFeatureViewsRequest, Options)

Lists FeatureViews in a given FeatureOnlineStore.

Parameters
Name Description
request google::cloud::aiplatform::v1::ListFeatureViewsRequest

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.ListFeatureViewsRequest. 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::FeatureView >

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

UpdateFeatureView(google::cloud::aiplatform::v1::FeatureView const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single FeatureView.

Parameters
Name Description
feature_view google::cloud::aiplatform::v1::FeatureView const &

Required. The FeatureView's name field is used to identify the FeatureView to be updated. Format: projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}
update_mask google::protobuf::FieldMask const &

Field mask is used to specify the fields to be overwritten in the FeatureView 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
  • service_agent_type
  • big_query_source
  • big_query_source.uri
  • big_query_source.entity_id_columns
  • feature_registry_source
  • feature_registry_source.feature_groups
  • sync_config
  • sync_config.cron
  • optimized_config.automatic_resources
opts Options

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

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

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

UpdateFeatureView(NoAwaitTag, google::cloud::aiplatform::v1::FeatureView const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single FeatureView.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
feature_view google::cloud::aiplatform::v1::FeatureView const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateFeatureView(google::cloud::aiplatform::v1::UpdateFeatureViewRequest const &, Options)

Updates the parameters of a single FeatureView.

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

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

UpdateFeatureView(NoAwaitTag, google::cloud::aiplatform::v1::UpdateFeatureViewRequest const &, Options)

Updates the parameters of a single FeatureView.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::aiplatform::v1::UpdateFeatureViewRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateFeatureView(google::longrunning::Operation const &, Options)

Updates the parameters of a single FeatureView.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::aiplatform::v1::FeatureView > >

DeleteFeatureView(std::string const &, Options)

Deletes a single FeatureView.

Parameters
Name Description
name std::string const &

Required. The name of the FeatureView to be deleted. Format: projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}
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.

DeleteFeatureView(NoAwaitTag, std::string const &, Options)

Deletes a single FeatureView.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteFeatureView(google::cloud::aiplatform::v1::DeleteFeatureViewRequest const &, Options)

Deletes a single FeatureView.

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

DeleteFeatureView(NoAwaitTag, google::cloud::aiplatform::v1::DeleteFeatureViewRequest const &, Options)

Deletes a single FeatureView.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::aiplatform::v1::DeleteFeatureViewRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteFeatureView(google::longrunning::Operation const &, Options)

Deletes a single FeatureView.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > >

SyncFeatureView(std::string const &, Options)

Triggers on-demand sync for the FeatureView.

Parameters
Name Description
feature_view std::string const &

Required. Format: projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}
opts Options

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

Returns
Type Description
StatusOr< google::cloud::aiplatform::v1::SyncFeatureViewResponse >

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

SyncFeatureView(google::cloud::aiplatform::v1::SyncFeatureViewRequest const &, Options)

Triggers on-demand sync for the FeatureView.

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

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

GetFeatureViewSync(std::string const &, Options)

Gets details of a single FeatureViewSync.

Parameters
Name Description
name std::string const &

Required. The name of the FeatureViewSync resource. Format: projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}
opts Options

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

Returns
Type Description
StatusOr< google::cloud::aiplatform::v1::FeatureViewSync >

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

GetFeatureViewSync(google::cloud::aiplatform::v1::GetFeatureViewSyncRequest const &, Options)

Gets details of a single FeatureViewSync.

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

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

ListFeatureViewSyncs(std::string const &, Options)

Lists FeatureViewSyncs in a given FeatureView.

Parameters
Name Description
parent std::string const &

Required. The resource name of the FeatureView to list FeatureViewSyncs. Format: projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}
opts Options

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

Returns
Type Description
StreamRange< google::cloud::aiplatform::v1::FeatureViewSync >

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

ListFeatureViewSyncs(google::cloud::aiplatform::v1::ListFeatureViewSyncsRequest, Options)

Lists FeatureViewSyncs in a given FeatureView.

Parameters
Name Description
request google::cloud::aiplatform::v1::ListFeatureViewSyncsRequest

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.ListFeatureViewSyncsRequest. 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::FeatureViewSync >

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

ListLocations(google::cloud::location::ListLocationsRequest, Options)

Lists information about the supported locations for this service.

Parameters
Name Description
request google::cloud::location::ListLocationsRequest

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.location.ListLocationsRequest. 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::location::Location >

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

GetLocation(google::cloud::location::GetLocationRequest const &, Options)

Gets information about a location.

Parameters
Name Description
request google::cloud::location::GetLocationRequest 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.location.GetLocationRequest. 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::location::Location >

the result of the RPC. The response message type (google.cloud.location.Location) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

SetIamPolicy(google::iam::v1::SetIamPolicyRequest const &, Options)

Sets the access control policy on the specified resource.

Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters
Name Description
request google::iam::v1::SetIamPolicyRequest 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.iam.v1.SetIamPolicyRequest. 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::iam::v1::Policy >

the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetIamPolicy(google::iam::v1::GetIamPolicyRequest const &, Options)

Gets the access control policy for a resource.

Returns an empty policy if the resource exists and does not have a policy set.

Parameters
Name Description
request google::iam::v1::GetIamPolicyRequest 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.iam.v1.GetIamPolicyRequest. 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::iam::v1::Policy >

the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

TestIamPermissions(google::iam::v1::TestIamPermissionsRequest const &, Options)

Returns permissions that a caller has on the specified resource.

If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters
Name Description
request google::iam::v1::TestIamPermissionsRequest 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.iam.v1.TestIamPermissionsRequest. 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::iam::v1::TestIamPermissionsResponse >

the result of the RPC. The response message type (google.iam.v1.TestIamPermissionsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

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

Lists operations that match the specified filter in the request.

If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters
Name Description
name std::string const &

The name of the operation's parent resource.

filter std::string const &

The standard list filter.

opts Options

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

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

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

ListOperations(google::longrunning::ListOperationsRequest, Options)

Lists operations that match the specified filter in the request.

If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters
Name Description
request google::longrunning::ListOperationsRequest

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.longrunning.ListOperationsRequest. 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::longrunning::Operation >

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

GetOperation(std::string const &, Options)

Gets the latest state of a long-running operation.

Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters
Name Description
name std::string const &

The name of the operation resource.

opts Options

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

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

the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetOperation(google::longrunning::GetOperationRequest const &, Options)

Gets the latest state of a long-running operation.

Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters
Name Description
request google::longrunning::GetOperationRequest 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.longrunning.GetOperationRequest. 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::longrunning::Operation >

the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteOperation(std::string const &, Options)

Deletes a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name Description
name std::string const &

The name of the operation resource to be deleted.

opts Options

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

Returns
Type Description
Status

a Status object. If the request failed, the status contains the details of the failure.

DeleteOperation(google::longrunning::DeleteOperationRequest const &, Options)

Deletes a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name Description
request google::longrunning::DeleteOperationRequest 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.longrunning.DeleteOperationRequest. 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
Status

a Status object. If the request failed, the status contains the details of the failure.

CancelOperation(std::string const &, Options)

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters
Name Description
name std::string const &

The name of the operation resource to be cancelled.

opts Options

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

Returns
Type Description
Status

a Status object. If the request failed, the status contains the details of the failure.

CancelOperation(google::longrunning::CancelOperationRequest const &, Options)

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters
Name Description
request google::longrunning::CancelOperationRequest 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.longrunning.CancelOperationRequest. 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
Status

a Status object. If the request failed, the status contains the details of the failure.

WaitOperation(google::longrunning::WaitOperationRequest const &, Options)

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.

If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Parameters
Name Description
request google::longrunning::WaitOperationRequest 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.longrunning.WaitOperationRequest. 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::longrunning::Operation >

the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.