Class DocumentServiceGrpc.DocumentServiceBlockingV2Stub (0.60.0) 

public static final class DocumentServiceGrpc.DocumentServiceBlockingV2Stub extends AbstractBlockingStub<DocumentServiceGrpc.DocumentServiceBlockingV2Stub>

A stub to allow clients to do synchronous 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.AbstractBlockingStub > DocumentServiceGrpc.DocumentServiceBlockingV2Stub

Methods

batchGetDocumentsMetadata(BatchGetDocumentsMetadataRequest request)

public BatchGetDocumentsMetadataResponse batchGetDocumentsMetadata(BatchGetDocumentsMetadataRequest request)

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

Parameter
Name Description
request BatchGetDocumentsMetadataRequest
Returns
Type Description
BatchGetDocumentsMetadataResponse

build(Channel channel, CallOptions callOptions)

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

createDocument(CreateDocumentRequest request)

public Document createDocument(CreateDocumentRequest request)

Creates a Document.

Parameter
Name Description
request CreateDocumentRequest
Returns
Type Description
Document

deleteDocument(DeleteDocumentRequest request)

public Empty deleteDocument(DeleteDocumentRequest request)

Deletes a Document.

Parameter
Name Description
request DeleteDocumentRequest
Returns
Type Description
Empty

getDocument(GetDocumentRequest request)

public Document getDocument(GetDocumentRequest request)

Gets a Document.

Parameter
Name Description
request GetDocumentRequest
Returns
Type Description
Document

importDocuments(ImportDocumentsRequest request)

public 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
Operation

listDocuments(ListDocumentsRequest request)

public ListDocumentsResponse listDocuments(ListDocumentsRequest request)

Gets a list of Documents.

Parameter
Name Description
request ListDocumentsRequest
Returns
Type Description
ListDocumentsResponse

purgeDocuments(PurgeDocumentsRequest request)

public 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
Operation

updateDocument(UpdateDocumentRequest request)

public Document updateDocument(UpdateDocumentRequest request)

Updates a Document.

Parameter
Name Description
request UpdateDocumentRequest
Returns
Type Description
Document