Class DocumentServiceGrpc.DocumentServiceStub (0.48.0)

public static final class DocumentServiceGrpc.DocumentServiceStub extends AbstractAsyncStub<DocumentServiceGrpc.DocumentServiceStub>

A stub to allow clients to do asynchronous 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.AbstractAsyncStub > DocumentServiceGrpc.DocumentServiceStub

Methods

batchGetDocumentsMetadata(BatchGetDocumentsMetadataRequest request, StreamObserver<BatchGetDocumentsMetadataResponse> responseObserver)

public void batchGetDocumentsMetadata(BatchGetDocumentsMetadataRequest request, StreamObserver<BatchGetDocumentsMetadataResponse> responseObserver)

Gets index freshness metadata for Documents. Supported for website search only.

Parameters
Name Description
request BatchGetDocumentsMetadataRequest
responseObserver io.grpc.stub.StreamObserver<BatchGetDocumentsMetadataResponse>

build(Channel channel, CallOptions callOptions)

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

createDocument(CreateDocumentRequest request, StreamObserver<Document> responseObserver)

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

Creates a Document.

Parameters
Name Description
request CreateDocumentRequest
responseObserver io.grpc.stub.StreamObserver<Document>

deleteDocument(DeleteDocumentRequest request, StreamObserver<Empty> responseObserver)

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

Deletes a Document.

Parameters
Name Description
request DeleteDocumentRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

getDocument(GetDocumentRequest request, StreamObserver<Document> responseObserver)

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

Gets a Document.

Parameters
Name Description
request GetDocumentRequest
responseObserver io.grpc.stub.StreamObserver<Document>

getProcessedDocument(GetProcessedDocumentRequest request, StreamObserver<ProcessedDocument> responseObserver)

public void getProcessedDocument(GetProcessedDocumentRequest request, StreamObserver<ProcessedDocument> responseObserver)

Gets the parsed layout information for a Document.

Parameters
Name Description
request GetProcessedDocumentRequest
responseObserver io.grpc.stub.StreamObserver<ProcessedDocument>

importDocuments(ImportDocumentsRequest request, StreamObserver<Operation> responseObserver)

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

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.

Parameters
Name Description
request ImportDocumentsRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

listDocuments(ListDocumentsRequest request, StreamObserver<ListDocumentsResponse> responseObserver)

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

Gets a list of Documents.

Parameters
Name Description
request ListDocumentsRequest
responseObserver io.grpc.stub.StreamObserver<ListDocumentsResponse>

purgeDocuments(PurgeDocumentsRequest request, StreamObserver<Operation> responseObserver)

public void purgeDocuments(PurgeDocumentsRequest request, StreamObserver<Operation> responseObserver)

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.

Parameters
Name Description
request PurgeDocumentsRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

updateDocument(UpdateDocumentRequest request, StreamObserver<Document> responseObserver)

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

Updates a Document.

Parameters
Name Description
request UpdateDocumentRequest
responseObserver io.grpc.stub.StreamObserver<Document>