DocumentServiceClient (Google Discovery Engine API 0.52.0 API)

java.lang.Object
- com.google.cloud.discoveryengine.v1.DocumentServiceClient

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

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

Service Description: Service for ingesting [Document][google.cloud.discoveryengine.v1.Document] information of the customer's website.

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 (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
   DocumentName name =
       DocumentName.ofProjectLocationDataStoreBranchDocumentName(
           "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]", "[DOCUMENT]");
   Document response = documentServiceClient.getDocument(name);
 }

Note: close() needs to be called on the DocumentServiceClient 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
GetDocument	Gets a [Document][google.cloud.discoveryengine.v1.Document].	Request object method variants only take one parameter, a request object, which must be constructed before the call. getDocument(GetDocumentRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getDocument(DocumentName name) getDocument(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. getDocumentCallable()
ListDocuments	Gets a list of [Document][google.cloud.discoveryengine.v1.Document]s.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listDocuments(ListDocumentsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listDocuments(BranchName parent) listDocuments(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. listDocumentsPagedCallable() listDocumentsCallable()
CreateDocument	Creates a [Document][google.cloud.discoveryengine.v1.Document].	Request object method variants only take one parameter, a request object, which must be constructed before the call. createDocument(CreateDocumentRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createDocument(BranchName parent, Document document, String documentId) createDocument(String parent, Document document, String documentId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createDocumentCallable()
UpdateDocument	Updates a [Document][google.cloud.discoveryengine.v1.Document].	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateDocument(UpdateDocumentRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateDocument(Document document, 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. updateDocumentCallable()
DeleteDocument	Deletes a [Document][google.cloud.discoveryengine.v1.Document].	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteDocument(DeleteDocumentRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteDocument(DocumentName name) deleteDocument(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. deleteDocumentCallable()
ImportDocuments	Bulk import of multiple [Document][google.cloud.discoveryengine.v1.Document]s. Request processing may be synchronous. Non-existing items are created. Note: It is possible for a subset of the [Document][google.cloud.discoveryengine.v1.Document]s to be successfully updated.	Request object method variants only take one parameter, a request object, which must be constructed before the call. importDocumentsAsync(ImportDocumentsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. importDocumentsOperationCallable() importDocumentsCallable()
PurgeDocuments	Permanently deletes all selected [Document][google.cloud.discoveryengine.v1.Document]s in a branch. This process is asynchronous. Depending on the number of [Document][google.cloud.discoveryengine.v1.Document]s to be deleted, this operation can take hours to complete. Before the delete operation completes, some [Document][google.cloud.discoveryengine.v1.Document]s might still be returned by [DocumentService.GetDocument][google.cloud.discoveryengine.v1.DocumentService.GetDocument] or [DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments]. To get a list of the [Document][google.cloud.discoveryengine.v1.Document]s to be deleted, set [PurgeDocumentsRequest.force][google.cloud.discoveryengine.v1.PurgeDocumentsRequest.force] to false.	Request object method variants only take one parameter, a request object, which must be constructed before the call. purgeDocumentsAsync(PurgeDocumentsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. purgeDocumentsOperationCallable() purgeDocumentsCallable()
BatchGetDocumentsMetadata	Gets index freshness metadata for [Document][google.cloud.discoveryengine.v1.Document]s. Supported for website search only.	Request object method variants only take one parameter, a request object, which must be constructed before the call. batchGetDocumentsMetadata(BatchGetDocumentsMetadataRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. batchGetDocumentsMetadata(BranchName parent) batchGetDocumentsMetadata(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. batchGetDocumentsMetadataCallable()

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 DocumentServiceSettings 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
 DocumentServiceSettings documentServiceSettings =
     DocumentServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DocumentServiceClient documentServiceClient =
     DocumentServiceClient.create(documentServiceSettings);

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
 DocumentServiceSettings documentServiceSettings =
     DocumentServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 DocumentServiceClient documentServiceClient =
     DocumentServiceClient.create(documentServiceSettings);

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
 DocumentServiceSettings documentServiceSettings =
     DocumentServiceSettings.newHttpJsonBuilder().build();
 DocumentServiceClient documentServiceClient =
     DocumentServiceClient.create(documentServiceSettings);

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`	`DocumentServiceClient.ListDocumentsFixedSizeCollection`
`static class`	`DocumentServiceClient.ListDocumentsPage`
`static class`	`DocumentServiceClient.ListDocumentsPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`DocumentServiceClient(DocumentServiceSettings settings)` Constructs an instance of DocumentServiceClient, using the given settings.
`protected`	`DocumentServiceClient(DocumentServiceStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`BatchGetDocumentsMetadataResponse`	`batchGetDocumentsMetadata(BatchGetDocumentsMetadataRequest request)` Gets index freshness metadata for [Document][google.cloud.discoveryengine.v1.Document]s.
`BatchGetDocumentsMetadataResponse`	`batchGetDocumentsMetadata(BranchName parent)` Gets index freshness metadata for [Document][google.cloud.discoveryengine.v1.Document]s.
`BatchGetDocumentsMetadataResponse`	`batchGetDocumentsMetadata(String parent)` Gets index freshness metadata for [Document][google.cloud.discoveryengine.v1.Document]s.
`com.google.api.gax.rpc.UnaryCallable<BatchGetDocumentsMetadataRequest,BatchGetDocumentsMetadataResponse>`	`batchGetDocumentsMetadataCallable()` Gets index freshness metadata for [Document][google.cloud.discoveryengine.v1.Document]s.
`void`	`close()`
`static DocumentServiceClient`	`create()` Constructs an instance of DocumentServiceClient with default settings.
`static DocumentServiceClient`	`create(DocumentServiceSettings settings)` Constructs an instance of DocumentServiceClient, using the given settings.
`static DocumentServiceClient`	`create(DocumentServiceStub stub)` Constructs an instance of DocumentServiceClient, using the given stub for making calls.
`Document`	`createDocument(BranchName parent, Document document, String documentId)` Creates a [Document][google.cloud.discoveryengine.v1.Document].
`Document`	`createDocument(CreateDocumentRequest request)` Creates a [Document][google.cloud.discoveryengine.v1.Document].
`Document`	`createDocument(String parent, Document document, String documentId)` Creates a [Document][google.cloud.discoveryengine.v1.Document].
`com.google.api.gax.rpc.UnaryCallable<CreateDocumentRequest,Document>`	`createDocumentCallable()` Creates a [Document][google.cloud.discoveryengine.v1.Document].
`void`	`deleteDocument(DeleteDocumentRequest request)` Deletes a [Document][google.cloud.discoveryengine.v1.Document].
`void`	`deleteDocument(DocumentName name)` Deletes a [Document][google.cloud.discoveryengine.v1.Document].
`void`	`deleteDocument(String name)` Deletes a [Document][google.cloud.discoveryengine.v1.Document].
`com.google.api.gax.rpc.UnaryCallable<DeleteDocumentRequest,com.google.protobuf.Empty>`	`deleteDocumentCallable()` Deletes a [Document][google.cloud.discoveryengine.v1.Document].
`Document`	`getDocument(DocumentName name)` Gets a [Document][google.cloud.discoveryengine.v1.Document].
`Document`	`getDocument(GetDocumentRequest request)` Gets a [Document][google.cloud.discoveryengine.v1.Document].
`Document`	`getDocument(String name)` Gets a [Document][google.cloud.discoveryengine.v1.Document].
`com.google.api.gax.rpc.UnaryCallable<GetDocumentRequest,Document>`	`getDocumentCallable()` Gets a [Document][google.cloud.discoveryengine.v1.Document].
`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.
`DocumentServiceSettings`	`getSettings()`
`DocumentServiceStub`	`getStub()`
`com.google.api.gax.longrunning.OperationFuture<ImportDocumentsResponse,ImportDocumentsMetadata>`	`importDocumentsAsync(ImportDocumentsRequest request)` Bulk import of multiple [Document][google.cloud.discoveryengine.v1.Document]s.
`com.google.api.gax.rpc.UnaryCallable<ImportDocumentsRequest,com.google.longrunning.Operation>`	`importDocumentsCallable()` Bulk import of multiple [Document][google.cloud.discoveryengine.v1.Document]s.
`com.google.api.gax.rpc.OperationCallable<ImportDocumentsRequest,ImportDocumentsResponse,ImportDocumentsMetadata>`	`importDocumentsOperationCallable()` Bulk import of multiple [Document][google.cloud.discoveryengine.v1.Document]s.
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`DocumentServiceClient.ListDocumentsPagedResponse`	`listDocuments(BranchName parent)` Gets a list of [Document][google.cloud.discoveryengine.v1.Document]s.
`DocumentServiceClient.ListDocumentsPagedResponse`	`listDocuments(ListDocumentsRequest request)` Gets a list of [Document][google.cloud.discoveryengine.v1.Document]s.
`DocumentServiceClient.ListDocumentsPagedResponse`	`listDocuments(String parent)` Gets a list of [Document][google.cloud.discoveryengine.v1.Document]s.
`com.google.api.gax.rpc.UnaryCallable<ListDocumentsRequest,ListDocumentsResponse>`	`listDocumentsCallable()` Gets a list of [Document][google.cloud.discoveryengine.v1.Document]s.
`com.google.api.gax.rpc.UnaryCallable<ListDocumentsRequest,DocumentServiceClient.ListDocumentsPagedResponse>`	`listDocumentsPagedCallable()` Gets a list of [Document][google.cloud.discoveryengine.v1.Document]s.
`com.google.api.gax.longrunning.OperationFuture<PurgeDocumentsResponse,PurgeDocumentsMetadata>`	`purgeDocumentsAsync(PurgeDocumentsRequest request)` Permanently deletes all selected [Document][google.cloud.discoveryengine.v1.Document]s in a branch.
`com.google.api.gax.rpc.UnaryCallable<PurgeDocumentsRequest,com.google.longrunning.Operation>`	`purgeDocumentsCallable()` Permanently deletes all selected [Document][google.cloud.discoveryengine.v1.Document]s in a branch.
`com.google.api.gax.rpc.OperationCallable<PurgeDocumentsRequest,PurgeDocumentsResponse,PurgeDocumentsMetadata>`	`purgeDocumentsOperationCallable()` Permanently deletes all selected [Document][google.cloud.discoveryengine.v1.Document]s in a branch.
`void`	`shutdown()`
`void`	`shutdownNow()`
`Document`	`updateDocument(Document document, com.google.protobuf.FieldMask updateMask)` Updates a [Document][google.cloud.discoveryengine.v1.Document].
`Document`	`updateDocument(UpdateDocumentRequest request)` Updates a [Document][google.cloud.discoveryengine.v1.Document].
`com.google.api.gax.rpc.UnaryCallable<UpdateDocumentRequest,Document>`	`updateDocumentCallable()` Updates a [Document][google.cloud.discoveryengine.v1.Document].

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- DocumentServiceClient
```
protected DocumentServiceClient(DocumentServiceSettings settings)
                         throws IOException
```
  Constructs an instance of DocumentServiceClient, 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
- DocumentServiceClient
```
protected DocumentServiceClient(DocumentServiceStub stub)
```

Method Detail

create

public static final DocumentServiceClient create()
                                          throws IOException

Constructs an instance of DocumentServiceClient with default settings.

Throws:: IOException

create
```
public static final DocumentServiceClient create(DocumentServiceSettings settings)
                                          throws IOException
```
Constructs an instance of DocumentServiceClient, 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 DocumentServiceClient create(DocumentServiceStub stub)
```
Constructs an instance of DocumentServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(DocumentServiceSettings).

getSettings

public final DocumentServiceSettings getSettings()

getStub
```
public DocumentServiceStub 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.

getDocument

public final Document getDocument(DocumentName name)

Gets a [Document][google.cloud.discoveryengine.v1.Document].

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 (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
   DocumentName name =
       DocumentName.ofProjectLocationDataStoreBranchDocumentName(
           "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]", "[DOCUMENT]");
   Document response = documentServiceClient.getDocument(name);
 }

Parameters:

name - Required. Full resource name of [Document][google.cloud.discoveryengine.v1.Document], such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.

If the caller does not have permission to access the [Document][google.cloud.discoveryengine.v1.Document], regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned.

If the requested [Document][google.cloud.discoveryengine.v1.Document] does not exist, a `NOT_FOUND` error is returned.

Throws:

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

getDocument

public final Document getDocument(String name)

Gets a [Document][google.cloud.discoveryengine.v1.Document].

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 (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
   String name =
       DocumentName.ofProjectLocationDataStoreBranchDocumentName(
               "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]", "[DOCUMENT]")
           .toString();
   Document response = documentServiceClient.getDocument(name);
 }

Parameters:

If the caller does not have permission to access the [Document][google.cloud.discoveryengine.v1.Document], regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned.

If the requested [Document][google.cloud.discoveryengine.v1.Document] does not exist, a `NOT_FOUND` error is returned.

Throws:

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

getDocument

public final Document getDocument(GetDocumentRequest request)

Gets a [Document][google.cloud.discoveryengine.v1.Document].

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 (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
   GetDocumentRequest request =
       GetDocumentRequest.newBuilder()
           .setName(
               DocumentName.ofProjectLocationDataStoreBranchDocumentName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]", "[DOCUMENT]")
                   .toString())
           .build();
   Document response = documentServiceClient.getDocument(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

getDocumentCallable

public final com.google.api.gax.rpc.UnaryCallable<GetDocumentRequest,Document> getDocumentCallable()

Gets a [Document][google.cloud.discoveryengine.v1.Document].

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 (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
   GetDocumentRequest request =
       GetDocumentRequest.newBuilder()
           .setName(
               DocumentName.ofProjectLocationDataStoreBranchDocumentName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]", "[DOCUMENT]")
                   .toString())
           .build();
   ApiFuture<Document> future = documentServiceClient.getDocumentCallable().futureCall(request);
   // Do something.
   Document response = future.get();
 }

listDocuments

public final DocumentServiceClient.ListDocumentsPagedResponse listDocuments(BranchName parent)

Gets a list of [Document][google.cloud.discoveryengine.v1.Document]s.

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 (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
   BranchName parent =
       BranchName.ofProjectLocationDataStoreBranchName(
           "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]");
   for (Document element : documentServiceClient.listDocuments(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: parent - Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch.
If the caller does not have permission to list [Document][google.cloud.discoveryengine.v1.Document]s under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listDocuments

public final DocumentServiceClient.ListDocumentsPagedResponse listDocuments(String parent)

Gets a list of [Document][google.cloud.discoveryengine.v1.Document]s.

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 (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
   String parent =
       BranchName.ofProjectLocationDataStoreBranchName(
               "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]")
           .toString();
   for (Document element : documentServiceClient.listDocuments(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: parent - Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch.
If the caller does not have permission to list [Document][google.cloud.discoveryengine.v1.Document]s under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listDocuments

public final DocumentServiceClient.ListDocumentsPagedResponse listDocuments(ListDocumentsRequest request)

Gets a list of [Document][google.cloud.discoveryengine.v1.Document]s.

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 (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
   ListDocumentsRequest request =
       ListDocumentsRequest.newBuilder()
           .setParent(
               BranchName.ofProjectLocationDataStoreBranchName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Document element : documentServiceClient.listDocuments(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

listDocumentsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListDocumentsRequest,DocumentServiceClient.ListDocumentsPagedResponse> listDocumentsPagedCallable()

Gets a list of [Document][google.cloud.discoveryengine.v1.Document]s.

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 (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
   ListDocumentsRequest request =
       ListDocumentsRequest.newBuilder()
           .setParent(
               BranchName.ofProjectLocationDataStoreBranchName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Document> future =
       documentServiceClient.listDocumentsPagedCallable().futureCall(request);
   // Do something.
   for (Document element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

listDocumentsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListDocumentsRequest,ListDocumentsResponse> listDocumentsCallable()

Gets a list of [Document][google.cloud.discoveryengine.v1.Document]s.

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 (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
   ListDocumentsRequest request =
       ListDocumentsRequest.newBuilder()
           .setParent(
               BranchName.ofProjectLocationDataStoreBranchName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListDocumentsResponse response =
         documentServiceClient.listDocumentsCallable().call(request);
     for (Document element : response.getDocumentsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

createDocument
```
public final Document createDocument(BranchName parent,
                                     Document document,
                                     String documentId)
```
Creates a [Document][google.cloud.discoveryengine.v1.Document].
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 (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
   BranchName parent =
       BranchName.ofProjectLocationDataStoreBranchName(
           "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]");
   Document document = Document.newBuilder().build();
   String documentId = "documentId-814940266";
   Document response = documentServiceClient.createDocument(parent, document, documentId);
 }
 
```
Parameters:

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

document - Required. The [Document][google.cloud.discoveryengine.v1.Document] to create.

documentId - Required. The ID to use for the [Document][google.cloud.discoveryengine.v1.Document], which becomes the final component of the [Document.name][google.cloud.discoveryengine.v1.Document.name].
If the caller does not have permission to create the [Document][google.cloud.discoveryengine.v1.Document], regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned.
This field must be unique among all [Document][google.cloud.discoveryengine.v1.Document]s with the same [parent][google.cloud.discoveryengine.v1.CreateDocumentRequest.parent]. Otherwise, an `ALREADY_EXISTS` error is returned.
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

createDocument
```
public final Document createDocument(String parent,
                                     Document document,
                                     String documentId)
```
Creates a [Document][google.cloud.discoveryengine.v1.Document].
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 (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
   String parent =
       BranchName.ofProjectLocationDataStoreBranchName(
               "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]")
           .toString();
   Document document = Document.newBuilder().build();
   String documentId = "documentId-814940266";
   Document response = documentServiceClient.createDocument(parent, document, documentId);
 }
 
```
Parameters:

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

document - Required. The [Document][google.cloud.discoveryengine.v1.Document] to create.

documentId - Required. The ID to use for the [Document][google.cloud.discoveryengine.v1.Document], which becomes the final component of the [Document.name][google.cloud.discoveryengine.v1.Document.name].
If the caller does not have permission to create the [Document][google.cloud.discoveryengine.v1.Document], regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned.
This field must be unique among all [Document][google.cloud.discoveryengine.v1.Document]s with the same [parent][google.cloud.discoveryengine.v1.CreateDocumentRequest.parent]. Otherwise, an `ALREADY_EXISTS` error is returned.
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

createDocument

public final Document createDocument(CreateDocumentRequest request)

Creates a [Document][google.cloud.discoveryengine.v1.Document].

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 (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
   CreateDocumentRequest request =
       CreateDocumentRequest.newBuilder()
           .setParent(
               BranchName.ofProjectLocationDataStoreBranchName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]")
                   .toString())
           .setDocument(Document.newBuilder().build())
           .setDocumentId("documentId-814940266")
           .build();
   Document response = documentServiceClient.createDocument(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

createDocumentCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateDocumentRequest,Document> createDocumentCallable()

Creates a [Document][google.cloud.discoveryengine.v1.Document].

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 (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
   CreateDocumentRequest request =
       CreateDocumentRequest.newBuilder()
           .setParent(
               BranchName.ofProjectLocationDataStoreBranchName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]")
                   .toString())
           .setDocument(Document.newBuilder().build())
           .setDocumentId("documentId-814940266")
           .build();
   ApiFuture<Document> future =
       documentServiceClient.createDocumentCallable().futureCall(request);
   // Do something.
   Document response = future.get();
 }

updateDocument

public final Document updateDocument(Document document,
                                     com.google.protobuf.FieldMask updateMask)

Updates a [Document][google.cloud.discoveryengine.v1.Document].

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 (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
   Document document = Document.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Document response = documentServiceClient.updateDocument(document, updateMask);
 }

Parameters:

document - Required. The document to update/create.

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

If the [Document][google.cloud.discoveryengine.v1.Document] to update does not exist and [allow_missing][google.cloud.discoveryengine.v1.UpdateDocumentRequest.allow_missing] is not set, a `NOT_FOUND` error is returned.

updateMask - Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields.

Throws:

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

updateDocument

public final Document updateDocument(UpdateDocumentRequest request)

Updates a [Document][google.cloud.discoveryengine.v1.Document].

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 (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
   UpdateDocumentRequest request =
       UpdateDocumentRequest.newBuilder()
           .setDocument(Document.newBuilder().build())
           .setAllowMissing(true)
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Document response = documentServiceClient.updateDocument(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

updateDocumentCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateDocumentRequest,Document> updateDocumentCallable()

Updates a [Document][google.cloud.discoveryengine.v1.Document].

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 (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
   UpdateDocumentRequest request =
       UpdateDocumentRequest.newBuilder()
           .setDocument(Document.newBuilder().build())
           .setAllowMissing(true)
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Document> future =
       documentServiceClient.updateDocumentCallable().futureCall(request);
   // Do something.
   Document response = future.get();
 }

deleteDocument

public final void deleteDocument(DocumentName name)

Deletes a [Document][google.cloud.discoveryengine.v1.Document].

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 (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
   DocumentName name =
       DocumentName.ofProjectLocationDataStoreBranchDocumentName(
           "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]", "[DOCUMENT]");
   documentServiceClient.deleteDocument(name);
 }

Parameters:

If the caller does not have permission to delete the [Document][google.cloud.discoveryengine.v1.Document], regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned.

If the [Document][google.cloud.discoveryengine.v1.Document] to delete does not exist, a `NOT_FOUND` error is returned.

Throws:

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

deleteDocument

public final void deleteDocument(String name)

Deletes a [Document][google.cloud.discoveryengine.v1.Document].

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 (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
   String name =
       DocumentName.ofProjectLocationDataStoreBranchDocumentName(
               "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]", "[DOCUMENT]")
           .toString();
   documentServiceClient.deleteDocument(name);
 }

Parameters:

If the caller does not have permission to delete the [Document][google.cloud.discoveryengine.v1.Document], regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned.

If the [Document][google.cloud.discoveryengine.v1.Document] to delete does not exist, a `NOT_FOUND` error is returned.

Throws:

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

deleteDocument

public final void deleteDocument(DeleteDocumentRequest request)

Deletes a [Document][google.cloud.discoveryengine.v1.Document].

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 (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
   DeleteDocumentRequest request =
       DeleteDocumentRequest.newBuilder()
           .setName(
               DocumentName.ofProjectLocationDataStoreBranchDocumentName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]", "[DOCUMENT]")
                   .toString())
           .build();
   documentServiceClient.deleteDocument(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

deleteDocumentCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteDocumentRequest,com.google.protobuf.Empty> deleteDocumentCallable()

Deletes a [Document][google.cloud.discoveryengine.v1.Document].

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 (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
   DeleteDocumentRequest request =
       DeleteDocumentRequest.newBuilder()
           .setName(
               DocumentName.ofProjectLocationDataStoreBranchDocumentName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]", "[DOCUMENT]")
                   .toString())
           .build();
   ApiFuture<Empty> future = documentServiceClient.deleteDocumentCallable().futureCall(request);
   // Do something.
   future.get();
 }

importDocumentsAsync

public final com.google.api.gax.longrunning.OperationFuture<ImportDocumentsResponse,ImportDocumentsMetadata> importDocumentsAsync(ImportDocumentsRequest request)

Bulk import of multiple [Document][google.cloud.discoveryengine.v1.Document]s. Request processing may be synchronous. Non-existing items are created.

Note: It is possible for a subset of the [Document][google.cloud.discoveryengine.v1.Document]s to be successfully updated.

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 (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
   ImportDocumentsRequest request =
       ImportDocumentsRequest.newBuilder()
           .setParent(
               BranchName.ofProjectLocationDataStoreBranchName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]")
                   .toString())
           .setErrorConfig(ImportErrorConfig.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setAutoGenerateIds(true)
           .setIdField("idField1629396127")
           .build();
   ImportDocumentsResponse response = documentServiceClient.importDocumentsAsync(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

importDocumentsOperationCallable

public final com.google.api.gax.rpc.OperationCallable<ImportDocumentsRequest,ImportDocumentsResponse,ImportDocumentsMetadata> importDocumentsOperationCallable()

Bulk import of multiple [Document][google.cloud.discoveryengine.v1.Document]s. Request processing may be synchronous. Non-existing items are created.

Note: It is possible for a subset of the [Document][google.cloud.discoveryengine.v1.Document]s to be successfully updated.

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 (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
   ImportDocumentsRequest request =
       ImportDocumentsRequest.newBuilder()
           .setParent(
               BranchName.ofProjectLocationDataStoreBranchName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]")
                   .toString())
           .setErrorConfig(ImportErrorConfig.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setAutoGenerateIds(true)
           .setIdField("idField1629396127")
           .build();
   OperationFuture<ImportDocumentsResponse, ImportDocumentsMetadata> future =
       documentServiceClient.importDocumentsOperationCallable().futureCall(request);
   // Do something.
   ImportDocumentsResponse response = future.get();
 }

importDocumentsCallable

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

Bulk import of multiple [Document][google.cloud.discoveryengine.v1.Document]s. Request processing may be synchronous. Non-existing items are created.

Note: It is possible for a subset of the [Document][google.cloud.discoveryengine.v1.Document]s to be successfully updated.

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 (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
   ImportDocumentsRequest request =
       ImportDocumentsRequest.newBuilder()
           .setParent(
               BranchName.ofProjectLocationDataStoreBranchName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]")
                   .toString())
           .setErrorConfig(ImportErrorConfig.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setAutoGenerateIds(true)
           .setIdField("idField1629396127")
           .build();
   ApiFuture<Operation> future =
       documentServiceClient.importDocumentsCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

purgeDocumentsAsync

public final com.google.api.gax.longrunning.OperationFuture<PurgeDocumentsResponse,PurgeDocumentsMetadata> purgeDocumentsAsync(PurgeDocumentsRequest request)

Permanently deletes all selected [Document][google.cloud.discoveryengine.v1.Document]s in a branch.

This process is asynchronous. Depending on the number of [Document][google.cloud.discoveryengine.v1.Document]s to be deleted, this operation can take hours to complete. Before the delete operation completes, some [Document][google.cloud.discoveryengine.v1.Document]s might still be returned by [DocumentService.GetDocument][google.cloud.discoveryengine.v1.DocumentService.GetDocument] or [DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments].

To get a list of the [Document][google.cloud.discoveryengine.v1.Document]s to be deleted, set [PurgeDocumentsRequest.force][google.cloud.discoveryengine.v1.PurgeDocumentsRequest.force] to false.

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 (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
   PurgeDocumentsRequest request =
       PurgeDocumentsRequest.newBuilder()
           .setParent(
               BranchName.ofProjectLocationDataStoreBranchName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]")
                   .toString())
           .setFilter("filter-1274492040")
           .setErrorConfig(PurgeErrorConfig.newBuilder().build())
           .setForce(true)
           .build();
   PurgeDocumentsResponse response = documentServiceClient.purgeDocumentsAsync(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

purgeDocumentsOperationCallable

public final com.google.api.gax.rpc.OperationCallable<PurgeDocumentsRequest,PurgeDocumentsResponse,PurgeDocumentsMetadata> purgeDocumentsOperationCallable()

Permanently deletes all selected [Document][google.cloud.discoveryengine.v1.Document]s in a branch.

To get a list of the [Document][google.cloud.discoveryengine.v1.Document]s to be deleted, set [PurgeDocumentsRequest.force][google.cloud.discoveryengine.v1.PurgeDocumentsRequest.force] to false.

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 (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
   PurgeDocumentsRequest request =
       PurgeDocumentsRequest.newBuilder()
           .setParent(
               BranchName.ofProjectLocationDataStoreBranchName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]")
                   .toString())
           .setFilter("filter-1274492040")
           .setErrorConfig(PurgeErrorConfig.newBuilder().build())
           .setForce(true)
           .build();
   OperationFuture<PurgeDocumentsResponse, PurgeDocumentsMetadata> future =
       documentServiceClient.purgeDocumentsOperationCallable().futureCall(request);
   // Do something.
   PurgeDocumentsResponse response = future.get();
 }

purgeDocumentsCallable

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

Permanently deletes all selected [Document][google.cloud.discoveryengine.v1.Document]s in a branch.

To get a list of the [Document][google.cloud.discoveryengine.v1.Document]s to be deleted, set [PurgeDocumentsRequest.force][google.cloud.discoveryengine.v1.PurgeDocumentsRequest.force] to false.

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 (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
   PurgeDocumentsRequest request =
       PurgeDocumentsRequest.newBuilder()
           .setParent(
               BranchName.ofProjectLocationDataStoreBranchName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]")
                   .toString())
           .setFilter("filter-1274492040")
           .setErrorConfig(PurgeErrorConfig.newBuilder().build())
           .setForce(true)
           .build();
   ApiFuture<Operation> future =
       documentServiceClient.purgeDocumentsCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

batchGetDocumentsMetadata

public final BatchGetDocumentsMetadataResponse batchGetDocumentsMetadata(BranchName parent)

Gets index freshness metadata for [Document][google.cloud.discoveryengine.v1.Document]s. Supported for website search only.

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 (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
   BranchName parent =
       BranchName.ofProjectLocationDataStoreBranchName(
           "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]");
   BatchGetDocumentsMetadataResponse response =
       documentServiceClient.batchGetDocumentsMetadata(parent);
 }

Parameters:: parent - Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

batchGetDocumentsMetadata

public final BatchGetDocumentsMetadataResponse batchGetDocumentsMetadata(String parent)

Gets index freshness metadata for [Document][google.cloud.discoveryengine.v1.Document]s. Supported for website search only.

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 (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
   String parent =
       BranchName.ofProjectLocationDataStoreBranchName(
               "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]")
           .toString();
   BatchGetDocumentsMetadataResponse response =
       documentServiceClient.batchGetDocumentsMetadata(parent);
 }

Parameters:: parent - Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

batchGetDocumentsMetadata

public final BatchGetDocumentsMetadataResponse batchGetDocumentsMetadata(BatchGetDocumentsMetadataRequest request)

Gets index freshness metadata for [Document][google.cloud.discoveryengine.v1.Document]s. Supported for website search only.

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 (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
   BatchGetDocumentsMetadataRequest request =
       BatchGetDocumentsMetadataRequest.newBuilder()
           .setParent(
               BranchName.ofProjectLocationDataStoreBranchName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]")
                   .toString())
           .setMatcher(BatchGetDocumentsMetadataRequest.Matcher.newBuilder().build())
           .build();
   BatchGetDocumentsMetadataResponse response =
       documentServiceClient.batchGetDocumentsMetadata(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

batchGetDocumentsMetadataCallable

public final com.google.api.gax.rpc.UnaryCallable<BatchGetDocumentsMetadataRequest,BatchGetDocumentsMetadataResponse> batchGetDocumentsMetadataCallable()

Gets index freshness metadata for [Document][google.cloud.discoveryengine.v1.Document]s. Supported for website search only.

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 (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
   BatchGetDocumentsMetadataRequest request =
       BatchGetDocumentsMetadataRequest.newBuilder()
           .setParent(
               BranchName.ofProjectLocationDataStoreBranchName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]")
                   .toString())
           .setMatcher(BatchGetDocumentsMetadataRequest.Matcher.newBuilder().build())
           .build();
   ApiFuture<BatchGetDocumentsMetadataResponse> future =
       documentServiceClient.batchGetDocumentsMetadataCallable().futureCall(request);
   // Do something.
   BatchGetDocumentsMetadataResponse 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

Class DocumentServiceClient

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DocumentServiceClient

DocumentServiceClient

Method Detail

create

create

create

getSettings

getStub

getOperationsClient

getHttpJsonOperationsClient

getDocument

getDocument

getDocument

getDocumentCallable

listDocuments

listDocuments

listDocuments

listDocumentsPagedCallable

listDocumentsCallable

createDocument

createDocument

createDocument

createDocumentCallable

updateDocument

updateDocument

updateDocumentCallable

deleteDocument

deleteDocument

deleteDocument

deleteDocumentCallable

importDocumentsAsync

importDocumentsOperationCallable

importDocumentsCallable

purgeDocumentsAsync

purgeDocumentsOperationCallable

purgeDocumentsCallable

batchGetDocumentsMetadata

batchGetDocumentsMetadata

batchGetDocumentsMetadata

batchGetDocumentsMetadataCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination