class MediatorAdministrationGroup extends MediatorPruningAdministrationGroup
Linear Supertypes
Known Subclasses
Ordering
- Alphabetic
- By Inheritance
Inherited
- MediatorAdministrationGroup
- MediatorPruningAdministrationGroup
- PruningSchedulerAdministration
- Helpful
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- Protected
Instance Constructors
- new MediatorAdministrationGroup(runner: AdminCommandRunner, consoleEnvironment: ConsoleEnvironment, loggerFactory: NamedLoggerFactory)
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 clear_schedule(): Unit
- Definition Classes
- PruningSchedulerAdministration
- Annotations
- @Summary(s = "Deactivate automatic pruning.", flag = console.this.Help.Summary.<init>$default$2)
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- val consoleEnvironment: ConsoleEnvironment
- Attributes
- protected
- Definition Classes
- PruningSchedulerAdministration
- 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
- @native() @HotSpotIntrinsicCandidate()
- 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.
""")
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- 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"))
- def help()(implicit consoleEnvironment: ConsoleEnvironment): Unit
- Definition Classes
- Helpful
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def locate_pruning_timestamp(index: PositiveInt = PositiveInt.tryCreate(1)): Option[CantonTimestamp]
- Definition Classes
- MediatorPruningAdministrationGroup
- 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.""")
- val loggerFactory: NamedLoggerFactory
- Attributes
- protected
- Definition Classes
- PruningSchedulerAdministration
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def prune(): Unit
- Definition Classes
- MediatorPruningAdministrationGroup
- 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`.""")
- def prune_at(timestamp: CantonTimestamp): Unit
- Definition Classes
- MediatorPruningAdministrationGroup
- Annotations
- @Summary(s = "Prune the mediator of unnecessary data up to and including the given timestamp", flag = console.this.Help.Summary.<init>$default$2)
- def prune_with_retention_period(retentionPeriod: FiniteDuration): Unit
- Definition Classes
- MediatorPruningAdministrationGroup
- 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)
- 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.
""")
- 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.
""")
- 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.
""")
- 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.
""")
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def testing: MediatorTestingGroup
- 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])