Class DocumentServiceGrpc.DocumentServiceFutureStub (0.41.0)

public static final class DocumentServiceGrpc.DocumentServiceFutureStub extends AbstractFutureStub<DocumentServiceGrpc.DocumentServiceFutureStub>

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

Service for ingesting Document information of the customer's website.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > DocumentServiceGrpc.DocumentServiceFutureStub

Methods

build(Channel channel, CallOptions callOptions)

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

createDocument(CreateDocumentRequest request)

public ListenableFuture<Document> createDocument(CreateDocumentRequest request)

Creates a Document.

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

deleteDocument(DeleteDocumentRequest request)

public ListenableFuture<Empty> deleteDocument(DeleteDocumentRequest request)

Deletes a Document.

Parameter
Name Description
request DeleteDocumentRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

getDocument(GetDocumentRequest request)

public ListenableFuture<Document> getDocument(GetDocumentRequest request)

Gets a Document.

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

getProcessedDocument(GetProcessedDocumentRequest request)

public ListenableFuture<ProcessedDocument> getProcessedDocument(GetProcessedDocumentRequest request)

Gets the parsed layout information for a Document.

Parameter
Name Description
request GetProcessedDocumentRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ProcessedDocument>

importDocuments(ImportDocumentsRequest request)

public ListenableFuture<Operation> importDocuments(ImportDocumentsRequest request)

Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items are created. Note: It is possible for a subset of the Documents to be successfully updated.

Parameter
Name Description
request ImportDocumentsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

listDocuments(ListDocumentsRequest request)

public ListenableFuture<ListDocumentsResponse> listDocuments(ListDocumentsRequest request)

Gets a list of Documents.

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

purgeDocuments(PurgeDocumentsRequest request)

public ListenableFuture<Operation> purgeDocuments(PurgeDocumentsRequest request)

Permanently deletes all selected Documents in a branch. This process is asynchronous. Depending on the number of Documents to be deleted, this operation can take hours to complete. Before the delete operation completes, some Documents might still be returned by DocumentService.GetDocument or DocumentService.ListDocuments. To get a list of the Documents to be deleted, set PurgeDocumentsRequest.force to false.

Parameter
Name Description
request PurgeDocumentsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

updateDocument(UpdateDocumentRequest request)

public ListenableFuture<Document> updateDocument(UpdateDocumentRequest request)

Updates a Document.

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