Packages

trait PruningService extends AbstractService

Canton-internal pruning service that prunes only canton state, but leaves the ledger-api state unpruned.

Linear Supertypes
AbstractService, AnyRef, Any
Known Subclasses
GrpcPruningService, PruningServiceStub
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PruningService
  2. AbstractService
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def clearSchedule(request: Request): Future[Response]

    Disable automatic pruning and remove the persisted schedule configuration.

  2. abstract def getParticipantSchedule(request: Request): Future[Response]

    Retrieve the automatic, participant-specific pruning configuration.

  3. abstract def getSafePruningOffset(request: GetSafePruningOffsetRequest): Future[GetSafePruningOffsetResponse]

    Retrieve the safe pruning offset

  4. abstract def getSchedule(request: Request): Future[Response]

    Retrieve the automatic pruning configuration.

  5. abstract 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: - INVALID_ARGUMENT: if the payload, particularly the offset is malformed or missing - INTERNAL: 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. - FAILED_PRECONDITION: 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.

  6. abstract def setCron(request: Request): Future[Response]

    Modify individual pruning schedule parameters.

    Modify individual pruning schedule parameters. - INVALID_ARGUMENT: if the payload is malformed or no schedule is configured

  7. abstract def setMaxDuration(request: Request): Future[Response]
  8. abstract def setParticipantSchedule(request: Request): Future[Response]

    Enable automatic pruning with participant-specific schedule parameters.

  9. abstract def setRetention(request: Request): Future[Response]
  10. abstract 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: - INVALID_ARGUMENT: if a parameter is missing or an invalid cron expression or duration.

    Enable automatic pruning using the specified schedule parameters The following errors may occur on the SetSchedule or Update commands: - INVALID_ARGUMENT: if a parameter is missing or an invalid cron expression or duration. - FAILED_PRECONDITION: if automatic background pruning has not been enabled or if invoked on a participant running the Community Edition.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. def serviceCompanion: ServiceCompanion[PruningService]
    Definition Classes
    PruningService → AbstractService
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
    Deprecated

Inherited from AbstractService

Inherited from AnyRef

Inherited from Any

Ungrouped