Class DocumentServiceGrpc.DocumentServiceBlockingV2Stub
java.lang.Object
io.grpc.stub.AbstractStub<S>
io.grpc.stub.AbstractBlockingStub<DocumentServiceGrpc.DocumentServiceBlockingV2Stub>
com.google.cloud.discoveryengine.v1alpha.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.v1alpha.Document] information of the customer's website.
-
Nested Class Summary
Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub
io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>> -
Method Summary
Modifier and TypeMethodDescriptionGets index freshness metadata for [Document][google.cloud.discoveryengine.v1alpha.Document]s.build(io.grpc.Channel channel, io.grpc.CallOptions callOptions) createDocument(CreateDocumentRequest request) Creates a [Document][google.cloud.discoveryengine.v1alpha.Document].com.google.protobuf.EmptydeleteDocument(DeleteDocumentRequest request) Deletes a [Document][google.cloud.discoveryengine.v1alpha.Document].getDocument(GetDocumentRequest request) Gets a [Document][google.cloud.discoveryengine.v1alpha.Document].Gets the parsed layout information for a [Document][google.cloud.discoveryengine.v1alpha.Document].importDocuments(ImportDocumentsRequest request) Bulk import of multiple [Document][google.cloud.discoveryengine.v1alpha.Document]s.listDocuments(ListDocumentsRequest request) Gets a list of [Document][google.cloud.discoveryengine.v1alpha.Document]s.purgeDocuments(PurgeDocumentsRequest request) Permanently deletes all selected [Document][google.cloud.discoveryengine.v1alpha.Document]s in a branch.updateDocument(UpdateDocumentRequest request) Updates a [Document][google.cloud.discoveryengine.v1alpha.Document].Methods inherited from class io.grpc.stub.AbstractBlockingStub
newStub, newStubMethods inherited from class io.grpc.stub.AbstractStub
getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOnReadyThreshold, withOption, withWaitForReady
-
Method Details
-
build
protected DocumentServiceGrpc.DocumentServiceBlockingV2Stub build(io.grpc.Channel channel, io.grpc.CallOptions callOptions) - Specified by:
buildin classio.grpc.stub.AbstractStub<DocumentServiceGrpc.DocumentServiceBlockingV2Stub>
-
getDocument
Gets a [Document][google.cloud.discoveryengine.v1alpha.Document].
- Throws:
io.grpc.StatusException
-
listDocuments
public ListDocumentsResponse listDocuments(ListDocumentsRequest request) throws io.grpc.StatusException Gets a list of [Document][google.cloud.discoveryengine.v1alpha.Document]s.
- Throws:
io.grpc.StatusException
-
createDocument
Creates a [Document][google.cloud.discoveryengine.v1alpha.Document].
- Throws:
io.grpc.StatusException
-
updateDocument
Updates a [Document][google.cloud.discoveryengine.v1alpha.Document].
- Throws:
io.grpc.StatusException
-
deleteDocument
public com.google.protobuf.Empty deleteDocument(DeleteDocumentRequest request) throws io.grpc.StatusException Deletes a [Document][google.cloud.discoveryengine.v1alpha.Document].
- Throws:
io.grpc.StatusException
-
importDocuments
Bulk import of multiple [Document][google.cloud.discoveryengine.v1alpha.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.v1alpha.Document]s to be successfully updated.
- Throws:
io.grpc.StatusException
-
purgeDocuments
Permanently deletes all selected [Document][google.cloud.discoveryengine.v1alpha.Document]s in a branch. This process is asynchronous. Depending on the number of [Document][google.cloud.discoveryengine.v1alpha.Document]s to be deleted, this operation can take hours to complete. Before the delete operation completes, some [Document][google.cloud.discoveryengine.v1alpha.Document]s might still be returned by [DocumentService.GetDocument][google.cloud.discoveryengine.v1alpha.DocumentService.GetDocument] or [DocumentService.ListDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments]. To get a list of the [Document][google.cloud.discoveryengine.v1alpha.Document]s to be deleted, set [PurgeDocumentsRequest.force][google.cloud.discoveryengine.v1alpha.PurgeDocumentsRequest.force] to false.
- Throws:
io.grpc.StatusException
-
getProcessedDocument
public ProcessedDocument getProcessedDocument(GetProcessedDocumentRequest request) throws io.grpc.StatusException Gets the parsed layout information for a [Document][google.cloud.discoveryengine.v1alpha.Document].
- Throws:
io.grpc.StatusException
-
batchGetDocumentsMetadata
public BatchGetDocumentsMetadataResponse batchGetDocumentsMetadata(BatchGetDocumentsMetadataRequest request) throws io.grpc.StatusException Gets index freshness metadata for [Document][google.cloud.discoveryengine.v1alpha.Document]s. Supported for website search only.
- Throws:
io.grpc.StatusException
-