| GitHub Repository | Product Reference |
Service Description: Service for managing DataStore configuration.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataStoreServiceClient dataStoreServiceClient = DataStoreServiceClient.create()) {
DataStoreName name =
DataStoreName.ofProjectLocationDataStoreName("[PROJECT]", "[LOCATION]", "[DATA_STORE]");
DataStore response = dataStoreServiceClient.getDataStore(name);
}
Note: close() needs to be called on the DataStoreServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
| Method | Description | Method Variants |
|---|---|---|
CreateDataStore |
Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetDataStore |
Gets a DataStore. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListDataStores |
Lists all the DataStores associated with the project. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteDataStore |
Deletes a DataStore. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateDataStore |
Updates a DataStore |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetIamPolicy |
Gets the IAM access control policy for a DataStore. A |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
SetIamPolicy |
Sets the IAM access control policy for a DataStore. A **Important:** When setting a policy directly on a DataStore resource, the only recommended roles in the bindings are: |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of DataStoreServiceSettings to create(). For example:
To customize credentials:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
DataStoreServiceSettings dataStoreServiceSettings =
DataStoreServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
DataStoreServiceClient dataStoreServiceClient =
DataStoreServiceClient.create(dataStoreServiceSettings);
To customize the endpoint:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
DataStoreServiceSettings dataStoreServiceSettings =
DataStoreServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
DataStoreServiceClient dataStoreServiceClient =
DataStoreServiceClient.create(dataStoreServiceSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
DataStoreServiceSettings dataStoreServiceSettings =
DataStoreServiceSettings.newHttpJsonBuilder().build();
DataStoreServiceClient dataStoreServiceClient =
DataStoreServiceClient.create(dataStoreServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Static Methods
create()
public static final DataStoreServiceClient create()Constructs an instance of DataStoreServiceClient with default settings.
| Returns | |
|---|---|
| Type | Description |
DataStoreServiceClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(DataStoreServiceSettings settings)
public static final DataStoreServiceClient create(DataStoreServiceSettings settings)Constructs an instance of DataStoreServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
| Parameter | |
|---|---|
| Name | Description |
settings |
DataStoreServiceSettings |
| Returns | |
|---|---|
| Type | Description |
DataStoreServiceClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(DataStoreServiceStub stub)
public static final DataStoreServiceClient create(DataStoreServiceStub stub)Constructs an instance of DataStoreServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(DataStoreServiceSettings).
| Parameter | |
|---|---|
| Name | Description |
stub |
DataStoreServiceStub |
| Returns | |
|---|---|
| Type | Description |
DataStoreServiceClient |
|
Constructors
DataStoreServiceClient(DataStoreServiceSettings settings)
protected DataStoreServiceClient(DataStoreServiceSettings settings)Constructs an instance of DataStoreServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
| Parameter | |
|---|---|
| Name | Description |
settings |
DataStoreServiceSettings |
DataStoreServiceClient(DataStoreServiceStub stub)
protected DataStoreServiceClient(DataStoreServiceStub stub)| Parameter | |
|---|---|
| Name | Description |
stub |
DataStoreServiceStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)| Parameters | |
|---|---|
| Name | Description |
duration |
long |
unit |
TimeUnit |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
| Exceptions | |
|---|---|
| Type | Description |
InterruptedException |
|
close()
public final void close()createDataStoreAsync(@Nullable CollectionName parent, DataStore dataStore, String dataStoreId)
public final OperationFuture<DataStore,CreateDataStoreMetadata> createDataStoreAsync(@Nullable CollectionName parent, DataStore dataStore, String dataStoreId)Creates a DataStore.
DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataStoreServiceClient dataStoreServiceClient = DataStoreServiceClient.create()) {
CollectionName parent = CollectionName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]");
DataStore dataStore = DataStore.newBuilder().build();
String dataStoreId = "dataStoreId929489618";
DataStore response =
dataStoreServiceClient.createDataStoreAsync(parent, dataStore, dataStoreId).get();
}
| Parameters | |
|---|---|
| Name | Description |
parent |
@org.jspecify.annotations.Nullable com.google.cloud.discoveryengine.v1.CollectionNameRequired. The parent resource name, such as
|
dataStore |
DataStoreRequired. The DataStore to create. |
dataStoreId |
StringRequired. 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. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<DataStore,CreateDataStoreMetadata> |
|
createDataStoreAsync(CreateDataStoreRequest request)
public final OperationFuture<DataStore,CreateDataStoreMetadata> createDataStoreAsync(CreateDataStoreRequest request)Creates a DataStore.
DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataStoreServiceClient dataStoreServiceClient = DataStoreServiceClient.create()) {
CreateDataStoreRequest request =
CreateDataStoreRequest.newBuilder()
.setParent(CollectionName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]").toString())
.setDataStore(DataStore.newBuilder().build())
.setDataStoreId("dataStoreId929489618")
.setCreateAdvancedSiteSearch(true)
.setSkipDefaultSchemaCreation(true)
.build();
DataStore response = dataStoreServiceClient.createDataStoreAsync(request).get();
}
| Parameter | |
|---|---|
| Name | Description |
request |
CreateDataStoreRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<DataStore,CreateDataStoreMetadata> |
|
createDataStoreAsync(String parent, DataStore dataStore, String dataStoreId)
public final OperationFuture<DataStore,CreateDataStoreMetadata> createDataStoreAsync(String parent, DataStore dataStore, String dataStoreId)Creates a DataStore.
DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataStoreServiceClient dataStoreServiceClient = DataStoreServiceClient.create()) {
String parent = CollectionName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]").toString();
DataStore dataStore = DataStore.newBuilder().build();
String dataStoreId = "dataStoreId929489618";
DataStore response =
dataStoreServiceClient.createDataStoreAsync(parent, dataStore, dataStoreId).get();
}
| Parameters | |
|---|---|
| Name | Description |
parent |
StringRequired. The parent resource name, such as
|
dataStore |
DataStoreRequired. The DataStore to create. |
dataStoreId |
StringRequired. 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. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<DataStore,CreateDataStoreMetadata> |
|
createDataStoreCallable()
public final UnaryCallable<CreateDataStoreRequest,Operation> createDataStoreCallable()Creates a DataStore.
DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataStoreServiceClient dataStoreServiceClient = DataStoreServiceClient.create()) {
CreateDataStoreRequest request =
CreateDataStoreRequest.newBuilder()
.setParent(CollectionName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]").toString())
.setDataStore(DataStore.newBuilder().build())
.setDataStoreId("dataStoreId929489618")
.setCreateAdvancedSiteSearch(true)
.setSkipDefaultSchemaCreation(true)
.build();
ApiFuture<Operation> future =
dataStoreServiceClient.createDataStoreCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<CreateDataStoreRequest,Operation> |
|
createDataStoreOperationCallable()
public final OperationCallable<CreateDataStoreRequest,DataStore,CreateDataStoreMetadata> createDataStoreOperationCallable()Creates a DataStore.
DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataStoreServiceClient dataStoreServiceClient = DataStoreServiceClient.create()) {
CreateDataStoreRequest request =
CreateDataStoreRequest.newBuilder()
.setParent(CollectionName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]").toString())
.setDataStore(DataStore.newBuilder().build())
.setDataStoreId("dataStoreId929489618")
.setCreateAdvancedSiteSearch(true)
.setSkipDefaultSchemaCreation(true)
.build();
OperationFuture<DataStore, CreateDataStoreMetadata> future =
dataStoreServiceClient.createDataStoreOperationCallable().futureCall(request);
// Do something.
DataStore response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
OperationCallable<CreateDataStoreRequest,DataStore,CreateDataStoreMetadata> |
|
deleteDataStoreAsync(@Nullable DataStoreName name)
public final OperationFuture<Empty,DeleteDataStoreMetadata> deleteDataStoreAsync(@Nullable DataStoreName name)Deletes a DataStore.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataStoreServiceClient dataStoreServiceClient = DataStoreServiceClient.create()) {
DataStoreName name =
DataStoreName.ofProjectLocationDataStoreName("[PROJECT]", "[LOCATION]", "[DATA_STORE]");
dataStoreServiceClient.deleteDataStoreAsync(name).get();
}
| Parameter | |
|---|---|
| Name | Description |
name |
@org.jspecify.annotations.Nullable com.google.cloud.discoveryengine.v1.DataStoreNameRequired. Full resource name of
DataStore, such as
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. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Empty,DeleteDataStoreMetadata> |
|
deleteDataStoreAsync(DeleteDataStoreRequest request)
public final OperationFuture<Empty,DeleteDataStoreMetadata> deleteDataStoreAsync(DeleteDataStoreRequest request)Deletes a DataStore.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataStoreServiceClient dataStoreServiceClient = DataStoreServiceClient.create()) {
DeleteDataStoreRequest request =
DeleteDataStoreRequest.newBuilder()
.setName(
DataStoreName.ofProjectLocationDataStoreName(
"[PROJECT]", "[LOCATION]", "[DATA_STORE]")
.toString())
.build();
dataStoreServiceClient.deleteDataStoreAsync(request).get();
}
| Parameter | |
|---|---|
| Name | Description |
request |
DeleteDataStoreRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Empty,DeleteDataStoreMetadata> |
|
deleteDataStoreAsync(String name)
public final OperationFuture<Empty,DeleteDataStoreMetadata> deleteDataStoreAsync(String name)Deletes a DataStore.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataStoreServiceClient dataStoreServiceClient = DataStoreServiceClient.create()) {
String name =
DataStoreName.ofProjectLocationDataStoreName("[PROJECT]", "[LOCATION]", "[DATA_STORE]")
.toString();
dataStoreServiceClient.deleteDataStoreAsync(name).get();
}
| Parameter | |
|---|---|
| Name | Description |
name |
StringRequired. Full resource name of
DataStore, such as
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. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Empty,DeleteDataStoreMetadata> |
|
deleteDataStoreCallable()
public final UnaryCallable<DeleteDataStoreRequest,Operation> deleteDataStoreCallable()Deletes a DataStore.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataStoreServiceClient dataStoreServiceClient = DataStoreServiceClient.create()) {
DeleteDataStoreRequest request =
DeleteDataStoreRequest.newBuilder()
.setName(
DataStoreName.ofProjectLocationDataStoreName(
"[PROJECT]", "[LOCATION]", "[DATA_STORE]")
.toString())
.build();
ApiFuture<Operation> future =
dataStoreServiceClient.deleteDataStoreCallable().futureCall(request);
// Do something.
future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<DeleteDataStoreRequest,Operation> |
|
deleteDataStoreOperationCallable()
public final OperationCallable<DeleteDataStoreRequest,Empty,DeleteDataStoreMetadata> deleteDataStoreOperationCallable()Deletes a DataStore.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataStoreServiceClient dataStoreServiceClient = DataStoreServiceClient.create()) {
DeleteDataStoreRequest request =
DeleteDataStoreRequest.newBuilder()
.setName(
DataStoreName.ofProjectLocationDataStoreName(
"[PROJECT]", "[LOCATION]", "[DATA_STORE]")
.toString())
.build();
OperationFuture<Empty, DeleteDataStoreMetadata> future =
dataStoreServiceClient.deleteDataStoreOperationCallable().futureCall(request);
// Do something.
future.get();
}
| Returns | |
|---|---|
| Type | Description |
OperationCallable<DeleteDataStoreRequest,Empty,DeleteDataStoreMetadata> |
|
getDataStore(@Nullable DataStoreName name)
public final DataStore getDataStore(@Nullable DataStoreName name)Gets a DataStore.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataStoreServiceClient dataStoreServiceClient = DataStoreServiceClient.create()) {
DataStoreName name =
DataStoreName.ofProjectLocationDataStoreName("[PROJECT]", "[LOCATION]", "[DATA_STORE]");
DataStore response = dataStoreServiceClient.getDataStore(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
@org.jspecify.annotations.Nullable com.google.cloud.discoveryengine.v1.DataStoreNameRequired. Full resource name of
DataStore, such as
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. |
| Returns | |
|---|---|
| Type | Description |
DataStore |
|
getDataStore(GetDataStoreRequest request)
public final DataStore getDataStore(GetDataStoreRequest request)Gets a DataStore.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataStoreServiceClient dataStoreServiceClient = DataStoreServiceClient.create()) {
GetDataStoreRequest request =
GetDataStoreRequest.newBuilder()
.setName(
DataStoreName.ofProjectLocationDataStoreName(
"[PROJECT]", "[LOCATION]", "[DATA_STORE]")
.toString())
.build();
DataStore response = dataStoreServiceClient.getDataStore(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
GetDataStoreRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
DataStore |
|
getDataStore(String name)
public final DataStore getDataStore(String name)Gets a DataStore.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataStoreServiceClient dataStoreServiceClient = DataStoreServiceClient.create()) {
String name =
DataStoreName.ofProjectLocationDataStoreName("[PROJECT]", "[LOCATION]", "[DATA_STORE]")
.toString();
DataStore response = dataStoreServiceClient.getDataStore(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
StringRequired. Full resource name of
DataStore, such as
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. |
| Returns | |
|---|---|
| Type | Description |
DataStore |
|
getDataStoreCallable()
public final UnaryCallable<GetDataStoreRequest,DataStore> getDataStoreCallable()Gets a DataStore.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataStoreServiceClient dataStoreServiceClient = DataStoreServiceClient.create()) {
GetDataStoreRequest request =
GetDataStoreRequest.newBuilder()
.setName(
DataStoreName.ofProjectLocationDataStoreName(
"[PROJECT]", "[LOCATION]", "[DATA_STORE]")
.toString())
.build();
ApiFuture<DataStore> future =
dataStoreServiceClient.getDataStoreCallable().futureCall(request);
// Do something.
DataStore response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<GetDataStoreRequest,DataStore> |
|
getHttpJsonOperationsClient()
public final OperationsClient getHttpJsonOperationsClient()Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
| Returns | |
|---|---|
| Type | Description |
OperationsClient |
|
getIamPolicy(@Nullable ResourceName resource)
public final Policy getIamPolicy(@Nullable ResourceName resource)Gets the IAM access control policy for a
DataStore. A NOT_FOUND error is returned if the
resource does not exist. An empty policy is returned if the resource exists but does not have a
policy set on it.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataStoreServiceClient dataStoreServiceClient = DataStoreServiceClient.create()) {
ResourceName resource =
DataStoreName.ofProjectLocationCollectionDataStoreName(
"[PROJECT]", "[LOCATION]", "[COLLECTION]", "[DATA_STORE]");
Policy response = dataStoreServiceClient.getIamPolicy(resource);
}
| Parameter | |
|---|---|
| Name | Description |
resource |
@org.jspecify.annotations.Nullable com.google.api.resourcenames.ResourceNameREQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. |
| Returns | |
|---|---|
| Type | Description |
com.google.iam.v1.Policy |
|
getIamPolicy(GetIamPolicyRequest request)
public final Policy getIamPolicy(GetIamPolicyRequest request)Gets the IAM access control policy for a
DataStore. A NOT_FOUND error is returned if the
resource does not exist. An empty policy is returned if the resource exists but does not have a
policy set on it.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataStoreServiceClient dataStoreServiceClient = DataStoreServiceClient.create()) {
GetIamPolicyRequest request =
GetIamPolicyRequest.newBuilder()
.setResource(
DataStoreName.ofProjectLocationCollectionDataStoreName(
"[PROJECT]", "[LOCATION]", "[COLLECTION]", "[DATA_STORE]")
.toString())
.setOptions(GetPolicyOptions.newBuilder().build())
.build();
Policy response = dataStoreServiceClient.getIamPolicy(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
com.google.iam.v1.GetIamPolicyRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
com.google.iam.v1.Policy |
|
getIamPolicy(String resource)
public final Policy getIamPolicy(String resource)Gets the IAM access control policy for a
DataStore. A NOT_FOUND error is returned if the
resource does not exist. An empty policy is returned if the resource exists but does not have a
policy set on it.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataStoreServiceClient dataStoreServiceClient = DataStoreServiceClient.create()) {
String resource = AclConfigName.of("[PROJECT]", "[LOCATION]").toString();
Policy response = dataStoreServiceClient.getIamPolicy(resource);
}
| Parameter | |
|---|---|
| Name | Description |
resource |
StringREQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. |
| Returns | |
|---|---|
| Type | Description |
com.google.iam.v1.Policy |
|
getIamPolicyCallable()
public final UnaryCallable<GetIamPolicyRequest,Policy> getIamPolicyCallable()Gets the IAM access control policy for a
DataStore. A NOT_FOUND error is returned if the
resource does not exist. An empty policy is returned if the resource exists but does not have a
policy set on it.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataStoreServiceClient dataStoreServiceClient = DataStoreServiceClient.create()) {
GetIamPolicyRequest request =
GetIamPolicyRequest.newBuilder()
.setResource(
DataStoreName.ofProjectLocationCollectionDataStoreName(
"[PROJECT]", "[LOCATION]", "[COLLECTION]", "[DATA_STORE]")
.toString())
.setOptions(GetPolicyOptions.newBuilder().build())
.build();
ApiFuture<Policy> future = dataStoreServiceClient.getIamPolicyCallable().futureCall(request);
// Do something.
Policy response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> |
|
getOperationsClient()
public final OperationsClient getOperationsClient()Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
| Returns | |
|---|---|
| Type | Description |
OperationsClient |
|
getSettings()
public final @Nullable DataStoreServiceSettings getSettings()| Returns | |
|---|---|
| Type | Description |
@org.jspecify.annotations.Nullable com.google.cloud.discoveryengine.v1.DataStoreServiceSettings |
|
getStub()
public DataStoreServiceStub getStub()| Returns | |
|---|---|
| Type | Description |
DataStoreServiceStub |
|
isShutdown()
public boolean isShutdown()| Returns | |
|---|---|
| Type | Description |
boolean |
|
isTerminated()
public boolean isTerminated()| Returns | |
|---|---|
| Type | Description |
boolean |
|
listDataStores(@Nullable CollectionName parent)
public final DataStoreServiceClient.ListDataStoresPagedResponse listDataStores(@Nullable CollectionName parent)Lists all the DataStores associated with the project.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataStoreServiceClient dataStoreServiceClient = DataStoreServiceClient.create()) {
CollectionName parent = CollectionName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]");
for (DataStore element : dataStoreServiceClient.listDataStores(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
@org.jspecify.annotations.Nullable com.google.cloud.discoveryengine.v1.CollectionNameRequired. The parent branch resource name, such as
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. |
| Returns | |
|---|---|
| Type | Description |
DataStoreServiceClient.ListDataStoresPagedResponse |
|
listDataStores(ListDataStoresRequest request)
public final DataStoreServiceClient.ListDataStoresPagedResponse listDataStores(ListDataStoresRequest request)Lists all the DataStores associated with the project.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataStoreServiceClient dataStoreServiceClient = DataStoreServiceClient.create()) {
ListDataStoresRequest request =
ListDataStoresRequest.newBuilder()
.setParent(CollectionName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.build();
for (DataStore element : dataStoreServiceClient.listDataStores(request).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
request |
ListDataStoresRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
DataStoreServiceClient.ListDataStoresPagedResponse |
|
listDataStores(String parent)
public final DataStoreServiceClient.ListDataStoresPagedResponse listDataStores(String parent)Lists all the DataStores associated with the project.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataStoreServiceClient dataStoreServiceClient = DataStoreServiceClient.create()) {
String parent = CollectionName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]").toString();
for (DataStore element : dataStoreServiceClient.listDataStores(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
StringRequired. The parent branch resource name, such as
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. |
| Returns | |
|---|---|
| Type | Description |
DataStoreServiceClient.ListDataStoresPagedResponse |
|
listDataStoresCallable()
public final UnaryCallable<ListDataStoresRequest,ListDataStoresResponse> listDataStoresCallable()Lists all the DataStores associated with the project.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataStoreServiceClient dataStoreServiceClient = DataStoreServiceClient.create()) {
ListDataStoresRequest request =
ListDataStoresRequest.newBuilder()
.setParent(CollectionName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.build();
while (true) {
ListDataStoresResponse response =
dataStoreServiceClient.listDataStoresCallable().call(request);
for (DataStore element : response.getDataStoresList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListDataStoresRequest,ListDataStoresResponse> |
|
listDataStoresPagedCallable()
public final UnaryCallable<ListDataStoresRequest,DataStoreServiceClient.ListDataStoresPagedResponse> listDataStoresPagedCallable()Lists all the DataStores associated with the project.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataStoreServiceClient dataStoreServiceClient = DataStoreServiceClient.create()) {
ListDataStoresRequest request =
ListDataStoresRequest.newBuilder()
.setParent(CollectionName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.build();
ApiFuture<DataStore> future =
dataStoreServiceClient.listDataStoresPagedCallable().futureCall(request);
// Do something.
for (DataStore element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListDataStoresRequest,ListDataStoresPagedResponse> |
|
setIamPolicy(@Nullable ResourceName resource, Policy policy)
public final Policy setIamPolicy(@Nullable ResourceName resource, Policy policy)Sets the IAM access control policy for a
DataStore. A NOT_FOUND error is returned if the
resource does not exist.
**Important:** When setting a policy directly on a DataStore resource, the
only recommended roles in the bindings are: roles/discoveryengine.admin
roles/discoveryengine.agentspaceAdmin roles/discoveryengine.viewer
roles/discoveryengine.agentspaceViewer roles/discoveryengine.user
roles/discoveryengine.agentspaceUser Attempting to grant any other role will result in a
warning in logging.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataStoreServiceClient dataStoreServiceClient = DataStoreServiceClient.create()) {
ResourceName resource =
DataStoreName.ofProjectLocationCollectionDataStoreName(
"[PROJECT]", "[LOCATION]", "[COLLECTION]", "[DATA_STORE]");
Policy policy = Policy.newBuilder().build();
Policy response = dataStoreServiceClient.setIamPolicy(resource, policy);
}
| Parameters | |
|---|---|
| Name | Description |
resource |
@org.jspecify.annotations.Nullable com.google.api.resourcenames.ResourceNameREQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. |
policy |
com.google.iam.v1.PolicyREQUIRED: The complete policy to be applied to the |
| Returns | |
|---|---|
| Type | Description |
com.google.iam.v1.Policy |
|
setIamPolicy(SetIamPolicyRequest request)
public final Policy setIamPolicy(SetIamPolicyRequest request)Sets the IAM access control policy for a
DataStore. A NOT_FOUND error is returned if the
resource does not exist.
**Important:** When setting a policy directly on a DataStore resource, the
only recommended roles in the bindings are: roles/discoveryengine.admin
roles/discoveryengine.agentspaceAdmin roles/discoveryengine.viewer
roles/discoveryengine.agentspaceViewer roles/discoveryengine.user
roles/discoveryengine.agentspaceUser Attempting to grant any other role will result in a
warning in logging.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataStoreServiceClient dataStoreServiceClient = DataStoreServiceClient.create()) {
SetIamPolicyRequest request =
SetIamPolicyRequest.newBuilder()
.setResource(
DataStoreName.ofProjectLocationCollectionDataStoreName(
"[PROJECT]", "[LOCATION]", "[COLLECTION]", "[DATA_STORE]")
.toString())
.setPolicy(Policy.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
Policy response = dataStoreServiceClient.setIamPolicy(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
com.google.iam.v1.SetIamPolicyRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
com.google.iam.v1.Policy |
|
setIamPolicy(String resource, Policy policy)
public final Policy setIamPolicy(String resource, Policy policy)Sets the IAM access control policy for a
DataStore. A NOT_FOUND error is returned if the
resource does not exist.
**Important:** When setting a policy directly on a DataStore resource, the
only recommended roles in the bindings are: roles/discoveryengine.admin
roles/discoveryengine.agentspaceAdmin roles/discoveryengine.viewer
roles/discoveryengine.agentspaceViewer roles/discoveryengine.user
roles/discoveryengine.agentspaceUser Attempting to grant any other role will result in a
warning in logging.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataStoreServiceClient dataStoreServiceClient = DataStoreServiceClient.create()) {
String resource = AclConfigName.of("[PROJECT]", "[LOCATION]").toString();
Policy policy = Policy.newBuilder().build();
Policy response = dataStoreServiceClient.setIamPolicy(resource, policy);
}
| Parameters | |
|---|---|
| Name | Description |
resource |
StringREQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. |
policy |
com.google.iam.v1.PolicyREQUIRED: The complete policy to be applied to the |
| Returns | |
|---|---|
| Type | Description |
com.google.iam.v1.Policy |
|
setIamPolicyCallable()
public final UnaryCallable<SetIamPolicyRequest,Policy> setIamPolicyCallable()Sets the IAM access control policy for a
DataStore. A NOT_FOUND error is returned if the
resource does not exist.
**Important:** When setting a policy directly on a DataStore resource, the
only recommended roles in the bindings are: roles/discoveryengine.admin
roles/discoveryengine.agentspaceAdmin roles/discoveryengine.viewer
roles/discoveryengine.agentspaceViewer roles/discoveryengine.user
roles/discoveryengine.agentspaceUser Attempting to grant any other role will result in a
warning in logging.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataStoreServiceClient dataStoreServiceClient = DataStoreServiceClient.create()) {
SetIamPolicyRequest request =
SetIamPolicyRequest.newBuilder()
.setResource(
DataStoreName.ofProjectLocationCollectionDataStoreName(
"[PROJECT]", "[LOCATION]", "[COLLECTION]", "[DATA_STORE]")
.toString())
.setPolicy(Policy.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<Policy> future = dataStoreServiceClient.setIamPolicyCallable().futureCall(request);
// Do something.
Policy response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> |
|
shutdown()
public void shutdown()shutdownNow()
public void shutdownNow()updateDataStore(DataStore dataStore, FieldMask updateMask)
public final DataStore updateDataStore(DataStore dataStore, FieldMask updateMask)Updates a DataStore
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataStoreServiceClient dataStoreServiceClient = DataStoreServiceClient.create()) {
DataStore dataStore = DataStore.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
DataStore response = dataStoreServiceClient.updateDataStore(dataStore, updateMask);
}
| Parameters | |
|---|---|
| Name | Description |
dataStore |
DataStoreRequired. 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. |
updateMask |
FieldMaskIndicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. |
| Returns | |
|---|---|
| Type | Description |
DataStore |
|
updateDataStore(UpdateDataStoreRequest request)
public final DataStore updateDataStore(UpdateDataStoreRequest request)Updates a DataStore
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataStoreServiceClient dataStoreServiceClient = DataStoreServiceClient.create()) {
UpdateDataStoreRequest request =
UpdateDataStoreRequest.newBuilder()
.setDataStore(DataStore.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
DataStore response = dataStoreServiceClient.updateDataStore(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
UpdateDataStoreRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
DataStore |
|
updateDataStoreCallable()
public final UnaryCallable<UpdateDataStoreRequest,DataStore> updateDataStoreCallable()Updates a DataStore
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataStoreServiceClient dataStoreServiceClient = DataStoreServiceClient.create()) {
UpdateDataStoreRequest request =
UpdateDataStoreRequest.newBuilder()
.setDataStore(DataStore.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<DataStore> future =
dataStoreServiceClient.updateDataStoreCallable().futureCall(request);
// Do something.
DataStore response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<UpdateDataStoreRequest,DataStore> |
|