com.digitalasset.canton.participant.admin.v0.PruningServiceGrpc
PruningServiceStub
Companion object PruningServiceStub
class PruningServiceStub extends AbstractStub[PruningServiceStub] with PruningService
- Alphabetic
- By Inheritance
- PruningServiceStub
- PruningService
- AbstractService
- AbstractStub
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new PruningServiceStub(channel: Channel, options: CallOptions = _root_.io.grpc.CallOptions.DEFAULT)
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def build(channel: Channel, options: CallOptions): PruningServiceStub
- Definition Classes
- PruningServiceStub → AbstractStub
- def clearSchedule(request: Request): Future[Response]
Disable automatic pruning and remove the persisted schedule configuration.
Disable automatic pruning and remove the persisted schedule configuration.
- Definition Classes
- PruningServiceStub → PruningService
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getCallOptions(): CallOptions
- Definition Classes
- AbstractStub
- final def getChannel(): Channel
- Definition Classes
- AbstractStub
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- def getParticipantSchedule(request: Request): Future[Response]
Retrieve the automatic, participant-specific pruning configuration.
Retrieve the automatic, participant-specific pruning configuration.
- Definition Classes
- PruningServiceStub → PruningService
- def getSafePruningOffset(request: GetSafePruningOffsetRequest): Future[GetSafePruningOffsetResponse]
Retrieve the safe pruning offset
Retrieve the safe pruning offset
- Definition Classes
- PruningServiceStub → PruningService
- def getSchedule(request: Request): Future[Response]
Retrieve the automatic pruning configuration.
Retrieve the automatic pruning configuration.
- Definition Classes
- PruningServiceStub → PruningService
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- def prune(request: PruneRequest): Future[PruneResponse]
Prune the participant specifying the offset before and at which ledger transactions should be removed.
Prune the participant 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 one of the following errors: -
: if the payload, particularly the offset is malformed or missing -INVALID_ARGUMENT
: if the participant has encountered a failure and has potentially applied pruning partially. Such cases warrant verifying the participant health before retrying the prune with the same (or a larger, valid) offset. Successful retries after such errors ensure that different components reach a consistent pruning state. -INTERNAL
: if the participant is not yet able to prune at the specified offset or if pruning is invoked on a participant running the Community Edition.FAILED_PRECONDITION
- Definition Classes
- PruningServiceStub → PruningService
- def serviceCompanion: ServiceCompanion[PruningService]
- Definition Classes
- PruningService → AbstractService
- def setCron(request: Request): Future[Response]
Modify individual pruning schedule parameters.
Modify individual pruning schedule parameters. -
: if the payload is malformed or no schedule is configuredINVALID_ARGUMENT
- Definition Classes
- PruningServiceStub → PruningService
- def setMaxDuration(request: Request): Future[Response]
- Definition Classes
- PruningServiceStub → PruningService
- def setParticipantSchedule(request: Request): Future[Response]
Enable automatic pruning with participant-specific schedule parameters.
Enable automatic pruning with participant-specific schedule parameters.
- Definition Classes
- PruningServiceStub → PruningService
- def setRetention(request: Request): Future[Response]
- Definition Classes
- PruningServiceStub → PruningService
- def setSchedule(request: Request): Future[Response]
Enable automatic pruning using the specified schedule parameters The following errors may occur on the SetSchedule or Update commands: -
: if a parameter is missing or an invalid cron expression or duration.INVALID_ARGUMENT
Enable automatic pruning using the specified schedule parameters The following errors may occur on the SetSchedule or Update commands: -
: if a parameter is missing or an invalid cron expression or duration. -INVALID_ARGUMENT
: if automatic background pruning has not been enabled or if invoked on a participant running the Community Edition.FAILED_PRECONDITION
- Definition Classes
- PruningServiceStub → PruningService
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def withCallCredentials(arg0: CallCredentials): PruningServiceStub
- Definition Classes
- AbstractStub
- final def withCompression(arg0: String): PruningServiceStub
- Definition Classes
- AbstractStub
- final def withDeadline(arg0: Deadline): PruningServiceStub
- Definition Classes
- AbstractStub
- final def withDeadlineAfter(arg0: Long, arg1: TimeUnit): PruningServiceStub
- Definition Classes
- AbstractStub
- final def withExecutor(arg0: Executor): PruningServiceStub
- Definition Classes
- AbstractStub
- final def withInterceptors(arg0: <repeated...>[ClientInterceptor]): PruningServiceStub
- Definition Classes
- AbstractStub
- Annotations
- @transient()
- final def withMaxInboundMessageSize(arg0: Int): PruningServiceStub
- Definition Classes
- AbstractStub
- final def withMaxOutboundMessageSize(arg0: Int): PruningServiceStub
- Definition Classes
- AbstractStub
- final def withOnReadyThreshold(arg0: Int): PruningServiceStub
- Definition Classes
- AbstractStub
- final def withOption[T <: AnyRef](arg0: Key[T], arg1: T): PruningServiceStub
- Definition Classes
- AbstractStub
- final def withWaitForReady(): PruningServiceStub
- Definition Classes
- AbstractStub
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
- Deprecated
- final def withChannel(arg0: Channel): PruningServiceStub
- Definition Classes
- AbstractStub
- Annotations
- @Deprecated @Deprecated
- Deprecated