Class DocumentsClient (4.42.0)

GitHub RepositoryProduct Reference

Service Description: Service for managing knowledge Documents.

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

Methods
Method Description Method Variants

ListDocuments

Returns the list of all documents of the knowledge base.

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(KnowledgeBaseName 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()

GetDocument

Retrieves the specified 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()

CreateDocument

Creates a new document.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: KnowledgeOperationMetadata - response: Document

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createDocumentAsync(CreateDocumentRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • createDocumentAsync(KnowledgeBaseName parent, Document document)

  • createDocumentAsync(String parent, Document document)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createDocumentOperationCallable()

  • createDocumentCallable()

ImportDocuments

Creates documents by importing data from external sources. Dialogflow supports up to 350 documents in each request. If you try to import more, Dialogflow will return an error.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: KnowledgeOperationMetadata - response: ImportDocumentsResponse

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

DeleteDocument

Deletes the specified document.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: KnowledgeOperationMetadata - response: An Empty message

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteDocumentAsync(DeleteDocumentRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteDocumentAsync(DocumentName name)

  • deleteDocumentAsync(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.

  • deleteDocumentOperationCallable()

  • deleteDocumentCallable()

UpdateDocument

Updates the specified document.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: KnowledgeOperationMetadata - response: Document

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateDocumentAsync(UpdateDocumentRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updateDocumentAsync(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.

  • updateDocumentOperationCallable()

  • updateDocumentCallable()

ReloadDocument

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.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: KnowledgeOperationMetadata - response: Document

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • reloadDocumentAsync(ReloadDocumentRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • reloadDocumentAsync(DocumentName name, String contentUri)

  • reloadDocumentAsync(String name, String contentUri)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • reloadDocumentOperationCallable()

  • reloadDocumentCallable()

ExportDocument

Exports a smart messaging candidate document into the specified destination.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: KnowledgeOperationMetadata - response: Document

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • exportDocumentAsync(ExportDocumentRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • exportDocumentOperationCallable()

  • exportDocumentCallable()

ListLocations

Lists information about the supported locations for this service.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listLocations(ListLocationsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listLocationsPagedCallable()

  • listLocationsCallable()

GetLocation

Gets information about a location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getLocation(GetLocationRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getLocationCallable()

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:


 // 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
 DocumentsSettings documentsSettings =
     DocumentsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DocumentsClient documentsClient = DocumentsClient.create(documentsSettings);
 

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
 DocumentsSettings documentsSettings =
     DocumentsSettings.newBuilder().setEndpoint(myEndpoint).build();
 DocumentsClient documentsClient = DocumentsClient.create(documentsSettings);
 

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
 DocumentsSettings documentsSettings = DocumentsSettings.newHttpJsonBuilder().build();
 DocumentsClient documentsClient = DocumentsClient.create(documentsSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > DocumentsClient

Static Methods

create()

public static final DocumentsClient create()

Constructs an instance of DocumentsClient with default settings.

Returns
Type Description
DocumentsClient
Exceptions
Type Description
IOException

create(DocumentsSettings settings)

public static final DocumentsClient create(DocumentsSettings settings)

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.

Parameter
Name Description
settings DocumentsSettings
Returns
Type Description
DocumentsClient
Exceptions
Type Description
IOException

create(DocumentsStub stub)

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

Parameter
Name Description
stub DocumentsStub
Returns
Type Description
DocumentsClient

Constructors

DocumentsClient(DocumentsSettings settings)

protected DocumentsClient(DocumentsSettings settings)

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.

Parameter
Name Description
settings DocumentsSettings

DocumentsClient(DocumentsStub stub)

protected DocumentsClient(DocumentsStub stub)
Parameter
Name Description
stub DocumentsStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

close()

public final void close()

createDocumentAsync(CreateDocumentRequest request)

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

Creates a new document.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: KnowledgeOperationMetadata - response: 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 (DocumentsClient documentsClient = DocumentsClient.create()) {
   CreateDocumentRequest request =
       CreateDocumentRequest.newBuilder()
           .setParent(
               KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]")
                   .toString())
           .setDocument(Document.newBuilder().build())
           .build();
   Document response = documentsClient.createDocumentAsync(request).get();
 }
 
Parameter
Name Description
request CreateDocumentRequest

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

Returns
Type Description
OperationFuture<Document,KnowledgeOperationMetadata>

createDocumentAsync(KnowledgeBaseName parent, Document document)

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

Creates a new document.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: KnowledgeOperationMetadata - response: 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 (DocumentsClient documentsClient = DocumentsClient.create()) {
   KnowledgeBaseName parent =
       KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]");
   Document document = Document.newBuilder().build();
   Document response = documentsClient.createDocumentAsync(parent, document).get();
 }
 
Parameters
Name Description
parent KnowledgeBaseName

Required. The knowledge base to create a document for. Format: projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>.

document Document

Required. The document to create.

Returns
Type Description
OperationFuture<Document,KnowledgeOperationMetadata>

createDocumentAsync(String parent, Document document)

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

Creates a new document.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: KnowledgeOperationMetadata - response: 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 (DocumentsClient documentsClient = DocumentsClient.create()) {
   String parent =
       KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]").toString();
   Document document = Document.newBuilder().build();
   Document response = documentsClient.createDocumentAsync(parent, document).get();
 }
 
Parameters
Name Description
parent String

Required. The knowledge base to create a document for. Format: projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>.

document Document

Required. The document to create.

Returns
Type Description
OperationFuture<Document,KnowledgeOperationMetadata>

createDocumentCallable()

public final UnaryCallable<CreateDocumentRequest,Operation> createDocumentCallable()

Creates a new document.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: KnowledgeOperationMetadata - response: 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 (DocumentsClient documentsClient = DocumentsClient.create()) {
   CreateDocumentRequest request =
       CreateDocumentRequest.newBuilder()
           .setParent(
               KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]")
                   .toString())
           .setDocument(Document.newBuilder().build())
           .build();
   ApiFuture<Operation> future = documentsClient.createDocumentCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateDocumentRequest,Operation>

createDocumentOperationCallable()

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

Creates a new document.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: KnowledgeOperationMetadata - response: 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 (DocumentsClient documentsClient = DocumentsClient.create()) {
   CreateDocumentRequest request =
       CreateDocumentRequest.newBuilder()
           .setParent(
               KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]")
                   .toString())
           .setDocument(Document.newBuilder().build())
           .build();
   OperationFuture<Document, KnowledgeOperationMetadata> future =
       documentsClient.createDocumentOperationCallable().futureCall(request);
   // Do something.
   Document response = future.get();
 }
 
Returns
Type Description
OperationCallable<CreateDocumentRequest,Document,KnowledgeOperationMetadata>

deleteDocumentAsync(DeleteDocumentRequest request)

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

Deletes the specified document.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: KnowledgeOperationMetadata - response: An Empty message

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 (DocumentsClient documentsClient = DocumentsClient.create()) {
   DeleteDocumentRequest request =
       DeleteDocumentRequest.newBuilder()
           .setName(
               DocumentName.ofProjectKnowledgeBaseDocumentName(
                       "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
                   .toString())
           .build();
   documentsClient.deleteDocumentAsync(request).get();
 }
 
Parameter
Name Description
request DeleteDocumentRequest

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

Returns
Type Description
OperationFuture<Empty,KnowledgeOperationMetadata>

deleteDocumentAsync(DocumentName name)

public final OperationFuture<Empty,KnowledgeOperationMetadata> deleteDocumentAsync(DocumentName name)

Deletes the specified document.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: KnowledgeOperationMetadata - response: An Empty message

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 (DocumentsClient documentsClient = DocumentsClient.create()) {
   DocumentName name =
       DocumentName.ofProjectKnowledgeBaseDocumentName(
           "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]");
   documentsClient.deleteDocumentAsync(name).get();
 }
 
Parameter
Name Description
name DocumentName

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

Returns
Type Description
OperationFuture<Empty,KnowledgeOperationMetadata>

deleteDocumentAsync(String name)

public final OperationFuture<Empty,KnowledgeOperationMetadata> deleteDocumentAsync(String name)

Deletes the specified document.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: KnowledgeOperationMetadata - response: An Empty message

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 (DocumentsClient documentsClient = DocumentsClient.create()) {
   String name =
       DocumentName.ofProjectKnowledgeBaseDocumentName(
               "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
           .toString();
   documentsClient.deleteDocumentAsync(name).get();
 }
 
Parameter
Name Description
name String

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

Returns
Type Description
OperationFuture<Empty,KnowledgeOperationMetadata>

deleteDocumentCallable()

public final UnaryCallable<DeleteDocumentRequest,Operation> deleteDocumentCallable()

Deletes the specified document.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: KnowledgeOperationMetadata - response: An Empty message

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 (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();
 }
 
Returns
Type Description
UnaryCallable<DeleteDocumentRequest,Operation>

deleteDocumentOperationCallable()

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

Deletes the specified document.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: KnowledgeOperationMetadata - response: An Empty message

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 (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();
 }
 
Returns
Type Description
OperationCallable<DeleteDocumentRequest,Empty,KnowledgeOperationMetadata>

exportDocumentAsync(ExportDocumentRequest request)

public final OperationFuture<Document,KnowledgeOperationMetadata> exportDocumentAsync(ExportDocumentRequest request)

Exports a smart messaging candidate document into the specified destination.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: KnowledgeOperationMetadata - response: 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 (DocumentsClient documentsClient = DocumentsClient.create()) {
   ExportDocumentRequest request =
       ExportDocumentRequest.newBuilder()
           .setName(
               DocumentName.ofProjectKnowledgeBaseDocumentName(
                       "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
                   .toString())
           .setExportFullContent(true)
           .setSmartMessagingPartialUpdate(true)
           .build();
   Document response = documentsClient.exportDocumentAsync(request).get();
 }
 
Parameter
Name Description
request ExportDocumentRequest

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

Returns
Type Description
OperationFuture<Document,KnowledgeOperationMetadata>

exportDocumentCallable()

public final UnaryCallable<ExportDocumentRequest,Operation> exportDocumentCallable()

Exports a smart messaging candidate document into the specified destination.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: KnowledgeOperationMetadata - response: 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 (DocumentsClient documentsClient = DocumentsClient.create()) {
   ExportDocumentRequest request =
       ExportDocumentRequest.newBuilder()
           .setName(
               DocumentName.ofProjectKnowledgeBaseDocumentName(
                       "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
                   .toString())
           .setExportFullContent(true)
           .setSmartMessagingPartialUpdate(true)
           .build();
   ApiFuture<Operation> future = documentsClient.exportDocumentCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<ExportDocumentRequest,Operation>

exportDocumentOperationCallable()

public final OperationCallable<ExportDocumentRequest,Document,KnowledgeOperationMetadata> exportDocumentOperationCallable()

Exports a smart messaging candidate document into the specified destination.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: KnowledgeOperationMetadata - response: 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 (DocumentsClient documentsClient = DocumentsClient.create()) {
   ExportDocumentRequest request =
       ExportDocumentRequest.newBuilder()
           .setName(
               DocumentName.ofProjectKnowledgeBaseDocumentName(
                       "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
                   .toString())
           .setExportFullContent(true)
           .setSmartMessagingPartialUpdate(true)
           .build();
   OperationFuture<Document, KnowledgeOperationMetadata> future =
       documentsClient.exportDocumentOperationCallable().futureCall(request);
   // Do something.
   Document response = future.get();
 }
 
Returns
Type Description
OperationCallable<ExportDocumentRequest,Document,KnowledgeOperationMetadata>

getDocument(DocumentName name)

public final Document getDocument(DocumentName name)

Retrieves the specified 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 (DocumentsClient documentsClient = DocumentsClient.create()) {
   DocumentName name =
       DocumentName.ofProjectKnowledgeBaseDocumentName(
           "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]");
   Document response = documentsClient.getDocument(name);
 }
 
Parameter
Name Description
name DocumentName

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

Returns
Type Description
Document

getDocument(GetDocumentRequest request)

public final Document getDocument(GetDocumentRequest request)

Retrieves the specified 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 (DocumentsClient documentsClient = DocumentsClient.create()) {
   GetDocumentRequest request =
       GetDocumentRequest.newBuilder()
           .setName(
               DocumentName.ofProjectKnowledgeBaseDocumentName(
                       "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
                   .toString())
           .build();
   Document response = documentsClient.getDocument(request);
 }
 
Parameter
Name Description
request GetDocumentRequest

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

Returns
Type Description
Document

getDocument(String name)

public final Document getDocument(String name)

Retrieves the specified 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 (DocumentsClient documentsClient = DocumentsClient.create()) {
   String name =
       DocumentName.ofProjectKnowledgeBaseDocumentName(
               "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
           .toString();
   Document response = documentsClient.getDocument(name);
 }
 
Parameter
Name Description
name String

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

Returns
Type Description
Document

getDocumentCallable()

public final UnaryCallable<GetDocumentRequest,Document> getDocumentCallable()

Retrieves the specified 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 (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();
 }
 
Returns
Type Description
UnaryCallable<GetDocumentRequest,Document>

getHttpJsonOperationsClient()

public final OperationsClient getHttpJsonOperationsClient()

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

Returns
Type Description
OperationsClient

getLocation(GetLocationRequest request)

public final Location getLocation(GetLocationRequest request)

Gets information about a location.

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 (DocumentsClient documentsClient = DocumentsClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = documentsClient.getLocation(request);
 }
 
Parameter
Name Description
request com.google.cloud.location.GetLocationRequest

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

Returns
Type Description
com.google.cloud.location.Location

getLocationCallable()

public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()

Gets information about a location.

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 (DocumentsClient documentsClient = DocumentsClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future = documentsClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }
 
Returns
Type Description
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getOperationsClient()

public final OperationsClient getOperationsClient()

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

Returns
Type Description
OperationsClient

getSettings()

public final DocumentsSettings getSettings()
Returns
Type Description
DocumentsSettings

getStub()

public DocumentsStub getStub()
Returns
Type Description
DocumentsStub

importDocumentsAsync(ImportDocumentsRequest request)

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

Creates documents by importing data from external sources. Dialogflow supports up to 350 documents in each request. If you try to import more, Dialogflow will return an error.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: KnowledgeOperationMetadata - response: ImportDocumentsResponse

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 (DocumentsClient documentsClient = DocumentsClient.create()) {
   ImportDocumentsRequest request =
       ImportDocumentsRequest.newBuilder()
           .setParent(
               KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]")
                   .toString())
           .setDocumentTemplate(ImportDocumentTemplate.newBuilder().build())
           .setImportGcsCustomMetadata(true)
           .build();
   ImportDocumentsResponse response = documentsClient.importDocumentsAsync(request).get();
 }
 
Parameter
Name Description
request ImportDocumentsRequest

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

Returns
Type Description
OperationFuture<ImportDocumentsResponse,KnowledgeOperationMetadata>

importDocumentsCallable()

public final UnaryCallable<ImportDocumentsRequest,Operation> importDocumentsCallable()

Creates documents by importing data from external sources. Dialogflow supports up to 350 documents in each request. If you try to import more, Dialogflow will return an error.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: KnowledgeOperationMetadata - response: ImportDocumentsResponse

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 (DocumentsClient documentsClient = DocumentsClient.create()) {
   ImportDocumentsRequest request =
       ImportDocumentsRequest.newBuilder()
           .setParent(
               KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]")
                   .toString())
           .setDocumentTemplate(ImportDocumentTemplate.newBuilder().build())
           .setImportGcsCustomMetadata(true)
           .build();
   ApiFuture<Operation> future = documentsClient.importDocumentsCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<ImportDocumentsRequest,Operation>

importDocumentsOperationCallable()

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

Creates documents by importing data from external sources. Dialogflow supports up to 350 documents in each request. If you try to import more, Dialogflow will return an error.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: KnowledgeOperationMetadata - response: ImportDocumentsResponse

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 (DocumentsClient documentsClient = DocumentsClient.create()) {
   ImportDocumentsRequest request =
       ImportDocumentsRequest.newBuilder()
           .setParent(
               KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]")
                   .toString())
           .setDocumentTemplate(ImportDocumentTemplate.newBuilder().build())
           .setImportGcsCustomMetadata(true)
           .build();
   OperationFuture<ImportDocumentsResponse, KnowledgeOperationMetadata> future =
       documentsClient.importDocumentsOperationCallable().futureCall(request);
   // Do something.
   ImportDocumentsResponse response = future.get();
 }
 
Returns
Type Description
OperationCallable<ImportDocumentsRequest,ImportDocumentsResponse,KnowledgeOperationMetadata>

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listDocuments(KnowledgeBaseName parent)

public final DocumentsClient.ListDocumentsPagedResponse listDocuments(KnowledgeBaseName parent)

Returns the list of all documents of the knowledge base.

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 (DocumentsClient documentsClient = DocumentsClient.create()) {
   KnowledgeBaseName parent =
       KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]");
   for (Document element : documentsClient.listDocuments(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent KnowledgeBaseName

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

Returns
Type Description
DocumentsClient.ListDocumentsPagedResponse

listDocuments(ListDocumentsRequest request)

public final DocumentsClient.ListDocumentsPagedResponse listDocuments(ListDocumentsRequest request)

Returns the list of all documents of the knowledge base.

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 (DocumentsClient documentsClient = DocumentsClient.create()) {
   ListDocumentsRequest request =
       ListDocumentsRequest.newBuilder()
           .setParent(
               KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   for (Document element : documentsClient.listDocuments(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListDocumentsRequest

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

Returns
Type Description
DocumentsClient.ListDocumentsPagedResponse

listDocuments(String parent)

public final DocumentsClient.ListDocumentsPagedResponse listDocuments(String parent)

Returns the list of all documents of the knowledge base.

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 (DocumentsClient documentsClient = DocumentsClient.create()) {
   String parent =
       KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]").toString();
   for (Document element : documentsClient.listDocuments(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

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

Returns
Type Description
DocumentsClient.ListDocumentsPagedResponse

listDocumentsCallable()

public final UnaryCallable<ListDocumentsRequest,ListDocumentsResponse> listDocumentsCallable()

Returns the list of all documents of the knowledge base.

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 (DocumentsClient documentsClient = DocumentsClient.create()) {
   ListDocumentsRequest request =
       ListDocumentsRequest.newBuilder()
           .setParent(
               KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     ListDocumentsResponse response = documentsClient.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;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListDocumentsRequest,ListDocumentsResponse>

listDocumentsPagedCallable()

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

Returns the list of all documents of the knowledge base.

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 (DocumentsClient documentsClient = DocumentsClient.create()) {
   ListDocumentsRequest request =
       ListDocumentsRequest.newBuilder()
           .setParent(
               KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]")
                   .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);
   }
 }
 
Returns
Type Description
UnaryCallable<ListDocumentsRequest,ListDocumentsPagedResponse>

listLocations(ListLocationsRequest request)

public final DocumentsClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)

Lists information about the supported locations for this service.

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 (DocumentsClient documentsClient = DocumentsClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : documentsClient.listLocations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request com.google.cloud.location.ListLocationsRequest

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

Returns
Type Description
DocumentsClient.ListLocationsPagedResponse

listLocationsCallable()

public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()

Lists information about the supported locations for this service.

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 (DocumentsClient documentsClient = DocumentsClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response = documentsClient.listLocationsCallable().call(request);
     for (Location element : response.getLocationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>

listLocationsPagedCallable()

public final UnaryCallable<ListLocationsRequest,DocumentsClient.ListLocationsPagedResponse> listLocationsPagedCallable()

Lists information about the supported locations for this service.

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 (DocumentsClient documentsClient = DocumentsClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future = documentsClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>

reloadDocumentAsync(DocumentName name, String contentUri)

public final OperationFuture<Document,KnowledgeOperationMetadata> reloadDocumentAsync(DocumentName name, String contentUri)

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.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: KnowledgeOperationMetadata - response: Document

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

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 (DocumentsClient documentsClient = DocumentsClient.create()) {
   DocumentName name =
       DocumentName.ofProjectKnowledgeBaseDocumentName(
           "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]");
   String contentUri = "contentUri264542771";
   Document response = documentsClient.reloadDocumentAsync(name, contentUri).get();
 }
 
Parameters
Name Description
name DocumentName

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

contentUri String

Optional. The path of gcs source file for reloading document content. For now, only gcs uri is supported.

For documents stored in Google Cloud Storage, these URIs must have the form gs://<bucket-name>/<object-name>.

Returns
Type Description
OperationFuture<Document,KnowledgeOperationMetadata>

reloadDocumentAsync(ReloadDocumentRequest request)

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.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: KnowledgeOperationMetadata - response: Document

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

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 (DocumentsClient documentsClient = DocumentsClient.create()) {
   ReloadDocumentRequest request =
       ReloadDocumentRequest.newBuilder()
           .setName(
               DocumentName.ofProjectKnowledgeBaseDocumentName(
                       "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
                   .toString())
           .setImportGcsCustomMetadata(true)
           .setSmartMessagingPartialUpdate(true)
           .build();
   Document response = documentsClient.reloadDocumentAsync(request).get();
 }
 
Parameter
Name Description
request ReloadDocumentRequest

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

Returns
Type Description
OperationFuture<Document,KnowledgeOperationMetadata>

reloadDocumentAsync(String name, String contentUri)

public final OperationFuture<Document,KnowledgeOperationMetadata> reloadDocumentAsync(String name, String contentUri)

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.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: KnowledgeOperationMetadata - response: Document

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

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 (DocumentsClient documentsClient = DocumentsClient.create()) {
   String name =
       DocumentName.ofProjectKnowledgeBaseDocumentName(
               "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
           .toString();
   String contentUri = "contentUri264542771";
   Document response = documentsClient.reloadDocumentAsync(name, contentUri).get();
 }
 
Parameters
Name Description
name String

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

contentUri String

Optional. The path of gcs source file for reloading document content. For now, only gcs uri is supported.

For documents stored in Google Cloud Storage, these URIs must have the form gs://<bucket-name>/<object-name>.

Returns
Type Description
OperationFuture<Document,KnowledgeOperationMetadata>

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.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: KnowledgeOperationMetadata - response: Document

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

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 (DocumentsClient documentsClient = DocumentsClient.create()) {
   ReloadDocumentRequest request =
       ReloadDocumentRequest.newBuilder()
           .setName(
               DocumentName.ofProjectKnowledgeBaseDocumentName(
                       "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
                   .toString())
           .setImportGcsCustomMetadata(true)
           .setSmartMessagingPartialUpdate(true)
           .build();
   ApiFuture<Operation> future = documentsClient.reloadDocumentCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<ReloadDocumentRequest,Operation>

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.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: KnowledgeOperationMetadata - response: Document

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

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 (DocumentsClient documentsClient = DocumentsClient.create()) {
   ReloadDocumentRequest request =
       ReloadDocumentRequest.newBuilder()
           .setName(
               DocumentName.ofProjectKnowledgeBaseDocumentName(
                       "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
                   .toString())
           .setImportGcsCustomMetadata(true)
           .setSmartMessagingPartialUpdate(true)
           .build();
   OperationFuture<Document, KnowledgeOperationMetadata> future =
       documentsClient.reloadDocumentOperationCallable().futureCall(request);
   // Do something.
   Document response = future.get();
 }
 
Returns
Type Description
OperationCallable<ReloadDocumentRequest,Document,KnowledgeOperationMetadata>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateDocumentAsync(Document document, FieldMask updateMask)

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

Updates the specified document.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: KnowledgeOperationMetadata - response: 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 (DocumentsClient documentsClient = DocumentsClient.create()) {
   Document document = Document.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Document response = documentsClient.updateDocumentAsync(document, updateMask).get();
 }
 
Parameters
Name Description
document Document

Required. The document to update.

updateMask FieldMask

Optional. Not specified means update all. Currently, only display_name can be updated, an InvalidArgument will be returned for attempting to update other fields.

Returns
Type Description
OperationFuture<Document,KnowledgeOperationMetadata>

updateDocumentAsync(UpdateDocumentRequest request)

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

Updates the specified document.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: KnowledgeOperationMetadata - response: 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 (DocumentsClient documentsClient = DocumentsClient.create()) {
   UpdateDocumentRequest request =
       UpdateDocumentRequest.newBuilder()
           .setDocument(Document.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Document response = documentsClient.updateDocumentAsync(request).get();
 }
 
Parameter
Name Description
request UpdateDocumentRequest

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

Returns
Type Description
OperationFuture<Document,KnowledgeOperationMetadata>

updateDocumentCallable()

public final UnaryCallable<UpdateDocumentRequest,Operation> updateDocumentCallable()

Updates the specified document.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: KnowledgeOperationMetadata - response: 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 (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();
 }
 
Returns
Type Description
UnaryCallable<UpdateDocumentRequest,Operation>

updateDocumentOperationCallable()

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

Updates the specified document.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: KnowledgeOperationMetadata - response: 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 (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();
 }
 
Returns
Type Description
OperationCallable<UpdateDocumentRequest,Document,KnowledgeOperationMetadata>