Class DocumentsClient (4.15.0)

public class DocumentsClient implements BackgroundResource

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

The surface of this class includes several types of Java methods for each of the API's methods:

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


 // 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

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

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()) {
   CreateDocumentRequest request =
       CreateDocumentRequest.newBuilder()
           .setParent(
               KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]")
                   .toString())
           .setDocument(Document.newBuilder().build())
           .setImportGcsCustomMetadata(true)
           .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

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

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

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()) {
   CreateDocumentRequest request =
       CreateDocumentRequest.newBuilder()
           .setParent(
               KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]")
                   .toString())
           .setDocument(Document.newBuilder().build())
           .setImportGcsCustomMetadata(true)
           .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

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()) {
   CreateDocumentRequest request =
       CreateDocumentRequest.newBuilder()
           .setParent(
               KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]")
                   .toString())
           .setDocument(Document.newBuilder().build())
           .setImportGcsCustomMetadata(true)
           .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

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

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]");
   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

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

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

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

getDocument(DocumentName name)

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:


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

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

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

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

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

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

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

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

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

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

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

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()) {
   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, GcsSource gcsSource)

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.

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]");
   GcsSource gcsSource = GcsSource.newBuilder().build();
   Document response = documentsClient.reloadDocumentAsync(name, gcsSource).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>`
`gcsSource`	`GcsSource` The path for a Cloud Storage source file for reloading document content. If not provided, the Document's existing source will be reloaded.

Returns

Type	Description
`OperationFuture<Document,KnowledgeOperationMetadata>`

reloadDocumentAsync(ReloadDocumentRequest request)

public final OperationFuture<Document,KnowledgeOperationMetadata> reloadDocumentAsync(ReloadDocumentRequest request)

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)
           .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, GcsSource gcsSource)

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

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();
   GcsSource gcsSource = GcsSource.newBuilder().build();
   Document response = documentsClient.reloadDocumentAsync(name, gcsSource).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>`
`gcsSource`	`GcsSource` The path for a Cloud Storage source file for reloading document content. If not provided, the Document's existing source will be reloaded.

Returns

Type	Description
`OperationFuture<Document,KnowledgeOperationMetadata>`

reloadDocumentCallable()

public final UnaryCallable<ReloadDocumentRequest,Operation> reloadDocumentCallable()

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

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

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

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

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()) {
   Document document = Document.newBuilder().build();
   Document response = documentsClient.updateDocumentAsync(document).get();
 }

Parameter

Name	Description
`document`	`Document` Required. The document to update.

Returns

Type	Description
`OperationFuture<Document,KnowledgeOperationMetadata>`

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

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

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

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

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