com.daml.ledger.api.v1.admin

Class PackageManagementServiceGrpc.PackageManagementServiceStub

java.lang.Object

io.grpc.stub.AbstractStub<PackageManagementServiceGrpc.PackageManagementServiceStub>

com.daml.ledger.api.v1.admin.PackageManagementServiceGrpc.PackageManagementServiceStub

Enclosing class:

PackageManagementServiceGrpc

public static final class PackageManagementServiceGrpc.PackageManagementServiceStub
extends io.grpc.stub.AbstractStub<PackageManagementServiceGrpc.PackageManagementServiceStub>

 Status: experimental interface, will change before it is deemed production
 ready
 Query the Daml-LF packages supported by the ledger participant and upload
 DAR files. We use 'backing participant' to refer to this specific participant
 in the methods of this API.
 

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 PackageManagementServiceGrpc.PackageManagementServiceStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
void	listKnownPackages(PackageManagementServiceOuterClass.ListKnownPackagesRequest request, io.grpc.stub.StreamObserver<PackageManagementServiceOuterClass.ListKnownPackagesResponse> responseObserver) Returns the details of all Daml-LF packages known to the backing participant.
void	uploadDarFile(PackageManagementServiceOuterClass.UploadDarFileRequest request, io.grpc.stub.StreamObserver<PackageManagementServiceOuterClass.UploadDarFileResponse> responseObserver) Upload a DAR file to the backing participant.

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, newStub, newStub, 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 PackageManagementServiceGrpc.PackageManagementServiceStub build(io.grpc.Channel channel,
                                                                          io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<PackageManagementServiceGrpc.PackageManagementServiceStub>

listKnownPackages

public void listKnownPackages(PackageManagementServiceOuterClass.ListKnownPackagesRequest request,
                              io.grpc.stub.StreamObserver<PackageManagementServiceOuterClass.ListKnownPackagesResponse> responseObserver)

 Returns the details of all Daml-LF packages known to the backing participant.
 Errors:
 - ``UNAUTHENTICATED``: if the request does not include a valid access token
 - ``PERMISSION_DENIED``: if the claims in the token are insufficient to perform a given operation
 

uploadDarFile

public void uploadDarFile(PackageManagementServiceOuterClass.UploadDarFileRequest request,
                          io.grpc.stub.StreamObserver<PackageManagementServiceOuterClass.UploadDarFileResponse> responseObserver)

 Upload a DAR file to the backing participant.
 Depending on the ledger implementation this might also make the package 
 available on the whole ledger. This call might not be supported by some 
 ledger implementations. Canton could be an example, where uploading a DAR
 is not sufficient to render it usable, it must be activated first.
 This call may:
 - Succeed, if the package was successfully uploaded, or if the same package
   was already uploaded before.
 - Respond with a gRPC error
 Errors:
 - ``UNAUTHENTICATED``: if the request does not include a valid access token
 - ``PERMISSION_DENIED``: if the claims in the token are insufficient to perform a given operation
 - ``UNIMPLEMENTED``: if DAR package uploading is not supported by the backing participant
 - ``INVALID_ARGUMENT``: if the DAR file is too big or malformed. The maximum supported size is implementation specific.