Packages

c

com.digitalasset.canton.console.commands

MediatorPruningAdministrationGroup

class MediatorPruningAdministrationGroup extends PruningSchedulerAdministration[EnterpriseMediatorAdministrationServiceStub] with Helpful

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MediatorPruningAdministrationGroup
  2. PruningSchedulerAdministration
  3. Helpful
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new MediatorPruningAdministrationGroup(runner: AdminCommandRunner, consoleEnvironment: ConsoleEnvironment, loggerFactory: NamedLoggerFactory)

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 clear_schedule(): Unit
    Definition Classes
    PruningSchedulerAdministration
    Annotations
    @Summary(s = "Deactivate automatic pruning.", flag = console.this.Help.Summary.<init>$default$2)
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  7. val consoleEnvironment: ConsoleEnvironment
    Attributes
    protected
    Definition Classes
    PruningSchedulerAdministration
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  11. def get_schedule(): Option[PruningSchedule]
    Definition Classes
    PruningSchedulerAdministration
    Annotations
    @Summary(s = "Inspect the automatic pruning schedule.", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """The schedule consists of a "cron" expression and "max_duration" and "retention" durations. The cron string
    |indicates the points in time at which pruning should begin in the GMT time zone, and the maximum duration
    |indicates how long from the start time pruning is allowed to run as long as pruning has not finished pruning
    |up to the specified retention period.
    |Returns `None` if no schedule has been configured via `set_schedule` or if `clear_schedule` has been invoked.
    """
    )
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  13. def help(methodName: String)(implicit consoleEnvironment: ConsoleEnvironment): Unit
    Definition Classes
    Helpful
    Annotations
    @Summary(s = "Help for specific commands (use help() or help(\"method\") for more information)", flag = console.this.Help.Summary.<init>$default$2) @Topic(t = Seq("Top-level Commands"))
  14. def help()(implicit consoleEnvironment: ConsoleEnvironment): Unit
    Definition Classes
    Helpful
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. def locate_pruning_timestamp(index: PositiveInt = PositiveInt.tryCreate(1)): Option[CantonTimestamp]
    Annotations
    @Summary(s = "Obtain a timestamp at or near the beginning of mediator state", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """This command provides insight into the current state of mediator pruning when called with
    |the default value of `index` 1.
    |When pruning the mediator manually via `prune_at` and with the intent to prune in batches, specify
    |a value such as 1000 to obtain a pruning timestamp that corresponds to the "end" of the batch."""
    )
  17. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    PruningSchedulerAdministration
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  21. def prune(): Unit
    Annotations
    @Summary(s = "Prune the mediator of unnecessary data while keeping data for the default retention period", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Removes unnecessary data from the Mediator that is earlier than the default retention period.
    |The default retention period is set in the configuration of the canton node running this
    |command under `parameters.retention-period-defaults.mediator`."""
    )
  22. def prune_at(timestamp: CantonTimestamp): Unit
    Annotations
    @Summary(s = "Prune the mediator of unnecessary data up to and including the given timestamp", flag = console.this.Help.Summary.<init>$default$2)
  23. def prune_with_retention_period(retentionPeriod: FiniteDuration): Unit
    Annotations
    @Summary(s = "Prune the mediator of unnecessary data while keeping data for the provided retention period", flag = console.this.Help.Summary.<init>$default$2)
  24. def set_cron(cron: String): Unit
    Definition Classes
    PruningSchedulerAdministration
    Annotations
    @Summary(s = "Modify the cron used by automatic pruning.", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """The schedule is specified in cron format and refers to pruning start times in the GMT time zone.
    |This call returns an error if no schedule has been configured via `set_schedule` or if automatic
    |pruning has been disabled via `clear_schedule`. Additionally if at the time of this modification, pruning is
    |actively running, a best effort is made to pause pruning and restart according to the new schedule. This
    |allows for the case that the new schedule no longer allows pruning at the current time.
    """
    )
  25. def set_max_duration(maxDuration: PositiveDurationSeconds): Unit
    Definition Classes
    PruningSchedulerAdministration
    Annotations
    @Summary(s = "Modify the maximum duration used by automatic pruning.", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """The `maxDuration` is specified as a positive duration and has at most per-second granularity.
    |This call returns an error if no schedule has been configured via `set_schedule` or if automatic
    |pruning has been disabled via `clear_schedule`. Additionally if at the time of this modification, pruning is
    |actively running, a best effort is made to pause pruning and restart according to the new schedule. This
    |allows for the case that the new schedule no longer allows pruning at the current time.
    """
    )
  26. def set_retention(retention: PositiveDurationSeconds): Unit
    Definition Classes
    PruningSchedulerAdministration
    Annotations
    @Summary(s = "Update the pruning retention used by automatic pruning.", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """The `retention` is specified as a positive duration and has at most per-second granularity.
    |This call returns an error if no schedule has been configured via `set_schedule` or if automatic
    |pruning has been disabled via `clear_schedule`. Additionally if at the time of this update, pruning is
    |actively running, a best effort is made to pause pruning and restart with the newly specified retention.
    |This allows for the case that the new retention mandates retaining more data than previously.
    """
    )
  27. def set_schedule(cron: String, maxDuration: PositiveDurationSeconds, retention: PositiveDurationSeconds): Unit
    Definition Classes
    PruningSchedulerAdministration
    Annotations
    @Summary(s = "Activate automatic pruning according to the specified schedule.", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """The schedule is specified in cron format and "max_duration" and "retention" durations. The cron string indicates
    |the points in time at which pruning should begin in the GMT time zone, and the maximum duration indicates how
    |long from the start time pruning is allowed to run as long as pruning has not finished pruning up to the
    |specified retention period.
    """
    )
  28. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  29. def toString(): String
    Definition Classes
    AnyRef → Any
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  32. 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 Helpful

Inherited from AnyRef

Inherited from Any

Ungrouped