com.google.cloud.discoveryengine.v1beta

Class DataStoreServiceClient

java.lang.Object

com.google.cloud.discoveryengine.v1beta.DataStoreServiceClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@BetaApi
 @Generated(value="by gapic-generator-java")
public class DataStoreServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: Service for managing [DataStore][google.cloud.discoveryengine.v1beta.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().

Methods

Method	Description	Method Variants
CreateDataStore	Creates a [DataStore][google.cloud.discoveryengine.v1beta.DataStore]. DataStore is for storing [Documents][google.cloud.discoveryengine.v1beta.Document]. To serve these documents for Search, or Recommendation use case, an [Engine][google.cloud.discoveryengine.v1beta.Engine] needs to be created separately.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createDataStoreAsync(CreateDataStoreRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. createDataStoreAsync(CollectionName parent, DataStore dataStore, String dataStoreId) createDataStoreAsync(String parent, DataStore dataStore, String dataStoreId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createDataStoreOperationCallable() createDataStoreCallable()
GetDataStore	Gets a [DataStore][google.cloud.discoveryengine.v1beta.DataStore].	Request object method variants only take one parameter, a request object, which must be constructed before the call. getDataStore(GetDataStoreRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getDataStore(DataStoreName name) getDataStore(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getDataStoreCallable()
ListDataStores	Lists all the [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s associated with the project.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listDataStores(ListDataStoresRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listDataStores(CollectionName parent) listDataStores(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listDataStoresPagedCallable() listDataStoresCallable()
DeleteDataStore	Deletes a [DataStore][google.cloud.discoveryengine.v1beta.DataStore].	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteDataStoreAsync(DeleteDataStoreRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. deleteDataStoreAsync(DataStoreName name) deleteDataStoreAsync(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteDataStoreOperationCallable() deleteDataStoreCallable()
UpdateDataStore	Updates a [DataStore][google.cloud.discoveryengine.v1beta.DataStore]	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateDataStore(UpdateDataStoreRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateDataStore(DataStore dataStore, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateDataStoreCallable()

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataStoreServiceClient.ListDataStoresFixedSizeCollection
static class	DataStoreServiceClient.ListDataStoresPage
static class	DataStoreServiceClient.ListDataStoresPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DataStoreServiceClient(DataStoreServiceSettings settings) Constructs an instance of DataStoreServiceClient, using the given settings.
protected	DataStoreServiceClient(DataStoreServiceStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static DataStoreServiceClient	create() Constructs an instance of DataStoreServiceClient with default settings.
static DataStoreServiceClient	create(DataStoreServiceSettings settings) Constructs an instance of DataStoreServiceClient, using the given settings.
static DataStoreServiceClient	create(DataStoreServiceStub stub) Constructs an instance of DataStoreServiceClient, using the given stub for making calls.
com.google.api.gax.longrunning.OperationFuture<DataStore,CreateDataStoreMetadata>	createDataStoreAsync(CollectionName parent, DataStore dataStore, String dataStoreId) Creates a [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
com.google.api.gax.longrunning.OperationFuture<DataStore,CreateDataStoreMetadata>	createDataStoreAsync(CreateDataStoreRequest request) Creates a [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
com.google.api.gax.longrunning.OperationFuture<DataStore,CreateDataStoreMetadata>	createDataStoreAsync(String parent, DataStore dataStore, String dataStoreId) Creates a [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
com.google.api.gax.rpc.UnaryCallable<CreateDataStoreRequest,com.google.longrunning.Operation>	createDataStoreCallable() Creates a [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
com.google.api.gax.rpc.OperationCallable<CreateDataStoreRequest,DataStore,CreateDataStoreMetadata>	createDataStoreOperationCallable() Creates a [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteDataStoreMetadata>	deleteDataStoreAsync(DataStoreName name) Deletes a [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteDataStoreMetadata>	deleteDataStoreAsync(DeleteDataStoreRequest request) Deletes a [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteDataStoreMetadata>	deleteDataStoreAsync(String name) Deletes a [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
com.google.api.gax.rpc.UnaryCallable<DeleteDataStoreRequest,com.google.longrunning.Operation>	deleteDataStoreCallable() Deletes a [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
com.google.api.gax.rpc.OperationCallable<DeleteDataStoreRequest,com.google.protobuf.Empty,DeleteDataStoreMetadata>	deleteDataStoreOperationCallable() Deletes a [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
DataStore	getDataStore(DataStoreName name) Gets a [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
DataStore	getDataStore(GetDataStoreRequest request) Gets a [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
DataStore	getDataStore(String name) Gets a [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
com.google.api.gax.rpc.UnaryCallable<GetDataStoreRequest,DataStore>	getDataStoreCallable() Gets a [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
com.google.api.gax.httpjson.longrunning.OperationsClient	getHttpJsonOperationsClient() Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
com.google.longrunning.OperationsClient	getOperationsClient() Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
DataStoreServiceSettings	getSettings()
DataStoreServiceStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
DataStoreServiceClient.ListDataStoresPagedResponse	listDataStores(CollectionName parent) Lists all the [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s associated with the project.
DataStoreServiceClient.ListDataStoresPagedResponse	listDataStores(ListDataStoresRequest request) Lists all the [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s associated with the project.
DataStoreServiceClient.ListDataStoresPagedResponse	listDataStores(String parent) Lists all the [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s associated with the project.
com.google.api.gax.rpc.UnaryCallable<ListDataStoresRequest,ListDataStoresResponse>	listDataStoresCallable() Lists all the [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s associated with the project.
com.google.api.gax.rpc.UnaryCallable<ListDataStoresRequest,DataStoreServiceClient.ListDataStoresPagedResponse>	listDataStoresPagedCallable() Lists all the [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s associated with the project.
void	shutdown()
void	shutdownNow()
DataStore	updateDataStore(DataStore dataStore, com.google.protobuf.FieldMask updateMask) Updates a [DataStore][google.cloud.discoveryengine.v1beta.DataStore]
DataStore	updateDataStore(UpdateDataStoreRequest request) Updates a [DataStore][google.cloud.discoveryengine.v1beta.DataStore]
com.google.api.gax.rpc.UnaryCallable<UpdateDataStoreRequest,DataStore>	updateDataStoreCallable() Updates a [DataStore][google.cloud.discoveryengine.v1beta.DataStore]

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DataStoreServiceClient

protected DataStoreServiceClient(DataStoreServiceSettings settings)
                          throws IOException

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.

Throws:

IOException

DataStoreServiceClient

protected DataStoreServiceClient(DataStoreServiceStub stub)

Method Detail

create

public static final DataStoreServiceClient create()
                                           throws IOException

Constructs an instance of DataStoreServiceClient with default settings.

Throws:

IOException

create

public static final DataStoreServiceClient create(DataStoreServiceSettings settings)
                                           throws IOException

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.

Throws:

IOException

create

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

getSettings

public final DataStoreServiceSettings getSettings()

getStub

public DataStoreServiceStub getStub()

getOperationsClient

public final com.google.longrunning.OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

getHttpJsonOperationsClient

@BetaApi
public final com.google.api.gax.httpjson.longrunning.OperationsClient getHttpJsonOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

createDataStoreAsync

public final com.google.api.gax.longrunning.OperationFuture<DataStore,CreateDataStoreMetadata> createDataStoreAsync(CollectionName parent,
                                                                                                                    DataStore dataStore,
                                                                                                                    String dataStoreId)

Creates a [DataStore][google.cloud.discoveryengine.v1beta.DataStore].

DataStore is for storing [Documents][google.cloud.discoveryengine.v1beta.Document]. To serve these documents for Search, or Recommendation use case, an [Engine][google.cloud.discoveryengine.v1beta.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:

parent - Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`.

dataStore - Required. The [DataStore][google.cloud.discoveryengine.v1beta.DataStore] to create.

dataStoreId - Required. The ID to use for the [DataStore][google.cloud.discoveryengine.v1beta.DataStore], which will become the final component of the [DataStore][google.cloud.discoveryengine.v1beta.DataStore]'s resource name.

This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createDataStoreAsync

public final com.google.api.gax.longrunning.OperationFuture<DataStore,CreateDataStoreMetadata> createDataStoreAsync(String parent,
                                                                                                                    DataStore dataStore,
                                                                                                                    String dataStoreId)

Creates a [DataStore][google.cloud.discoveryengine.v1beta.DataStore].

DataStore is for storing [Documents][google.cloud.discoveryengine.v1beta.Document]. To serve these documents for Search, or Recommendation use case, an [Engine][google.cloud.discoveryengine.v1beta.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:

parent - Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`.

dataStore - Required. The [DataStore][google.cloud.discoveryengine.v1beta.DataStore] to create.

dataStoreId - Required. The ID to use for the [DataStore][google.cloud.discoveryengine.v1beta.DataStore], which will become the final component of the [DataStore][google.cloud.discoveryengine.v1beta.DataStore]'s resource name.

This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createDataStoreAsync

public final com.google.api.gax.longrunning.OperationFuture<DataStore,CreateDataStoreMetadata> createDataStoreAsync(CreateDataStoreRequest request)

Creates a [DataStore][google.cloud.discoveryengine.v1beta.DataStore].

DataStore is for storing [Documents][google.cloud.discoveryengine.v1beta.Document]. To serve these documents for Search, or Recommendation use case, an [Engine][google.cloud.discoveryengine.v1beta.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)
           .build();
   DataStore response = dataStoreServiceClient.createDataStoreAsync(request).get();
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createDataStoreOperationCallable

public final com.google.api.gax.rpc.OperationCallable<CreateDataStoreRequest,DataStore,CreateDataStoreMetadata> createDataStoreOperationCallable()

Creates a [DataStore][google.cloud.discoveryengine.v1beta.DataStore].

DataStore is for storing [Documents][google.cloud.discoveryengine.v1beta.Document]. To serve these documents for Search, or Recommendation use case, an [Engine][google.cloud.discoveryengine.v1beta.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)
           .build();
   OperationFuture<DataStore, CreateDataStoreMetadata> future =
       dataStoreServiceClient.createDataStoreOperationCallable().futureCall(request);
   // Do something.
   DataStore response = future.get();
 }
 

createDataStoreCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateDataStoreRequest,com.google.longrunning.Operation> createDataStoreCallable()

Creates a [DataStore][google.cloud.discoveryengine.v1beta.DataStore].

DataStore is for storing [Documents][google.cloud.discoveryengine.v1beta.Document]. To serve these documents for Search, or Recommendation use case, an [Engine][google.cloud.discoveryengine.v1beta.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)
           .build();
   ApiFuture<Operation> future =
       dataStoreServiceClient.createDataStoreCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

getDataStore

public final DataStore getDataStore(DataStoreName name)

Gets a [DataStore][google.cloud.discoveryengine.v1beta.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);
 }
 

Parameters:

name - Required. Full resource name of [DataStore][google.cloud.discoveryengine.v1beta.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][google.cloud.discoveryengine.v1beta.DataStore], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the requested [DataStore][google.cloud.discoveryengine.v1beta.DataStore] does not exist, a NOT_FOUND error is returned.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getDataStore

public final DataStore getDataStore(String name)

Gets a [DataStore][google.cloud.discoveryengine.v1beta.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);
 }
 

Parameters:

name - Required. Full resource name of [DataStore][google.cloud.discoveryengine.v1beta.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][google.cloud.discoveryengine.v1beta.DataStore], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the requested [DataStore][google.cloud.discoveryengine.v1beta.DataStore] does not exist, a NOT_FOUND error is returned.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getDataStore

public final DataStore getDataStore(GetDataStoreRequest request)

Gets a [DataStore][google.cloud.discoveryengine.v1beta.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);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getDataStoreCallable

public final com.google.api.gax.rpc.UnaryCallable<GetDataStoreRequest,DataStore> getDataStoreCallable()

Gets a [DataStore][google.cloud.discoveryengine.v1beta.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();
 }
 

listDataStores

public final DataStoreServiceClient.ListDataStoresPagedResponse listDataStores(CollectionName parent)

Lists all the [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s 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);
   }
 }
 

Parameters:

parent - Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection_id}`.

If the caller does not have permission to list [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listDataStores

public final DataStoreServiceClient.ListDataStoresPagedResponse listDataStores(String parent)

Lists all the [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s 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);
   }
 }
 

Parameters:

parent - Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection_id}`.

If the caller does not have permission to list [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listDataStores

public final DataStoreServiceClient.ListDataStoresPagedResponse listDataStores(ListDataStoresRequest request)

Lists all the [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s 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);
   }
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listDataStoresPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListDataStoresRequest,DataStoreServiceClient.ListDataStoresPagedResponse> listDataStoresPagedCallable()

Lists all the [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s 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);
   }
 }
 

listDataStoresCallable

public final com.google.api.gax.rpc.UnaryCallable<ListDataStoresRequest,ListDataStoresResponse> listDataStoresCallable()

Lists all the [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s 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;
     }
   }
 }
 

deleteDataStoreAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteDataStoreMetadata> deleteDataStoreAsync(DataStoreName name)

Deletes a [DataStore][google.cloud.discoveryengine.v1beta.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();
 }
 

Parameters:

name - Required. Full resource name of [DataStore][google.cloud.discoveryengine.v1beta.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][google.cloud.discoveryengine.v1beta.DataStore], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the [DataStore][google.cloud.discoveryengine.v1beta.DataStore] to delete does not exist, a NOT_FOUND error is returned.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteDataStoreAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteDataStoreMetadata> deleteDataStoreAsync(String name)

Deletes a [DataStore][google.cloud.discoveryengine.v1beta.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();
 }
 

Parameters:

name - Required. Full resource name of [DataStore][google.cloud.discoveryengine.v1beta.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][google.cloud.discoveryengine.v1beta.DataStore], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the [DataStore][google.cloud.discoveryengine.v1beta.DataStore] to delete does not exist, a NOT_FOUND error is returned.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteDataStoreAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteDataStoreMetadata> deleteDataStoreAsync(DeleteDataStoreRequest request)

Deletes a [DataStore][google.cloud.discoveryengine.v1beta.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();
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteDataStoreOperationCallable

public final com.google.api.gax.rpc.OperationCallable<DeleteDataStoreRequest,com.google.protobuf.Empty,DeleteDataStoreMetadata> deleteDataStoreOperationCallable()

Deletes a [DataStore][google.cloud.discoveryengine.v1beta.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();
 }
 

deleteDataStoreCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteDataStoreRequest,com.google.longrunning.Operation> deleteDataStoreCallable()

Deletes a [DataStore][google.cloud.discoveryengine.v1beta.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();
 }
 

updateDataStore

public final DataStore updateDataStore(DataStore dataStore,
                                       com.google.protobuf.FieldMask updateMask)

Updates a [DataStore][google.cloud.discoveryengine.v1beta.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:

dataStore - Required. The [DataStore][google.cloud.discoveryengine.v1beta.DataStore] to update.

If the caller does not have permission to update the [DataStore][google.cloud.discoveryengine.v1beta.DataStore], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the [DataStore][google.cloud.discoveryengine.v1beta.DataStore] to update does not exist, a NOT_FOUND error is returned.

updateMask - Indicates which fields in the provided [DataStore][google.cloud.discoveryengine.v1beta.DataStore] to update.

If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateDataStore

public final DataStore updateDataStore(UpdateDataStoreRequest request)

Updates a [DataStore][google.cloud.discoveryengine.v1beta.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);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateDataStoreCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateDataStoreRequest,DataStore> updateDataStoreCallable()

Updates a [DataStore][google.cloud.discoveryengine.v1beta.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();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException