Class DocumentsGrpc.DocumentsFutureStub (4.29.0)

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

A stub to allow clients to do ListenableFuture-style rpc calls to service Documents.

Service for managing knowledge Documents.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > DocumentsGrpc.DocumentsFutureStub
io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)
io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)
io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
io.grpc.stub.AbstractStub.getCallOptions()
io.grpc.stub.AbstractStub.getChannel()
io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)
io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)
io.grpc.stub.AbstractStub.withCompression(java.lang.String)
io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)
io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)
io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)
io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)
io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)
io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)
io.grpc.stub.AbstractStub.withWaitForReady()

Methods

build(Channel channel, CallOptions callOptions)

protected DocumentsGrpc.DocumentsFutureStub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
DocumentsGrpc.DocumentsFutureStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createDocument(CreateDocumentRequest request)

public ListenableFuture<Operation> createDocument(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
Parameter
Name Description
request CreateDocumentRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

deleteDocument(DeleteDocumentRequest request)

public ListenableFuture<Operation> deleteDocument(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
Parameter
Name Description
request DeleteDocumentRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

exportDocument(ExportDocumentRequest request)

public ListenableFuture<Operation> exportDocument(ExportDocumentRequest request)

Exports a smart messaging candidate document into the specified destination. This method is a long-running operation. The returned Operation type has the following method-specific fields:

  • metadata: KnowledgeOperationMetadata
  • response: Document
Parameter
Name Description
request ExportDocumentRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

getDocument(GetDocumentRequest request)

public ListenableFuture<Document> getDocument(GetDocumentRequest request)

Retrieves the specified document.

Parameter
Name Description
request GetDocumentRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Document>

importDocuments(ImportDocumentsRequest request)

public ListenableFuture<Operation> importDocuments(ImportDocumentsRequest request)

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. The returned Operation type has the following method-specific fields:

  • metadata: KnowledgeOperationMetadata
  • response: ImportDocumentsResponse
Parameter
Name Description
request ImportDocumentsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

listDocuments(ListDocumentsRequest request)

public ListenableFuture<ListDocumentsResponse> listDocuments(ListDocumentsRequest request)

Returns the list of all documents of the knowledge base.

Parameter
Name Description
request ListDocumentsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListDocumentsResponse>

reloadDocument(ReloadDocumentRequest request)

public 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. 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.
Parameter
Name Description
request ReloadDocumentRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

updateDocument(UpdateDocumentRequest request)

public ListenableFuture<Operation> updateDocument(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
Parameter
Name Description
request UpdateDocumentRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>