Package com.google.cloud.discoveryengine.v1

Class DocumentServiceGrpc.DocumentServiceBlockingV2Stub

java.lang.Object
io.grpc.stub.AbstractStub<S>
io.grpc.stub.AbstractBlockingStub<DocumentServiceGrpc.DocumentServiceBlockingV2Stub>
com.google.cloud.discoveryengine.v1.DocumentServiceGrpc.DocumentServiceBlockingV2Stub
Enclosing class:
DocumentServiceGrpc
public static final class DocumentServiceGrpc.DocumentServiceBlockingV2Stub extends io.grpc.stub.AbstractBlockingStub<DocumentServiceGrpc.DocumentServiceBlockingV2Stub>
A stub to allow clients to do synchronous 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.DocumentServiceBlockingV2Stub build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
      Specified by:
      build in class io.grpc.stub.AbstractStub<DocumentServiceGrpc.DocumentServiceBlockingV2Stub>

    • getDocument

      public Document getDocument(GetDocumentRequest request) throws io.grpc.StatusException
       Gets a [Document][google.cloud.discoveryengine.v1.Document].
      Throws:
      io.grpc.StatusException

    • listDocuments

      public ListDocumentsResponse listDocuments(ListDocumentsRequest request) throws io.grpc.StatusException
       Gets a list of [Document][google.cloud.discoveryengine.v1.Document]s.
      Throws:
      io.grpc.StatusException

    • createDocument

      public Document createDocument(CreateDocumentRequest request) throws io.grpc.StatusException
       Creates a [Document][google.cloud.discoveryengine.v1.Document].
      Throws:
      io.grpc.StatusException

    • updateDocument

      public Document updateDocument(UpdateDocumentRequest request) throws io.grpc.StatusException
       Updates a [Document][google.cloud.discoveryengine.v1.Document].
      Throws:
      io.grpc.StatusException

    • deleteDocument

      public com.google.protobuf.Empty deleteDocument(DeleteDocumentRequest request) throws io.grpc.StatusException
       Deletes a [Document][google.cloud.discoveryengine.v1.Document].
      Throws:
      io.grpc.StatusException

    • importDocuments

      public Operation importDocuments(ImportDocumentsRequest request) throws io.grpc.StatusException
       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.
      Throws:
      io.grpc.StatusException

    • purgeDocuments

      public Operation purgeDocuments(PurgeDocumentsRequest request) throws io.grpc.StatusException
       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.
      Throws:
      io.grpc.StatusException

    • batchGetDocumentsMetadata

      public BatchGetDocumentsMetadataResponse batchGetDocumentsMetadata(BatchGetDocumentsMetadataRequest request) throws io.grpc.StatusException
       Gets index freshness metadata for
 [Document][google.cloud.discoveryengine.v1.Document]s. Supported for
 website search only.
      Throws:
      io.grpc.StatusException