com.google.cloud.dialogflow.v2

Class DocumentsGrpc.DocumentsStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractAsyncStub<DocumentsGrpc.DocumentsStub>

com.google.cloud.dialogflow.v2.DocumentsGrpc.DocumentsStub

Enclosing class:

DocumentsGrpc

public static final class DocumentsGrpc.DocumentsStub
extends AbstractAsyncStub<DocumentsGrpc.DocumentsStub>

 Service for managing knowledge [Documents][google.cloud.dialogflow.v2.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.DocumentsStub	build(Channel channel, CallOptions callOptions)
void	createDocument(CreateDocumentRequest request, StreamObserver<Operation> responseObserver) Creates a new document.
void	deleteDocument(DeleteDocumentRequest request, StreamObserver<Operation> responseObserver) Deletes the specified document.
void	exportDocument(ExportDocumentRequest request, StreamObserver<Operation> responseObserver) Exports a smart messaging candidate document into the specified destination.
void	getDocument(GetDocumentRequest request, StreamObserver<Document> responseObserver) Retrieves the specified document.
void	importDocuments(ImportDocumentsRequest request, StreamObserver<Operation> responseObserver) Creates documents by importing data from external sources.
void	listDocuments(ListDocumentsRequest request, StreamObserver<ListDocumentsResponse> responseObserver) Returns the list of all documents of the knowledge base.
void	reloadDocument(ReloadDocumentRequest request, StreamObserver<Operation> responseObserver) Reloads the specified document from its specified source, content_uri or content.
void	updateDocument(UpdateDocumentRequest request, StreamObserver<Operation> responseObserver) Updates the specified document.

Methods inherited from class io.grpc.stub.AbstractAsyncStub

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.DocumentsStub build(Channel channel,
                                            CallOptions callOptions)

Specified by:

build in class AbstractStub<DocumentsGrpc.DocumentsStub>

listDocuments

public void listDocuments(ListDocumentsRequest request,
                          StreamObserver<ListDocumentsResponse> responseObserver)

 Returns the list of all documents of the knowledge base.
 

getDocument

public void getDocument(GetDocumentRequest request,
                        StreamObserver<Document> responseObserver)

 Retrieves the specified document.
 

createDocument

public void createDocument(CreateDocumentRequest request,
                           StreamObserver<Operation> responseObserver)

 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]
 

importDocuments

public void importDocuments(ImportDocumentsRequest request,
                            StreamObserver<Operation> responseObserver)

 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]
 

deleteDocument

public void deleteDocument(DeleteDocumentRequest request,
                           StreamObserver<Operation> responseObserver)

 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)
 

updateDocument

public void updateDocument(UpdateDocumentRequest request,
                           StreamObserver<Operation> responseObserver)

 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]
 

reloadDocument

public void reloadDocument(ReloadDocumentRequest request,
                           StreamObserver<Operation> responseObserver)

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

exportDocument

public void exportDocument(ExportDocumentRequest request,
                           StreamObserver<Operation> responseObserver)

 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]