Class DataStoreServiceClient (2.30.0)

Service for managing DataStore configuration.

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

DataStoreServiceClient(DataStoreServiceClient const &)

Copy and move support

Parameter
Name	Description
	`DataStoreServiceClient const &`

DataStoreServiceClient(DataStoreServiceClient &&)

Copy and move support

Parameter
Name	Description
	`DataStoreServiceClient &&`

DataStoreServiceClient(std::shared_ptr< DataStoreServiceConnection >, Options)

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

Operators

operator=(DataStoreServiceClient const &)

Copy and move support

Parameter
Name	Description
	`DataStoreServiceClient const &`

Returns
Type	Description
`DataStoreServiceClient &`

operator=(DataStoreServiceClient &&)

Copy and move support

Parameter
Name	Description
	`DataStoreServiceClient &&`

Returns
Type	Description
`DataStoreServiceClient &`

Functions

CreateDataStore(std::string const &, google::cloud::discoveryengine::v1::DataStore const &, std::string const &, Options)

Creates a DataStore.

DataStore is for storing [Documents][google.cloud.discoveryengine.v1.Document]. To serve these documents for Search, or Recommendation use case, an [Engine][google.cloud.discoveryengine.v1.Engine] needs to be created separately.

Parameters
Name	Description
`parent`	`std::string const &` Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`.
`data_store`	`google::cloud::discoveryengine::v1::DataStore const &` Required. The DataStore to create.
`data_store_id`	`std::string const &` Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::discoveryengine::v1::DataStore > >

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

CreateDataStore(NoAwaitTag, std::string const &, google::cloud::discoveryengine::v1::DataStore const &, std::string const &, Options)

Creates a DataStore.

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 &`
`data_store`	`google::cloud::discoveryengine::v1::DataStore const &`
`data_store_id`	`std::string const &`
`opts`	`Options`

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

CreateDataStore(google::cloud::discoveryengine::v1::CreateDataStoreRequest const &, Options)

Creates a DataStore.

Parameters
Name	Description
`request`	`google::cloud::discoveryengine::v1::CreateDataStoreRequest 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.discoveryengine.v1.CreateDataStoreRequest. 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::discoveryengine::v1::DataStore > >

CreateDataStore(NoAwaitTag, google::cloud::discoveryengine::v1::CreateDataStoreRequest const &, Options)

Creates a DataStore.

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::discoveryengine::v1::CreateDataStoreRequest const &`
`opts`	`Options`

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

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

Creates a DataStore.

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::discoveryengine::v1::DataStore > >`

GetDataStore(std::string const &, Options)

Gets a DataStore.

Parameters
Name	Description
`name`	`std::string const &` Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

GetDataStore(google::cloud::discoveryengine::v1::GetDataStoreRequest const &, Options)

Gets a DataStore.

Parameters
Name	Description
`request`	`google::cloud::discoveryengine::v1::GetDataStoreRequest 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.discoveryengine.v1.GetDataStoreRequest. 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::discoveryengine::v1::DataStore >`	the result of the RPC. The response message type (google.cloud.discoveryengine.v1.DataStore) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListDataStores(std::string const &, Options)

Lists all the DataStores associated with the project.

Parameters
Name	Description
`parent`	`std::string const &` Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection_id}`. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::discoveryengine::v1::DataStore >

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

ListDataStores(google::cloud::discoveryengine::v1::ListDataStoresRequest, Options)

Lists all the DataStores associated with the project.

Parameters
Name	Description
`request`	`google::cloud::discoveryengine::v1::ListDataStoresRequest` 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.discoveryengine.v1.ListDataStoresRequest. 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::discoveryengine::v1::DataStore >

DeleteDataStore(std::string const &, Options)

Deletes a DataStore.

Parameters
Name	Description
`name`	`std::string const &` Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to delete the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a NOT_FOUND error is returned.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::discoveryengine::v1::DeleteDataStoreMetadata > >

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

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

Deletes a DataStore.

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

DeleteDataStore(google::cloud::discoveryengine::v1::DeleteDataStoreRequest const &, Options)

Deletes a DataStore.

Parameters
Name	Description
`request`	`google::cloud::discoveryengine::v1::DeleteDataStoreRequest 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.discoveryengine.v1.DeleteDataStoreRequest. 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::discoveryengine::v1::DeleteDataStoreMetadata > >

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

DeleteDataStore(NoAwaitTag, google::cloud::discoveryengine::v1::DeleteDataStoreRequest const &, Options)

Deletes a DataStore.

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::discoveryengine::v1::DeleteDataStoreRequest const &`
`opts`	`Options`

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

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

Deletes a DataStore.

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::discoveryengine::v1::DeleteDataStoreMetadata > >`

UpdateDataStore(google::cloud::discoveryengine::v1::DataStore const &, google::protobuf::FieldMask const &, Options)

Updates a DataStore

Parameters
Name	Description
`data_store`	`google::cloud::discoveryengine::v1::DataStore const &` Required. The DataStore to update. If the caller does not have permission to update the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the DataStore to update does not exist, a NOT_FOUND error is returned.
`update_mask`	`google::protobuf::FieldMask const &` Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

UpdateDataStore(google::cloud::discoveryengine::v1::UpdateDataStoreRequest const &, Options)

Updates a DataStore

Parameters
Name	Description
`request`	`google::cloud::discoveryengine::v1::UpdateDataStoreRequest 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.discoveryengine.v1.UpdateDataStoreRequest. 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::discoveryengine::v1::DataStore >`	the result of the RPC. The response message type (google.cloud.discoveryengine.v1.DataStore) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.