Package com.daml.ledger.api.v1.admin

Class ParticipantPruningServiceGrpc.ParticipantPruningServiceFutureStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractFutureStub<ParticipantPruningServiceGrpc.ParticipantPruningServiceFutureStub>

com.daml.ledger.api.v1.admin.ParticipantPruningServiceGrpc.ParticipantPruningServiceFutureStub

Enclosing class:

ParticipantPruningServiceGrpc

public static final class ParticipantPruningServiceGrpc.ParticipantPruningServiceFutureStub
extends io.grpc.stub.AbstractFutureStub<ParticipantPruningServiceGrpc.ParticipantPruningServiceFutureStub>

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

 Prunes/truncates the "oldest" transactions from the participant (the participant Ledger Api Server plus any other
 participant-local state) by removing a portion of the ledger in such a way that the set of future, allowed
 commands are not affected.
 This enables:
 1. keeping the "inactive" portion of the ledger to a manageable size and
 2. removing inactive state to honor the right to be forgotten.
 

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 ParticipantPruningServiceGrpc.ParticipantPruningServiceFutureStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
com.google.common.util.concurrent.ListenableFuture<ParticipantPruningServiceOuterClass.PruneResponse>	prune(ParticipantPruningServiceOuterClass.PruneRequest request)	Prune the ledger specifying the offset before and at which ledger transactions should be removed.

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 ParticipantPruningServiceGrpc.ParticipantPruningServiceFutureStub build(io.grpc.Channel channel,
                                                                                  io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<ParticipantPruningServiceGrpc.ParticipantPruningServiceFutureStub>

prune

public com.google.common.util.concurrent.ListenableFuture<ParticipantPruningServiceOuterClass.PruneResponse> prune(ParticipantPruningServiceOuterClass.PruneRequest request)

 Prune the ledger specifying the offset before and at which ledger transactions should be removed. Only returns when
 the potentially long-running prune request ends successfully or with an error.