trait PruningServiceBlockingClient extends AnyRef
- Alphabetic
- By Inheritance
- PruningServiceBlockingClient
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def clearSchedule(request: ClearScheduleRequest): ClearScheduleResponse
Disable automatic pruning and remove the persisted schedule configuration.
- abstract def getNoWaitCommitmentsFrom(request: GetNoWaitCommitmentsFromRequest): GetNoWaitCommitmentsFromResponse
Retrieve the configuration of waiting for commitments from counter-participants Participants that have been removed from the topology will still be visible in the list until they are removed from the no wait configuration.
- abstract def getParticipantSchedule(request: GetParticipantScheduleRequest): GetParticipantScheduleResponse
Retrieve the automatic, participant-specific pruning configuration.
- abstract def getSafePruningOffset(request: GetSafePruningOffsetRequest): GetSafePruningOffsetResponse
Retrieve the safe pruning offset
- abstract def getSchedule(request: GetScheduleRequest): GetScheduleResponse
Retrieve the automatic pruning configuration.
- abstract def prune(request: PruneRequest): 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. Note that this endpoint only prunes the Canton stores not the ledger API stores. For the latter, use the pruning service on the ledger API. This limitation only applies to this endpoint, the other endpoints in this service, most notably the ones for scheduled pruning prune all stores.FAILED_PRECONDITION
- abstract def resetNoWaitCommitmentsFrom(request: ResetNoWaitCommitmentsFromRequest): ResetNoWaitCommitmentsFromResponse
Enable waiting for commitments from the given counter-participants Waiting for commitments is the default behavior; explicitly enabling it is useful if it was explicitly disabled
- abstract def setCron(request: SetCronRequest): SetCronResponse
Modify individual pruning schedule parameters.
Modify individual pruning schedule parameters. -
: if the payload is malformed or no schedule is configuredINVALID_ARGUMENT
- abstract def setMaxDuration(request: SetMaxDurationRequest): SetMaxDurationResponse
- abstract def setNoWaitCommitmentsFrom(request: SetNoWaitCommitmentsFromRequest): SetNoWaitCommitmentsFromResponse
Disable waiting for commitments from the given counter-participants Disabling waiting for commitments disregards these counter-participants w.r.t.
Disable waiting for commitments from the given counter-participants Disabling waiting for commitments disregards these counter-participants w.r.t. pruning, which gives up non-repudiation for those counter-participants, but increases pruning resilience to failures and slowdowns of those counter-participants and/or the network
- abstract def setParticipantSchedule(request: SetParticipantScheduleRequest): SetParticipantScheduleResponse
Enable automatic pruning with participant-specific schedule parameters.
- abstract def setRetention(request: SetRetentionRequest): SetRetentionResponse
- abstract def setSchedule(request: SetScheduleRequest): SetScheduleResponse
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
Concrete 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 clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- 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
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- def serviceCompanion: ServiceCompanion[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])