DocumentsClient (Google Cloud Dialog Flow API Parent 3.0.1 API)

java.lang.Object
- com.google.cloud.dialogflow.v2beta1.DocumentsClient

All Implemented Interfaces:

BackgroundResource, AutoCloseable
```
@BetaApi
 @Generated(value="by gapic-generator-java")
public class DocumentsClient
extends Object
implements BackgroundResource
```
Service Description: Service for managing knowledge [Documents][google.cloud.dialogflow.v2beta1.Document].
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:
```
 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   DocumentName name =
       DocumentName.ofProjectKnowledgeBaseDocumentName(
           "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]");
   Document response = documentsClient.getDocument(name);
 }
 
```
Note: close() needs to be called on the DocumentsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of DocumentsSettings to create(). For example:
To customize credentials:
```
 DocumentsSettings documentsSettings =
     DocumentsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DocumentsClient documentsClient = DocumentsClient.create(documentsSettings);
 
```
To customize the endpoint:
```
 DocumentsSettings documentsSettings =
     DocumentsSettings.newBuilder().setEndpoint(myEndpoint).build();
 DocumentsClient documentsClient = DocumentsClient.create(documentsSettings);
 
```
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`	`DocumentsClient.ListDocumentsFixedSizeCollection`
`static class`	`DocumentsClient.ListDocumentsPage`
`static class`	`DocumentsClient.ListDocumentsPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`DocumentsClient(DocumentsSettings settings)` Constructs an instance of DocumentsClient, using the given settings.
`protected`	`DocumentsClient(DocumentsStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static DocumentsClient`	`create()` Constructs an instance of DocumentsClient with default settings.
`static DocumentsClient`	`create(DocumentsSettings settings)` Constructs an instance of DocumentsClient, using the given settings.
`static DocumentsClient`	`create(DocumentsStub stub)` Constructs an instance of DocumentsClient, using the given stub for making calls.
`OperationFuture<Document,KnowledgeOperationMetadata>`	`createDocumentAsync(CreateDocumentRequest request)` Creates a new document.
`OperationFuture<Document,KnowledgeOperationMetadata>`	`createDocumentAsync(KnowledgeBaseName parent, Document document)` Creates a new document.
`OperationFuture<Document,KnowledgeOperationMetadata>`	`createDocumentAsync(String parent, Document document)` Creates a new document.
`UnaryCallable<CreateDocumentRequest,Operation>`	`createDocumentCallable()` Creates a new document.
`OperationCallable<CreateDocumentRequest,Document,KnowledgeOperationMetadata>`	`createDocumentOperationCallable()` Creates a new document.
`OperationFuture<Empty,KnowledgeOperationMetadata>`	`deleteDocumentAsync(DeleteDocumentRequest request)` Deletes the specified document.
`OperationFuture<Empty,KnowledgeOperationMetadata>`	`deleteDocumentAsync(DocumentName name)` Deletes the specified document.
`OperationFuture<Empty,KnowledgeOperationMetadata>`	`deleteDocumentAsync(String name)` Deletes the specified document.
`UnaryCallable<DeleteDocumentRequest,Operation>`	`deleteDocumentCallable()` Deletes the specified document.
`OperationCallable<DeleteDocumentRequest,Empty,KnowledgeOperationMetadata>`	`deleteDocumentOperationCallable()` Deletes the specified document.
`Document`	`getDocument(DocumentName name)` Retrieves the specified document.
`Document`	`getDocument(GetDocumentRequest request)` Retrieves the specified document.
`Document`	`getDocument(String name)` Retrieves the specified document.
`UnaryCallable<GetDocumentRequest,Document>`	`getDocumentCallable()` Retrieves the specified document.
`OperationsClient`	`getOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`DocumentsSettings`	`getSettings()`
`DocumentsStub`	`getStub()`
`OperationFuture<ImportDocumentsResponse,KnowledgeOperationMetadata>`	`importDocumentsAsync(ImportDocumentsRequest request)` Create documents by importing data from external sources.
`UnaryCallable<ImportDocumentsRequest,Operation>`	`importDocumentsCallable()` Create documents by importing data from external sources.
`OperationCallable<ImportDocumentsRequest,ImportDocumentsResponse,KnowledgeOperationMetadata>`	`importDocumentsOperationCallable()` Create documents by importing data from external sources.
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`DocumentsClient.ListDocumentsPagedResponse`	`listDocuments(KnowledgeBaseName parent)` Returns the list of all documents of the knowledge base.
`DocumentsClient.ListDocumentsPagedResponse`	`listDocuments(ListDocumentsRequest request)` Returns the list of all documents of the knowledge base.
`DocumentsClient.ListDocumentsPagedResponse`	`listDocuments(String parent)` Returns the list of all documents of the knowledge base.
`UnaryCallable<ListDocumentsRequest,ListDocumentsResponse>`	`listDocumentsCallable()` Returns the list of all documents of the knowledge base.
`UnaryCallable<ListDocumentsRequest,DocumentsClient.ListDocumentsPagedResponse>`	`listDocumentsPagedCallable()` Returns the list of all documents of the knowledge base.
`OperationFuture<Document,KnowledgeOperationMetadata>`	`reloadDocumentAsync(DocumentName name, GcsSource gcsSource)` Reloads the specified document from its specified source, content_uri or content.
`OperationFuture<Document,KnowledgeOperationMetadata>`	`reloadDocumentAsync(ReloadDocumentRequest request)` Reloads the specified document from its specified source, content_uri or content.
`OperationFuture<Document,KnowledgeOperationMetadata>`	`reloadDocumentAsync(String name, GcsSource gcsSource)` Reloads the specified document from its specified source, content_uri or content.
`UnaryCallable<ReloadDocumentRequest,Operation>`	`reloadDocumentCallable()` Reloads the specified document from its specified source, content_uri or content.
`OperationCallable<ReloadDocumentRequest,Document,KnowledgeOperationMetadata>`	`reloadDocumentOperationCallable()` Reloads the specified document from its specified source, content_uri or content.
`void`	`shutdown()`
`void`	`shutdownNow()`
`OperationFuture<Document,KnowledgeOperationMetadata>`	`updateDocumentAsync(Document document)` Updates the specified document.
`OperationFuture<Document,KnowledgeOperationMetadata>`	`updateDocumentAsync(Document document, FieldMask updateMask)` Updates the specified document.
`OperationFuture<Document,KnowledgeOperationMetadata>`	`updateDocumentAsync(UpdateDocumentRequest request)` Updates the specified document.
`UnaryCallable<UpdateDocumentRequest,Operation>`	`updateDocumentCallable()` Updates the specified document.
`OperationCallable<UpdateDocumentRequest,Document,KnowledgeOperationMetadata>`	`updateDocumentOperationCallable()` Updates the specified document.

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

Constructor Detail
- DocumentsClient
```
protected DocumentsClient(DocumentsSettings settings)
                   throws IOException
