Class DocumentServiceGrpc.DocumentServiceFutureStub (0.42.0)

public static final class DocumentServiceGrpc.DocumentServiceFutureStub extends AbstractFutureStub<DocumentServiceGrpc.DocumentServiceFutureStub>

A stub to allow clients to do ListenableFuture-style rpc calls to service DocumentService.

This service lets you manage document.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > DocumentServiceGrpc.DocumentServiceFutureStub

Inherited Members

io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)

io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.getCallOptions()

io.grpc.stub.AbstractStub.getChannel()

io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)

io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)

io.grpc.stub.AbstractStub.withCompression(java.lang.String)

io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)

io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)

io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)

io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)

io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)

io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)

io.grpc.stub.AbstractStub.withWaitForReady()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

build(Channel channel, CallOptions callOptions)

protected DocumentServiceGrpc.DocumentServiceFutureStub build(Channel channel, CallOptions callOptions)

Parameters
Name	Description
`channel`	`io.grpc.Channel`
`callOptions`	`io.grpc.CallOptions`

Returns
Type	Description
`DocumentServiceGrpc.DocumentServiceFutureStub`

Overrides

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createDocument(CreateDocumentRequest request)

public ListenableFuture<CreateDocumentResponse> createDocument(CreateDocumentRequest request)

Creates a document.

Parameter
Name	Description
`request`	`CreateDocumentRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<CreateDocumentResponse>`

deleteDocument(DeleteDocumentRequest request)

public ListenableFuture<Empty> deleteDocument(DeleteDocumentRequest request)

Deletes a document. Returns NOT_FOUND if the document does not exist.

Parameter
Name	Description
`request`	`DeleteDocumentRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Empty>`

fetchAcl(FetchAclRequest request)

public ListenableFuture<FetchAclResponse> fetchAcl(FetchAclRequest request)

Gets the access control policy for a resource. Returns NOT_FOUND error if the resource does not exist. Returns an empty policy if the resource exists but does not have a policy set.

Parameter
Name	Description
`request`	`FetchAclRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<FetchAclResponse>`

getDocument(GetDocumentRequest request)

public ListenableFuture<Document> getDocument(GetDocumentRequest request)

Gets a document. Returns NOT_FOUND if the document does not exist.

Parameter
Name	Description
`request`	`GetDocumentRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Document>`

lockDocument(LockDocumentRequest request)

public ListenableFuture<Document> lockDocument(LockDocumentRequest request)

Lock the document so the document cannot be updated by other users.

Parameter
Name	Description
`request`	`LockDocumentRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Document>`

searchDocuments(SearchDocumentsRequest request)

public ListenableFuture<SearchDocumentsResponse> searchDocuments(SearchDocumentsRequest request)

Searches for documents using provided SearchDocumentsRequest. This call only returns documents that the caller has permission to search against.

Parameter
Name	Description
`request`	`SearchDocumentsRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<SearchDocumentsResponse>`

setAcl(SetAclRequest request)

public ListenableFuture<SetAclResponse> setAcl(SetAclRequest request)

Sets the access control policy for a resource. Replaces any existing policy.

Parameter
Name	Description
`request`	`SetAclRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<SetAclResponse>`

updateDocument(UpdateDocumentRequest request)

public ListenableFuture<UpdateDocumentResponse> updateDocument(UpdateDocumentRequest request)

Updates a document. Returns INVALID_ARGUMENT if the name of the document is non-empty and does not equal the existing name.

Parameter
Name	Description
`request`	`UpdateDocumentRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<UpdateDocumentResponse>`