Package com.google.cloud.discoveryengine.v1

Class DocumentServiceGrpc.DocumentServiceBlockingStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractBlockingStub<DocumentServiceGrpc.DocumentServiceBlockingStub>

com.google.cloud.discoveryengine.v1.DocumentServiceGrpc.DocumentServiceBlockingStub

Enclosing class:

DocumentServiceGrpc

public static final class DocumentServiceGrpc.DocumentServiceBlockingStub
extends io.grpc.stub.AbstractBlockingStub<DocumentServiceGrpc.DocumentServiceBlockingStub>

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.
 

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 Type	Method	Description
protected DocumentServiceGrpc.DocumentServiceBlockingStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
Document	createDocument(CreateDocumentRequest request)	Creates a [Document][google.cloud.discoveryengine.v1.Document].
com.google.protobuf.Empty	deleteDocument(DeleteDocumentRequest request)	Deletes a [Document][google.cloud.discoveryengine.v1.Document].
Document	getDocument(GetDocumentRequest request)	Gets a [Document][google.cloud.discoveryengine.v1.Document].
com.google.longrunning.Operation	importDocuments(ImportDocumentsRequest request)	Bulk import of multiple [Document][google.cloud.discoveryengine.v1.Document]s.
ListDocumentsResponse	listDocuments(ListDocumentsRequest request)	Gets a list of [Document][google.cloud.discoveryengine.v1.Document]s.
com.google.longrunning.Operation	purgeDocuments(PurgeDocumentsRequest request)	Permanently deletes all selected [Document][google.cloud.discoveryengine.v1.Document]s in a branch.
Document	updateDocument(UpdateDocumentRequest request)	Updates a [Document][google.cloud.discoveryengine.v1.Document].

Methods inherited from class io.grpc.stub.AbstractBlockingStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

build

protected DocumentServiceGrpc.DocumentServiceBlockingStub build(io.grpc.Channel channel,
                                                                io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<DocumentServiceGrpc.DocumentServiceBlockingStub>

getDocument

public Document getDocument(GetDocumentRequest request)

 Gets a [Document][google.cloud.discoveryengine.v1.Document].
 

listDocuments

public ListDocumentsResponse listDocuments(ListDocumentsRequest request)

 Gets a list of [Document][google.cloud.discoveryengine.v1.Document]s.
 

createDocument

public Document createDocument(CreateDocumentRequest request)

 Creates a [Document][google.cloud.discoveryengine.v1.Document].
 

updateDocument

public Document updateDocument(UpdateDocumentRequest request)

 Updates a [Document][google.cloud.discoveryengine.v1.Document].
 

deleteDocument

public com.google.protobuf.Empty deleteDocument(DeleteDocumentRequest request)

 Deletes a [Document][google.cloud.discoveryengine.v1.Document].
 

importDocuments

public com.google.longrunning.Operation importDocuments(ImportDocumentsRequest request)

 Bulk import of multiple
 [Document][google.cloud.discoveryengine.v1.Document]s. Request processing
 may be synchronous. Non-existing items will be 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.longrunning.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.