```
  Constructs an instance of DocumentsClient, 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
- DocumentsClient
```
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected DocumentsClient(DocumentsStub stub)
```

Method Detail

create

public static final DocumentsClient create()
                                    throws IOException

Constructs an instance of DocumentsClient with default settings.

Throws:: IOException

create
```
public static final DocumentsClient create(DocumentsSettings settings)
                                    throws IOException
```
Constructs an instance of DocumentsClient, 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

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final DocumentsClient create(DocumentsStub stub)

Constructs an instance of DocumentsClient, using the given stub for making calls. This is for advanced usage - prefer using create(DocumentsSettings).

getSettings

public final DocumentsSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public DocumentsStub getStub()

getOperationsClient
```
public final OperationsClient getOperationsClient()
```
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

listDocuments
```
public final DocumentsClient.ListDocumentsPagedResponse listDocuments(KnowledgeBaseName parent)
```
Returns the list of all documents of the knowledge base.
Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`.
Sample code:
```
 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   KnowledgeBaseName parent =
       KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]");
   for (Document element : documentsClient.listDocuments(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
```
Parameters:

parent - Required. The knowledge base to list all documents for. Format: `projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>`.

Throws:

ApiException - if the remote call fails

listDocuments

public final DocumentsClient.ListDocumentsPagedResponse listDocuments(String parent)

