Package com.google.cloud.dialogflow.v2beta1

Class DocumentsClient

  • All Implemented Interfaces:
    com.google.api.gax.core.BackgroundResource, AutoCloseable
    @BetaApi
@Generated("by gapic-generator-java")
public class DocumentsClient
extends Object
implements com.google.api.gax.core.BackgroundResource
    Service Description: Service for managing knowledge [Documents][google.cloud.dialogflow.v2beta1.Document].

    This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started: 

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

    1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
    2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
    3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

    See the individual methods for example code.

    Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

    This class can be customized by passing in a custom instance of DocumentsSettings to create(). For example:

    To customize credentials: 

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

    • Constructor Detail

      • DocumentsClient

        protected DocumentsClient​(DocumentsSettings settings)
                   throws IOException
        Constructs an instance of DocumentsClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
        Throws:
        IOException

      • DocumentsClient

        protected DocumentsClient​(DocumentsStub stub)

    • Method Detail

      • create

        public static final DocumentsClient create​(DocumentsSettings settings)
                                    throws IOException
        Constructs an instance of DocumentsClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
        Throws:
        IOException

      • create

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

      • getOperationsClient

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

      • getHttpJsonOperationsClient

        @BetaApi
public final com.google.api.gax.httpjson.longrunning.OperationsClient getHttpJsonOperationsClient()
        Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

      • listDocuments

        public final DocumentsClient.ListDocumentsPagedResponse listDocuments​(KnowledgeBaseName parent)
        Returns the list of all documents of the knowledge base.

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

        Sample code: 

        
 // 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);
   }
 }
        Parameters:
        parent - Required. The knowledge base to list all documents for. Format: `projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>`.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listDocuments

        public final DocumentsClient.ListDocumentsPagedResponse listDocuments​(String parent)
        Returns the list of all documents of the knowledge base.

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

        Sample code: 

        
 // 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);
   }
 }
        Parameters:
        parent - Required. The knowledge base to list all documents for. Format: `projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>`.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listDocuments

        public final DocumentsClient.ListDocumentsPagedResponse listDocuments​(ListDocumentsRequest request)
        Returns the list of all documents of the knowledge base.

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

        Sample code: 

        
 // 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);
   }
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listDocumentsPagedCallable

        public final com.google.api.gax.rpc.UnaryCallable<ListDocumentsRequest,​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);
   }
 }

      • listDocumentsCallable

        public final com.google.api.gax.rpc.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;
     }
   }
 }

      • getDocument

        public final Document getDocument​(DocumentName name)
        Retrieves the specified document.

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

        Sample code: 

        
 // 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);
 }
        Parameters:
        name - Required. The name of the document to retrieve. Format `projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getDocument

        public final Document getDocument​(String name)
        Retrieves the specified document.

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

        Sample code: 

        
 // 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);
 }
        Parameters:
        name - Required. The name of the document to retrieve. Format `projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getDocument

        public final Document getDocument​(GetDocumentRequest request)
        Retrieves the specified document.

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

        Sample code: 

        
 // 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);
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getDocumentCallable

        public final com.google.api.gax.rpc.UnaryCallable<GetDocumentRequest,​Document> getDocumentCallable()
        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();
 }

      • createDocumentAsync

        public final com.google.api.gax.longrunning.OperationFuture<Document,​KnowledgeOperationMetadata> createDocumentAsync​(KnowledgeBaseName parent,
                                                                                                                           Document document)
        Creates a new document.

        This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:

        - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] - `response`: [Document][google.cloud.dialogflow.v2beta1.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:
        parent - Required. The knowledge base to create a document for. Format: `projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>`.
        document - Required. The document to create.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • createDocumentAsync

        public final com.google.api.gax.longrunning.OperationFuture<Document,​KnowledgeOperationMetadata> createDocumentAsync​(String parent,
                                                                                                                           Document document)
        Creates a new document.

        This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:

        - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] - `response`: [Document][google.cloud.dialogflow.v2beta1.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:
        parent - Required. The knowledge base to create a document for. Format: `projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>`.
        document - Required. The document to create.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • createDocumentAsync

        public final com.google.api.gax.longrunning.OperationFuture<Document,​KnowledgeOperationMetadata> createDocumentAsync​(CreateDocumentRequest request)
        Creates a new document.

        This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:

        - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] - `response`: [Document][google.cloud.dialogflow.v2beta1.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();
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • createDocumentOperationCallable

        public final com.google.api.gax.rpc.OperationCallable<CreateDocumentRequest,​Document,​KnowledgeOperationMetadata> createDocumentOperationCallable()
        Creates a new document.

        This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:

        - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] - `response`: [Document][google.cloud.dialogflow.v2beta1.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();
 }

      • createDocumentCallable

        public final com.google.api.gax.rpc.UnaryCallable<CreateDocumentRequest,​com.google.longrunning.Operation> createDocumentCallable()
        Creates a new document.

        This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:

        - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] - `response`: [Document][google.cloud.dialogflow.v2beta1.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();
 }

      • importDocumentsAsync

        public final com.google.api.gax.longrunning.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](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:

        - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] - `response`: [ImportDocumentsResponse][google.cloud.dialogflow.v2beta1.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();
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • importDocumentsOperationCallable

        public final com.google.api.gax.rpc.OperationCallable<ImportDocumentsRequest,​ImportDocumentsResponse,​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](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:

        - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] - `response`: [ImportDocumentsResponse][google.cloud.dialogflow.v2beta1.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();
 }

      • importDocumentsCallable

        public final com.google.api.gax.rpc.UnaryCallable<ImportDocumentsRequest,​com.google.longrunning.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](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:

        - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] - `response`: [ImportDocumentsResponse][google.cloud.dialogflow.v2beta1.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();
 }

      • deleteDocumentAsync

        public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,​KnowledgeOperationMetadata> deleteDocumentAsync​(DocumentName name)
        Deletes the specified document.

        This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:

        - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)

        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();
 }
        Parameters:
        name - Required. The name of the document to delete. Format: `projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • deleteDocumentAsync

        public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,​KnowledgeOperationMetadata> deleteDocumentAsync​(String name)
        Deletes the specified document.

        This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:

        - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)

        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();
 }
        Parameters:
        name - Required. The name of the document to delete. Format: `projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • deleteDocumentAsync

        public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,​KnowledgeOperationMetadata> deleteDocumentAsync​(DeleteDocumentRequest request)
        Deletes the specified document.

        This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:

        - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)

        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();
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • deleteDocumentOperationCallable

        public final com.google.api.gax.rpc.OperationCallable<DeleteDocumentRequest,​com.google.protobuf.Empty,​KnowledgeOperationMetadata> deleteDocumentOperationCallable()
        Deletes the specified document.

        This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:

        - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)

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

      • deleteDocumentCallable

        public final com.google.api.gax.rpc.UnaryCallable<DeleteDocumentRequest,​com.google.longrunning.Operation> deleteDocumentCallable()
        Deletes the specified document.

        This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:

        - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)

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

      • updateDocumentAsync

        public final com.google.api.gax.longrunning.OperationFuture<Document,​KnowledgeOperationMetadata> updateDocumentAsync​(Document document)
        Updates the specified document.

        This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:

        - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] - `response`: [Document][google.cloud.dialogflow.v2beta1.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();
 }
        Parameters:
        document - Required. The document to update.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • updateDocumentAsync

        public final com.google.api.gax.longrunning.OperationFuture<Document,​KnowledgeOperationMetadata> updateDocumentAsync​(Document document,
                                                                                                                           com.google.protobuf.FieldMask updateMask)
        Updates the specified document.

        This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:

        - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] - `response`: [Document][google.cloud.dialogflow.v2beta1.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:
        document - Required. The document to update.
        updateMask - Optional. Not specified means `update all`. Currently, only `display_name` can be updated, an InvalidArgument will be returned for attempting to update other fields.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • updateDocumentAsync

        public final com.google.api.gax.longrunning.OperationFuture<Document,​KnowledgeOperationMetadata> updateDocumentAsync​(UpdateDocumentRequest request)
        Updates the specified document.

        This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:

        - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] - `response`: [Document][google.cloud.dialogflow.v2beta1.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();
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • updateDocumentOperationCallable

        public final com.google.api.gax.rpc.OperationCallable<UpdateDocumentRequest,​Document,​KnowledgeOperationMetadata> updateDocumentOperationCallable()
        Updates the specified document.

        This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:

        - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] - `response`: [Document][google.cloud.dialogflow.v2beta1.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();
 }

      • updateDocumentCallable

        public final com.google.api.gax.rpc.UnaryCallable<UpdateDocumentRequest,​com.google.longrunning.Operation> updateDocumentCallable()
        Updates the specified document.

        This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:

        - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] - `response`: [Document][google.cloud.dialogflow.v2beta1.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();
 }

      • reloadDocumentAsync

        public final com.google.api.gax.longrunning.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](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:

        - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] - `response`: [Document][google.cloud.dialogflow.v2beta1.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 - Required. The name of the document to reload. Format: `projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`
        gcsSource - The path for a Cloud Storage source file for reloading document content. If not provided, the Document's existing source will be reloaded.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • reloadDocumentAsync

        public final com.google.api.gax.longrunning.OperationFuture<Document,​KnowledgeOperationMetadata> reloadDocumentAsync​(String name,
                                                                                                                           GcsSource gcsSource)
        Reloads the specified document from its specified source, content_uri or content. The previously loaded content of the document will be deleted. Note: Even when the content of the document has not changed, there still may be side effects because of internal implementation changes. Note: If the document source is Google Cloud Storage URI, its metadata will be replaced with the custom metadata from Google Cloud Storage if the `import_gcs_custom_metadata` field is set to true in the request.

        This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:

        - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] - `response`: [Document][google.cloud.dialogflow.v2beta1.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 - Required. The name of the document to reload. Format: `projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`
        gcsSource - The path for a Cloud Storage source file for reloading document content. If not provided, the Document's existing source will be reloaded.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • reloadDocumentAsync

        public final com.google.api.gax.longrunning.OperationFuture<Document,​KnowledgeOperationMetadata> reloadDocumentAsync​(ReloadDocumentRequest request)
        Reloads the specified document from its specified source, content_uri or content. The previously loaded content of the document will be deleted. Note: Even when the content of the document has not changed, there still may be side effects because of internal implementation changes. Note: If the document source is Google Cloud Storage URI, its metadata will be replaced with the custom metadata from Google Cloud Storage if the `import_gcs_custom_metadata` field is set to true in the request.

        This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:

        - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] - `response`: [Document][google.cloud.dialogflow.v2beta1.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();
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • reloadDocumentOperationCallable

        public final com.google.api.gax.rpc.OperationCallable<ReloadDocumentRequest,​Document,​KnowledgeOperationMetadata> reloadDocumentOperationCallable()
        Reloads the specified document from its specified source, content_uri or content. The previously loaded content of the document will be deleted. Note: Even when the content of the document has not changed, there still may be side effects because of internal implementation changes. Note: If the document source is Google Cloud Storage URI, its metadata will be replaced with the custom metadata from Google Cloud Storage if the `import_gcs_custom_metadata` field is set to true in the request.

        This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:

        - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] - `response`: [Document][google.cloud.dialogflow.v2beta1.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();
 }

      • reloadDocumentCallable

        public final com.google.api.gax.rpc.UnaryCallable<ReloadDocumentRequest,​com.google.longrunning.Operation> reloadDocumentCallable()
        Reloads the specified document from its specified source, content_uri or content. The previously loaded content of the document will be deleted. Note: Even when the content of the document has not changed, there still may be side effects because of internal implementation changes. Note: If the document source is Google Cloud Storage URI, its metadata will be replaced with the custom metadata from Google Cloud Storage if the `import_gcs_custom_metadata` field is set to true in the request.

        This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:

        - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] - `response`: [Document][google.cloud.dialogflow.v2beta1.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();
 }

      • listLocations

        public final DocumentsClient.ListLocationsPagedResponse listLocations​(com.google.cloud.location.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);
   }
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listLocationsPagedCallable

        public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.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);
   }
 }

      • listLocationsCallable

        public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,​com.google.cloud.location.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;
     }
   }
 }

      • getLocation

        public final com.google.cloud.location.Location getLocation​(com.google.cloud.location.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);
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getLocationCallable

        public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,​com.google.cloud.location.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();
 }

      • shutdown

        public void shutdown()
        Specified by:
        shutdown in interface com.google.api.gax.core.BackgroundResource

      • isShutdown

        public boolean isShutdown()
        Specified by:
        isShutdown in interface com.google.api.gax.core.BackgroundResource

      • isTerminated

        public boolean isTerminated()
        Specified by:
        isTerminated in interface com.google.api.gax.core.BackgroundResource

      • shutdownNow

        public void shutdownNow()
        Specified by:
        shutdownNow in interface com.google.api.gax.core.BackgroundResource