com.google.cloud.dialogflow.v2beta1

Class DocumentsGrpc.DocumentsFutureStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractFutureStub<DocumentsGrpc.DocumentsFutureStub>

com.google.cloud.dialogflow.v2beta1.DocumentsGrpc.DocumentsFutureStub

Enclosing class:

DocumentsGrpc

public static final class DocumentsGrpc.DocumentsFutureStub
extends AbstractFutureStub<DocumentsGrpc.DocumentsFutureStub>

 Service for managing knowledge [Documents][google.cloud.dialogflow.v2beta1.Document].
 

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

AbstractStub.StubFactory<T extends AbstractStub<T>>

Method Summary

Modifier and Type	Method and Description
protected DocumentsGrpc.DocumentsFutureStub	build(Channel channel, CallOptions callOptions)
com.google.common.util.concurrent.ListenableFuture<Operation>	createDocument(CreateDocumentRequest request) Creates a new document.
com.google.common.util.concurrent.ListenableFuture<Operation>	deleteDocument(DeleteDocumentRequest request) Deletes the specified document.
com.google.common.util.concurrent.ListenableFuture<Document>	getDocument(GetDocumentRequest request) Retrieves the specified document.
com.google.common.util.concurrent.ListenableFuture<Operation>	importDocuments(ImportDocumentsRequest request) Create documents by importing data from external sources.
com.google.common.util.concurrent.ListenableFuture<ListDocumentsResponse>	listDocuments(ListDocumentsRequest request) Returns the list of all documents of the knowledge base.
com.google.common.util.concurrent.ListenableFuture<Operation>	reloadDocument(ReloadDocumentRequest request) Reloads the specified document from its specified source, content_uri or content.
com.google.common.util.concurrent.ListenableFuture<Operation>	updateDocument(UpdateDocumentRequest request) Updates the specified document.

Methods inherited from class io.grpc.stub.AbstractFutureStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

build

protected DocumentsGrpc.DocumentsFutureStub build(Channel channel,
                                                  CallOptions callOptions)

Specified by:

build in class AbstractStub<DocumentsGrpc.DocumentsFutureStub>

listDocuments

public com.google.common.util.concurrent.ListenableFuture<ListDocumentsResponse> 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`.
 

getDocument

public com.google.common.util.concurrent.ListenableFuture<Document> getDocument(GetDocumentRequest request)

 Retrieves the specified document.
 Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
 only use `projects.knowledgeBases.documents`.
 

createDocument

public com.google.common.util.concurrent.ListenableFuture<Operation> createDocument(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`.
 

importDocuments

public com.google.common.util.concurrent.ListenableFuture<Operation> importDocuments(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]
 

deleteDocument

public com.google.common.util.concurrent.ListenableFuture<Operation> deleteDocument(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`.
 

updateDocument

public com.google.common.util.concurrent.ListenableFuture<Operation> updateDocument(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`.
 

reloadDocument

public com.google.common.util.concurrent.ListenableFuture<Operation> reloadDocument(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`.