Returns the list of all documents of the knowledge base.

Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`.

Sample code:


 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   String parent =
       DocumentName.ofProjectKnowledgeBaseDocumentName(
               "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
           .toString();
   for (Document element : documentsClient.listDocuments(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: parent - Required. The knowledge base to list all documents for. Format: `projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>`.
Throws:: ApiException - if the remote call fails

listDocuments

public final DocumentsClient.ListDocumentsPagedResponse listDocuments(ListDocumentsRequest request)

Returns the list of all documents of the knowledge base.

Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`.

Sample code:


 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   ListDocumentsRequest request =
       ListDocumentsRequest.newBuilder()
           .setParent(
               DocumentName.ofProjectKnowledgeBaseDocumentName(
                       "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   for (Document element : documentsClient.listDocuments(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

listDocumentsPagedCallable

public final UnaryCallable<ListDocumentsRequest,DocumentsClient.ListDocumentsPagedResponse> listDocumentsPagedCallable()

Returns the list of all documents of the knowledge base.

Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`.

Sample code:


 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   ListDocumentsRequest request =
       ListDocumentsRequest.newBuilder()
           .setParent(
               DocumentName.ofProjectKnowledgeBaseDocumentName(
                       "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<Document> future = documentsClient.listDocumentsPagedCallable().futureCall(request);
   // Do something.
   for (Document element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

listDocumentsCallable

public final UnaryCallable<ListDocumentsRequest,ListDocumentsResponse> listDocumentsCallable()

Returns the list of all documents of the knowledge base.

Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`.

Sample code:


 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   ListDocumentsRequest request =
       ListDocumentsRequest.newBuilder()
           .setParent(
               DocumentName.ofProjectKnowledgeBaseDocumentName(
                       "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     ListDocumentsResponse response = documentsClient.listDocumentsCallable().call(request);
     for (Document element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

getDocument
```
public final Document getDocument(DocumentName name)
```
Retrieves the specified document.
Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`.
Sample code:
```
 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   DocumentName name =
       DocumentName.ofProjectKnowledgeBaseDocumentName(
           "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]");
   Document response = documentsClient.getDocument(name);
 }
 
```
Parameters:

name - Required. The name of the document to retrieve. Format `projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.

Throws:

ApiException - if the remote call fails

getDocument
```
public final Document getDocument(String name)
```
Retrieves the specified document.
Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`.
Sample code:
```
 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   String name =
       DocumentName.ofProjectKnowledgeBaseDocumentName(
               "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
           .toString();
   Document response = documentsClient.getDocument(name);
 }
 
```
Parameters:

name - Required. The name of the document to retrieve. Format `projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.

Throws:

ApiException - if the remote call fails

getDocument

public final Document getDocument(GetDocumentRequest request)

Retrieves the specified document.

Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`.

Sample code:


 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   GetDocumentRequest request =
       GetDocumentRequest.newBuilder()
           .setName(
               DocumentName.ofProjectKnowledgeBaseDocumentName(
                       "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
                   .toString())
           .build();
   Document response = documentsClient.getDocument(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

getDocumentCallable

public final UnaryCallable<GetDocumentRequest,Document> getDocumentCallable()

Retrieves the specified document.

Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`.

Sample code:


 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   GetDocumentRequest request =
       GetDocumentRequest.newBuilder()
           .setName(
               DocumentName.ofProjectKnowledgeBaseDocumentName(
                       "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
                   .toString())
           .build();
   ApiFuture<Document> future = documentsClient.getDocumentCallable().futureCall(request);
   // Do something.
   Document response = future.get();
 }

createDocumentAsync

public final OperationFuture<Document,KnowledgeOperationMetadata> createDocumentAsync(KnowledgeBaseName parent,
                                                                                      Document document)

Creates a new document.

Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`.

Sample code:


 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   KnowledgeBaseName parent =
       KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]");
   Document document = Document.newBuilder().build();
   Document response = documentsClient.createDocumentAsync(parent, document).get();
 }

Parameters:: parent - Required. The knowledge base to create a document for. Format: `projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>`.; document - Required. The document to create.
Throws:: ApiException - if the remote call fails

createDocumentAsync

public final OperationFuture<Document,KnowledgeOperationMetadata> createDocumentAsync(String parent,
                                                                                      Document document)

Creates a new document.

Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`.

Sample code:


 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   String parent =
       DocumentName.ofProjectKnowledgeBaseDocumentName(
               "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
           .toString();
   Document document = Document.newBuilder().build();
   Document response = documentsClient.createDocumentAsync(parent, document).get();
 }

Parameters:: parent - Required. The knowledge base to create a document for. Format: `projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>`.; document - Required. The document to create.
Throws:: ApiException - if the remote call fails

createDocumentAsync

public final OperationFuture<Document,KnowledgeOperationMetadata> createDocumentAsync(CreateDocumentRequest request)

Creates a new document.

Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`.

Sample code:


 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   CreateDocumentRequest request =
       CreateDocumentRequest.newBuilder()
           .setParent(
               DocumentName.ofProjectKnowledgeBaseDocumentName(
                       "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
                   .toString())
           .setDocument(Document.newBuilder().build())
           .setImportGcsCustomMetadata(true)
           .build();
   Document response = documentsClient.createDocumentAsync(request).get();
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

createDocumentOperationCallable

public final OperationCallable<CreateDocumentRequest,Document,KnowledgeOperationMetadata> createDocumentOperationCallable()

Creates a new document.

Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`.

Sample code:


 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   CreateDocumentRequest request =
       CreateDocumentRequest.newBuilder()
           .setParent(
               DocumentName.ofProjectKnowledgeBaseDocumentName(
                       "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
                   .toString())
           .setDocument(Document.newBuilder().build())
           .setImportGcsCustomMetadata(true)
           .build();
   OperationFuture<Document, KnowledgeOperationMetadata> future =
       documentsClient.createDocumentOperationCallable().futureCall(request);
   // Do something.
   Document response = future.get();
 }

createDocumentCallable

public final UnaryCallable<CreateDocumentRequest,Operation> createDocumentCallable()

Creates a new document.

Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`.

Sample code:


 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   CreateDocumentRequest request =
       CreateDocumentRequest.newBuilder()
           .setParent(
               DocumentName.ofProjectKnowledgeBaseDocumentName(
                       "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
                   .toString())
           .setDocument(Document.newBuilder().build())
           .setImportGcsCustomMetadata(true)
           .build();
   ApiFuture<Operation> future = documentsClient.createDocumentCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

importDocumentsAsync

public final OperationFuture<ImportDocumentsResponse,KnowledgeOperationMetadata> importDocumentsAsync(ImportDocumentsRequest request)

Create documents by importing data from external sources.

Sample code:


 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   ImportDocumentsRequest request =
       ImportDocumentsRequest.newBuilder()
           .setParent(
               DocumentName.ofProjectKnowledgeBaseDocumentName(
                       "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
                   .toString())
           .setDocumentTemplate(ImportDocumentTemplate.newBuilder().build())
           .setImportGcsCustomMetadata(true)
           .build();
   ImportDocumentsResponse response = documentsClient.importDocumentsAsync(request).get();
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

importDocumentsOperationCallable

public final OperationCallable<ImportDocumentsRequest,ImportDocumentsResponse,KnowledgeOperationMetadata> importDocumentsOperationCallable()

Create documents by importing data from external sources.

Sample code:


 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   ImportDocumentsRequest request =
       ImportDocumentsRequest.newBuilder()
           .setParent(
               DocumentName.ofProjectKnowledgeBaseDocumentName(
                       "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
                   .toString())
           .setDocumentTemplate(ImportDocumentTemplate.newBuilder().build())
           .setImportGcsCustomMetadata(true)
           .build();
   OperationFuture<ImportDocumentsResponse, KnowledgeOperationMetadata> future =
       documentsClient.importDocumentsOperationCallable().futureCall(request);
   // Do something.
   ImportDocumentsResponse response = future.get();
 }

importDocumentsCallable

public final UnaryCallable<ImportDocumentsRequest,Operation> importDocumentsCallable()

Create documents by importing data from external sources.

Sample code:


 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   ImportDocumentsRequest request =
       ImportDocumentsRequest.newBuilder()
           .setParent(
               DocumentName.ofProjectKnowledgeBaseDocumentName(
                       "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
                   .toString())
           .setDocumentTemplate(ImportDocumentTemplate.newBuilder().build())
           .setImportGcsCustomMetadata(true)
           .build();
   ApiFuture<Operation> future = documentsClient.importDocumentsCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

deleteDocumentAsync
```
public final OperationFuture<Empty,KnowledgeOperationMetadata> deleteDocumentAsync(DocumentName name)
```
Deletes the specified document.
Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`.
Sample code:
```
 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   DocumentName name =
       DocumentName.ofProjectKnowledgeBaseDocumentName(
           "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]");
   documentsClient.deleteDocumentAsync(name).get();
 }
 
```
Parameters:

name - Required. The name of the document to delete. Format: `projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.

Throws:

ApiException - if the remote call fails

deleteDocumentAsync
```
public final OperationFuture<Empty,KnowledgeOperationMetadata> deleteDocumentAsync(String name)
```
Deletes the specified document.
Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`.
Sample code:
```
 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   String name =
       DocumentName.ofProjectKnowledgeBaseDocumentName(
               "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
           .toString();
   documentsClient.deleteDocumentAsync(name).get();
 }
 
```
Parameters:

name - Required. The name of the document to delete. Format: `projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.

Throws:

ApiException - if the remote call fails

deleteDocumentAsync

public final OperationFuture<Empty,KnowledgeOperationMetadata> deleteDocumentAsync(DeleteDocumentRequest request)

Deletes the specified document.

Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`.

Sample code:


 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   DeleteDocumentRequest request =
       DeleteDocumentRequest.newBuilder()
           .setName(
               DocumentName.ofProjectKnowledgeBaseDocumentName(
                       "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
                   .toString())
           .build();
   documentsClient.deleteDocumentAsync(request).get();
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

deleteDocumentOperationCallable

public final OperationCallable<DeleteDocumentRequest,Empty,KnowledgeOperationMetadata> deleteDocumentOperationCallable()

Deletes the specified document.

Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`.

Sample code:


 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   DeleteDocumentRequest request =
       DeleteDocumentRequest.newBuilder()
           .setName(
               DocumentName.ofProjectKnowledgeBaseDocumentName(
                       "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
                   .toString())
           .build();
   OperationFuture<Empty, KnowledgeOperationMetadata> future =
       documentsClient.deleteDocumentOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }

deleteDocumentCallable

public final UnaryCallable<DeleteDocumentRequest,Operation> deleteDocumentCallable()

Deletes the specified document.

Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`.

Sample code:


 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   DeleteDocumentRequest request =
       DeleteDocumentRequest.newBuilder()
           .setName(
               DocumentName.ofProjectKnowledgeBaseDocumentName(
                       "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
                   .toString())
           .build();
   ApiFuture<Operation> future = documentsClient.deleteDocumentCallable().futureCall(request);
   // Do something.
   future.get();
 }

updateDocumentAsync

public final OperationFuture<Document,KnowledgeOperationMetadata> updateDocumentAsync(Document document)

Updates the specified document.

Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`.

Sample code:


 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   Document document = Document.newBuilder().build();
   Document response = documentsClient.updateDocumentAsync(document).get();
 }

Parameters:: document - Required. The document to update.
Throws:: ApiException - if the remote call fails

updateDocumentAsync

public final OperationFuture<Document,KnowledgeOperationMetadata> updateDocumentAsync(Document document,
                                                                                      FieldMask updateMask)

Updates the specified document.

Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`.

Sample code:


 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   Document document = Document.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Document response = documentsClient.updateDocumentAsync(document, updateMask).get();
 }

Parameters:: document - Required. The document to update.; updateMask - Optional. Not specified means `update all`. Currently, only `display_name` can be updated, an InvalidArgument will be returned for attempting to update other fields.
Throws:: ApiException - if the remote call fails

updateDocumentAsync

public final OperationFuture<Document,KnowledgeOperationMetadata> updateDocumentAsync(UpdateDocumentRequest request)

Updates the specified document.

Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`.

Sample code:


 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   UpdateDocumentRequest request =
       UpdateDocumentRequest.newBuilder()
           .setDocument(Document.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Document response = documentsClient.updateDocumentAsync(request).get();
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

updateDocumentOperationCallable

public final OperationCallable<UpdateDocumentRequest,Document,KnowledgeOperationMetadata> updateDocumentOperationCallable()

Updates the specified document.

Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`.

Sample code:


 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   UpdateDocumentRequest request =
       UpdateDocumentRequest.newBuilder()
           .setDocument(Document.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   OperationFuture<Document, KnowledgeOperationMetadata> future =
       documentsClient.updateDocumentOperationCallable().futureCall(request);
   // Do something.
   Document response = future.get();
 }

updateDocumentCallable

public final UnaryCallable<UpdateDocumentRequest,Operation> updateDocumentCallable()

Updates the specified document.

Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`.

Sample code:


 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   UpdateDocumentRequest request =
       UpdateDocumentRequest.newBuilder()
           .setDocument(Document.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Operation> future = documentsClient.updateDocumentCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

reloadDocumentAsync
```
public final OperationFuture<Document,KnowledgeOperationMetadata> reloadDocumentAsync(DocumentName name,
                                                                                      GcsSource gcsSource)
```
Reloads the specified document from its specified source, content_uri or content. The previously loaded content of the document will be deleted. Note: Even when the content of the document has not changed, there still may be side effects because of internal implementation changes. Note: If the document source is Google Cloud Storage URI, its metadata will be replaced with the custom metadata from Google Cloud Storage if the `import_gcs_custom_metadata` field is set to true in the request.
Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`.
Sample code:
```
 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   DocumentName name =
       DocumentName.ofProjectKnowledgeBaseDocumentName(
           "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]");
   GcsSource gcsSource = GcsSource.newBuilder().build();
   Document response = documentsClient.reloadDocumentAsync(name, gcsSource).get();
 }
 
```
Parameters:

name - Required. The name of the document to reload. Format: `projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`

gcsSource - The path for a Cloud Storage source file for reloading document content. If not provided, the Document's existing source will be reloaded.

Throws:

ApiException - if the remote call fails

reloadDocumentAsync
```
public final OperationFuture<Document,KnowledgeOperationMetadata> reloadDocumentAsync(String name,
                                                                                      GcsSource gcsSource)
```
Reloads the specified document from its specified source, content_uri or content. The previously loaded content of the document will be deleted. Note: Even when the content of the document has not changed, there still may be side effects because of internal implementation changes. Note: If the document source is Google Cloud Storage URI, its metadata will be replaced with the custom metadata from Google Cloud Storage if the `import_gcs_custom_metadata` field is set to true in the request.
Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`.
Sample code:
```
 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   String name =
       DocumentName.ofProjectKnowledgeBaseDocumentName(
               "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
           .toString();
   GcsSource gcsSource = GcsSource.newBuilder().build();
   Document response = documentsClient.reloadDocumentAsync(name, gcsSource).get();
 }
 
```
Parameters:

name - Required. The name of the document to reload. Format: `projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`

gcsSource - The path for a Cloud Storage source file for reloading document content. If not provided, the Document's existing source will be reloaded.

Throws:

ApiException - if the remote call fails

reloadDocumentAsync
```
public final OperationFuture<Document,KnowledgeOperationMetadata> reloadDocumentAsync(ReloadDocumentRequest request)
```
Reloads the specified document from its specified source, content_uri or content. The previously loaded content of the document will be deleted. Note: Even when the content of the document has not changed, there still may be side effects because of internal implementation changes. Note: If the document source is Google Cloud Storage URI, its metadata will be replaced with the custom metadata from Google Cloud Storage if the `import_gcs_custom_metadata` field is set to true in the request.
Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`.
Sample code:
```
 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   ReloadDocumentRequest request =
       ReloadDocumentRequest.newBuilder()
           .setName(
               DocumentName.ofProjectKnowledgeBaseDocumentName(
                       "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
                   .toString())
           .setImportGcsCustomMetadata(true)
           .build();
   Document response = documentsClient.reloadDocumentAsync(request).get();
 }
 
```
Parameters:

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

Throws:

ApiException - if the remote call fails

reloadDocumentOperationCallable

public final OperationCallable<ReloadDocumentRequest,Document,KnowledgeOperationMetadata> reloadDocumentOperationCallable()

Reloads the specified document from its specified source, content_uri or content. The previously loaded content of the document will be deleted. Note: Even when the content of the document has not changed, there still may be side effects because of internal implementation changes. Note: If the document source is Google Cloud Storage URI, its metadata will be replaced with the custom metadata from Google Cloud Storage if the `import_gcs_custom_metadata` field is set to true in the request.

Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`.

Sample code:


 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   ReloadDocumentRequest request =
       ReloadDocumentRequest.newBuilder()
           .setName(
               DocumentName.ofProjectKnowledgeBaseDocumentName(
                       "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
                   .toString())
           .setImportGcsCustomMetadata(true)
           .build();
   OperationFuture<Document, KnowledgeOperationMetadata> future =
       documentsClient.reloadDocumentOperationCallable().futureCall(request);
   // Do something.
   Document response = future.get();
 }

reloadDocumentCallable
```
public final UnaryCallable<ReloadDocumentRequest,Operation> reloadDocumentCallable()
```
Reloads the specified document from its specified source, content_uri or content. The previously loaded content of the document will be deleted. Note: Even when the content of the document has not changed, there still may be side effects because of internal implementation changes. Note: If the document source is Google Cloud Storage URI, its metadata will be replaced with the custom metadata from Google Cloud Storage if the `import_gcs_custom_metadata` field is set to true in the request.
Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`.
Sample code:
```
 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   ReloadDocumentRequest request =
       ReloadDocumentRequest.newBuilder()
           .setName(
               DocumentName.ofProjectKnowledgeBaseDocumentName(
                       "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
                   .toString())
           .setImportGcsCustomMetadata(true)
           .build();
   ApiFuture<Operation> future = documentsClient.reloadDocumentCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
```

close
```
public final void close()
```
Specified by:

close in interface AutoCloseable

shutdown
```
public void shutdown()
```
Specified by:

shutdown in interface BackgroundResource

isShutdown
```
public boolean isShutdown()
```
Specified by:

isShutdown in interface BackgroundResource

isTerminated
```
public boolean isTerminated()
```
Specified by:

isTerminated in interface BackgroundResource

shutdownNow
```
public void shutdownNow()
```
Specified by:

shutdownNow in interface BackgroundResource

awaitTermination

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

Specified by:: awaitTermination in interface BackgroundResource
Throws:: InterruptedException

Class DocumentsClient

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DocumentsClient

DocumentsClient

Method Detail

create

create

create

getSettings

getStub

getOperationsClient

listDocuments

listDocuments

listDocuments

listDocumentsPagedCallable

listDocumentsCallable

getDocument

getDocument

getDocument

getDocumentCallable

createDocumentAsync

createDocumentAsync

createDocumentAsync

createDocumentOperationCallable

createDocumentCallable

importDocumentsAsync

importDocumentsOperationCallable

importDocumentsCallable

deleteDocumentAsync

deleteDocumentAsync

deleteDocumentAsync

deleteDocumentOperationCallable

deleteDocumentCallable

updateDocumentAsync

updateDocumentAsync

updateDocumentAsync

updateDocumentOperationCallable

updateDocumentCallable

reloadDocumentAsync

reloadDocumentAsync

reloadDocumentAsync

reloadDocumentOperationCallable

reloadDocumentCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination