Package com.google.cloud.dialogflow.v2

Class DocumentsGrpc.DocumentsBlockingV2Stub

java.lang.Object
io.grpc.stub.AbstractStub<S>
io.grpc.stub.AbstractBlockingStub<DocumentsGrpc.DocumentsBlockingV2Stub>
com.google.cloud.dialogflow.v2.DocumentsGrpc.DocumentsBlockingV2Stub
Enclosing class:
DocumentsGrpc
public static final class DocumentsGrpc.DocumentsBlockingV2Stub extends io.grpc.stub.AbstractBlockingStub<DocumentsGrpc.DocumentsBlockingV2Stub>
A stub to allow clients to do synchronous rpc calls to service Documents. 
 Service for managing knowledge
 [Documents][google.cloud.dialogflow.v2.Document].

  • Method Details

    • build

      protected DocumentsGrpc.DocumentsBlockingV2Stub build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
      Specified by:
      build in class io.grpc.stub.AbstractStub<DocumentsGrpc.DocumentsBlockingV2Stub>

    • listDocuments

      public ListDocumentsResponse listDocuments(ListDocumentsRequest request) throws io.grpc.StatusException
       Returns the list of all documents of the knowledge base.
      Throws:
      io.grpc.StatusException

    • getDocument

      public Document getDocument(GetDocumentRequest request) throws io.grpc.StatusException
       Retrieves the specified document.
      Throws:
      io.grpc.StatusException

    • createDocument

      public Operation createDocument(CreateDocumentRequest request) throws io.grpc.StatusException
       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.v2.KnowledgeOperationMetadata]
 - `response`: [Document][google.cloud.dialogflow.v2.Document]
      Throws:
      io.grpc.StatusException

    • importDocuments

      public Operation importDocuments(ImportDocumentsRequest request) throws io.grpc.StatusException
       Creates documents by importing data from external sources.
 Dialogflow supports up to 350 documents in each request. If you try to
 import more, Dialogflow will return an error.
 This method is a [long-running
 operation](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.v2.KnowledgeOperationMetadata]
 - `response`:
 [ImportDocumentsResponse][google.cloud.dialogflow.v2.ImportDocumentsResponse]
      Throws:
      io.grpc.StatusException

    • deleteDocument

      public Operation deleteDocument(DeleteDocumentRequest request) throws io.grpc.StatusException
       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.v2.KnowledgeOperationMetadata]
 - `response`: An [Empty
   message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
      Throws:
      io.grpc.StatusException

    • updateDocument

      public Operation updateDocument(UpdateDocumentRequest request) throws io.grpc.StatusException
       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.v2.KnowledgeOperationMetadata]
 - `response`: [Document][google.cloud.dialogflow.v2.Document]
      Throws:
      io.grpc.StatusException

    • reloadDocument

      public Operation reloadDocument(ReloadDocumentRequest request) throws io.grpc.StatusException
       Reloads the specified document from its specified source, content_uri or
 content. The previously loaded content of the document will be deleted.
 Note: Even when the content of the document has not changed, there still
 may be side effects because of internal implementation changes.
 This method is a [long-running
 operation](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.v2.KnowledgeOperationMetadata]
 - `response`: [Document][google.cloud.dialogflow.v2.Document]
 Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
 only use `projects.knowledgeBases.documents`.
      Throws:
      io.grpc.StatusException

    • exportDocument

      public Operation exportDocument(ExportDocumentRequest request) throws io.grpc.StatusException
       Exports a smart messaging candidate document into the specified
 destination.
 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.v2.KnowledgeOperationMetadata]
 - `response`: [Document][google.cloud.dialogflow.v2.Document]
      Throws:
      io.grpc.StatusException