com.google.cloud.discoveryengine.v1beta

Class DocumentServiceGrpc.DocumentServiceFutureStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractFutureStub<DocumentServiceGrpc.DocumentServiceFutureStub>

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

Methods inherited from class io.grpc.stub.AbstractFutureStub

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.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.v1beta.Document].
 

listDocuments

public com.google.common.util.concurrent.ListenableFuture<ListDocumentsResponse> listDocuments(ListDocumentsRequest request)

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

createDocument

public com.google.common.util.concurrent.ListenableFuture<Document> createDocument(CreateDocumentRequest request)

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

updateDocument

public com.google.common.util.concurrent.ListenableFuture<Document> updateDocument(UpdateDocumentRequest request)

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

deleteDocument

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteDocument(DeleteDocumentRequest request)

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

importDocuments

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> importDocuments(ImportDocumentsRequest request)

 Bulk import of multiple
 [Document][google.cloud.discoveryengine.v1beta.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.v1beta.Document]s to be
 successfully updated.
 

purgeDocuments

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> purgeDocuments(PurgeDocumentsRequest request)

 Permanently deletes all selected
 [Document][google.cloud.discoveryengine.v1beta.Document]s in a branch.
 This process is asynchronous. Depending on the number of
 [Document][google.cloud.discoveryengine.v1beta.Document]s to be deleted,
 this operation can take hours to complete. Before the delete operation
 completes, some [Document][google.cloud.discoveryengine.v1beta.Document]s
 might still be returned by
 [DocumentService.GetDocument][google.cloud.discoveryengine.v1beta.DocumentService.GetDocument]
 or
 [DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments].
 To get a list of the
 [Document][google.cloud.discoveryengine.v1beta.Document]s to be deleted,
 set
 [PurgeDocumentsRequest.force][google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest.force]
 to false.