Interface DocumentServiceGrpc.AsyncService (0.50.0)

Version 0.50.0

• 0.51.0 (latest)
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public static interface DocumentServiceGrpc.AsyncService

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

Methods

batchGetDocumentsMetadata(BatchGetDocumentsMetadataRequest request, StreamObserver<BatchGetDocumentsMetadataResponse> responseObserver)

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

createDocument(CreateDocumentRequest request, StreamObserver<Document> responseObserver)

public default 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 default 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 default 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 default 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 default 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 default 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 default 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 default void updateDocument(UpdateDocumentRequest request, StreamObserver<Document> responseObserver)

Updates a Document.

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