Package com.google.cloud.discoveryengine.v1

Class DocumentServiceGrpc.DocumentServiceFutureStub

java.lang.Object
io.grpc.stub.AbstractStub<S>
io.grpc.stub.AbstractFutureStub<DocumentServiceGrpc.DocumentServiceFutureStub>
com.google.cloud.discoveryengine.v1.DocumentServiceGrpc.DocumentServiceFutureStub
Enclosing class:
DocumentServiceGrpc
public static final class DocumentServiceGrpc.DocumentServiceFutureStub extends io.grpc.stub.AbstractFutureStub<DocumentServiceGrpc.DocumentServiceFutureStub>
A stub to allow clients to do ListenableFuture-style rpc calls to service DocumentService. 
 Service for ingesting [Document][google.cloud.discoveryengine.v1.Document]
 information of the customer's website.

  • Method Details

    • build

      protected DocumentServiceGrpc.DocumentServiceFutureStub build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
      Specified by:
      build in class io.grpc.stub.AbstractStub<DocumentServiceGrpc.DocumentServiceFutureStub>

    • getDocument

      public com.google.common.util.concurrent.ListenableFuture<Document> getDocument(GetDocumentRequest request)
       Gets a [Document][google.cloud.discoveryengine.v1.Document].

    • listDocuments

      public com.google.common.util.concurrent.ListenableFuture<ListDocumentsResponse> listDocuments(ListDocumentsRequest request)
       Gets a list of [Document][google.cloud.discoveryengine.v1.Document]s.

    • createDocument

      public com.google.common.util.concurrent.ListenableFuture<Document> createDocument(CreateDocumentRequest request)
       Creates a [Document][google.cloud.discoveryengine.v1.Document].

    • updateDocument

      public com.google.common.util.concurrent.ListenableFuture<Document> updateDocument(UpdateDocumentRequest request)
       Updates a [Document][google.cloud.discoveryengine.v1.Document].

    • deleteDocument

      public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteDocument(DeleteDocumentRequest request)
       Deletes a [Document][google.cloud.discoveryengine.v1.Document].

    • importDocuments

      public com.google.common.util.concurrent.ListenableFuture<Operation> importDocuments(ImportDocumentsRequest request)
       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

      public com.google.common.util.concurrent.ListenableFuture<Operation> purgeDocuments(PurgeDocumentsRequest request)
       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

      public com.google.common.util.concurrent.ListenableFuture<BatchGetDocumentsMetadataResponse> batchGetDocumentsMetadata(BatchGetDocumentsMetadataRequest request)
       Gets index freshness metadata for
 [Document][google.cloud.discoveryengine.v1.Document]s. Supported for
 website search only.