Interface DocumentServiceGrpc.AsyncService

All Known Implementing Classes:
DocumentServiceGrpc.DocumentServiceImplBase
Enclosing class:
DocumentServiceGrpc

public static interface DocumentServiceGrpc.AsyncService
 Service for ingesting [Document][google.cloud.discoveryengine.v1.Document]
 information of the customer's website.
 
  • Method Details

    • getDocument

      default void getDocument(GetDocumentRequest request, io.grpc.stub.StreamObserver<Document> responseObserver)
       Gets a [Document][google.cloud.discoveryengine.v1.Document].
       
    • listDocuments

      default void listDocuments(ListDocumentsRequest request, io.grpc.stub.StreamObserver<ListDocumentsResponse> responseObserver)
       Gets a list of [Document][google.cloud.discoveryengine.v1.Document]s.
       
    • createDocument

      default void createDocument(CreateDocumentRequest request, io.grpc.stub.StreamObserver<Document> responseObserver)
       Creates a [Document][google.cloud.discoveryengine.v1.Document].
       
    • updateDocument

      default void updateDocument(UpdateDocumentRequest request, io.grpc.stub.StreamObserver<Document> responseObserver)
       Updates a [Document][google.cloud.discoveryengine.v1.Document].
       
    • deleteDocument

      default void deleteDocument(DeleteDocumentRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
       Deletes a [Document][google.cloud.discoveryengine.v1.Document].
       
    • importDocuments

      default void importDocuments(ImportDocumentsRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver)
       Bulk import of multiple
       [Document][google.cloud.discoveryengine.v1.Document]s. Request processing
       may be synchronous. Non-existing items are created.
       Note: It is possible for a subset of the
       [Document][google.cloud.discoveryengine.v1.Document]s to be successfully
       updated.
       
    • purgeDocuments

      default void purgeDocuments(PurgeDocumentsRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver)
       Permanently deletes all selected
       [Document][google.cloud.discoveryengine.v1.Document]s in a branch.
       This process is asynchronous. Depending on the number of
       [Document][google.cloud.discoveryengine.v1.Document]s to be deleted, this
       operation can take hours to complete. Before the delete operation
       completes, some [Document][google.cloud.discoveryengine.v1.Document]s might
       still be returned by
       [DocumentService.GetDocument][google.cloud.discoveryengine.v1.DocumentService.GetDocument]
       or
       [DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments].
       To get a list of the [Document][google.cloud.discoveryengine.v1.Document]s
       to be deleted, set
       [PurgeDocumentsRequest.force][google.cloud.discoveryengine.v1.PurgeDocumentsRequest.force]
       to false.
       
    • batchGetDocumentsMetadata

      default void batchGetDocumentsMetadata(BatchGetDocumentsMetadataRequest request, io.grpc.stub.StreamObserver<BatchGetDocumentsMetadataResponse> responseObserver)
       Gets index freshness metadata for
       [Document][google.cloud.discoveryengine.v1.Document]s. Supported for
       website search only.