Class DocumentServiceGrpc.DocumentServiceBlockingStub (0.37.0)

public static final class DocumentServiceGrpc.DocumentServiceBlockingStub extends AbstractBlockingStub<DocumentServiceGrpc.DocumentServiceBlockingStub>

A stub to allow clients to do synchronous rpc calls to service DocumentService.

This service lets you manage document.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > DocumentServiceGrpc.DocumentServiceBlockingStub

Methods

build(Channel channel, CallOptions callOptions)

protected DocumentServiceGrpc.DocumentServiceBlockingStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
DocumentServiceGrpc.DocumentServiceBlockingStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createDocument(CreateDocumentRequest request)

public CreateDocumentResponse createDocument(CreateDocumentRequest request)

Creates a document.

Parameter
NameDescription
requestCreateDocumentRequest
Returns
TypeDescription
CreateDocumentResponse

deleteDocument(DeleteDocumentRequest request)

public Empty deleteDocument(DeleteDocumentRequest request)

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

Parameter
NameDescription
requestDeleteDocumentRequest
Returns
TypeDescription
Empty

fetchAcl(FetchAclRequest request)

public 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
NameDescription
requestFetchAclRequest
Returns
TypeDescription
FetchAclResponse

getDocument(GetDocumentRequest request)

public Document getDocument(GetDocumentRequest request)

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

Parameter
NameDescription
requestGetDocumentRequest
Returns
TypeDescription
Document

lockDocument(LockDocumentRequest request)

public Document lockDocument(LockDocumentRequest request)

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

Parameter
NameDescription
requestLockDocumentRequest
Returns
TypeDescription
Document

searchDocuments(SearchDocumentsRequest request)

public SearchDocumentsResponse searchDocuments(SearchDocumentsRequest request)

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

Parameter
NameDescription
requestSearchDocumentsRequest
Returns
TypeDescription
SearchDocumentsResponse

setAcl(SetAclRequest request)

public SetAclResponse setAcl(SetAclRequest request)

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

Parameter
NameDescription
requestSetAclRequest
Returns
TypeDescription
SetAclResponse

updateDocument(UpdateDocumentRequest request)

public 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
NameDescription
requestUpdateDocumentRequest
Returns
TypeDescription
UpdateDocumentResponse