Packages

object service extends Helpful

Annotations
@Summary(s = "Domain service commands", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Service")
Linear Supertypes
Helpful, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. service
  2. Helpful
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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 get_dynamic_domain_parameters: DynamicDomainParameters
    Annotations
    @Summary(s = "Get the Dynamic Domain Parameters configured for the domain", flag = console.this.Help.Summary.<init>$default$2)
  10. def get_max_rate_per_participant: NonNegativeInt
    Annotations
    @Summary(s = "Get the max rate per participant", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Depending on the protocol version used on the domain, the value will be
    |read either from the static domain parameters or the dynamic ones."""    )
  11. def get_max_request_size: NonNegativeInt
    Annotations
    @Summary(s = "Get the max request size", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Depending on the protocol version used on the domain, the value will be
    |read either from the static domain parameters or the dynamic ones.
    |This value is not necessarily the one used by the sequencer node because it requires a restart
    |of the server to be taken into account."""    )
  12. def get_mediator_deduplication_timeout: NonNegativeFiniteDuration
    Annotations
    @Summary(s = "Get the mediator deduplication timeout", flag = console.this.Help.Summary.<init>$default$2) @Description(s = "The method will fail, if the domain does not support the mediatorDeduplicationTimeout.") @AvailableFrom(protocolVersion = ProtocolVersion.v4)
  13. def get_reconciliation_interval: PositiveDurationSeconds
    Annotations
    @Summary(s = "Get the reconciliation interval configured for the domain", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Depending on the protocol version used on the domain, the value will be
    |read either from the static domain parameters or the dynamic ones."""    )
  14. def get_static_domain_parameters: StaticDomainParameters
    Annotations
    @Summary(s = "Get the Static Domain Parameters configured for the domain", flag = console.this.Help.Summary.<init>$default$2)
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  16. 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"))
  17. def help()(implicit consoleEnvironment: ConsoleEnvironment): Unit
    Definition Classes
    Helpful
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. def list_accepted_agreements(): Seq[ServiceAgreementAcceptance]
    Annotations
    @Summary(s = "List the accepted service agreements", flag = console.this.Help.Summary.<init>$default$2)
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  23. def set_commitments_catch_up_config(config: CatchUpConfig): Unit
    Annotations
    @Summary(s = "Update the ACS commitments catch up config for the domain", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """The method will fail if the domain does not support the ``catchUpConfig`` parameter
    |(i.e., if the domain is running on protocol version lower than `6`)"""    )     @AvailableFrom(protocolVersion = ProtocolVersion.v6)
  24. def set_dynamic_domain_parameters(dynamicDomainParameters: DynamicDomainParameters, force: Boolean = false): Unit
    Annotations
    @Summary(s = "Set the Dynamic Domain Parameters configured for the domain", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """force: Enable potentially dangerous changes. Required to increase ``ledgerTimeRecordTimeTolerance``.
    |Use ``set_ledger_time_record_time_tolerance`` to securely increase ``ledgerTimeRecordTimeTolerance``."""    )
  25. def set_ledger_time_record_time_tolerance(newLedgerTimeRecordTimeTolerance: NonNegativeFiniteDuration, force: Boolean = false): Unit
    Annotations
    @Summary(s = "Update the `ledgerTimeRecordTimeTolerance` in the dynamic domain parameters.", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """If it would be insecure to perform the change immediately,
    |the command will block and wait until it is secure to perform the change.
    |The command will block for at most twice of ``newLedgerTimeRecordTimeTolerance``.
    |
    |If the domain does not support ``mediatorDeduplicationTimeout``,
    |the method will update ``ledgerTimeRecordTimeTolerance`` immediately without blocking.
    |
    |The method will fail if ``mediatorDeduplicationTimeout`` is less than twice of ``newLedgerTimeRecordTimeTolerance``.
    |
    |Do not modify domain parameters concurrently while running this command,
    |because the command may override concurrent changes.
    |
    |force: update ``ledgerTimeRecordTimeTolerance`` immediately without blocking.
    |This is safe to do during domain bootstrapping and in test environments, but should not be done in operational production systems.."""    )
  26. def set_max_rate_per_participant(maxRatePerParticipant: NonNegativeInt): Unit
    Annotations
    @Summary(s = "Try to update the max rate per participant for the domain", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """If the max rate per participant is dynamic, update the value.
    |If the max rate per participant is not dynamic (i.e., if the domain is running
    |on protocol version lower than `4`), then it will throw an error.
    """    )     @AvailableFrom(protocolVersion = ProtocolVersion.v4)
  27. def set_max_request_size(maxRequestSize: NonNegativeInt, force: Boolean = false): Unit
    Annotations
    @Summary(s = "Try to update the max request size for the domain", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """If the max request size is dynamic, update the value.
    |The update won't have any effect unless the sequencer server is restarted.
    |If the max request size is not dynamic (i.e., if the domain is running
    |on protocol version lower than `4`), then it will throw an error.
    """    )     @AvailableFrom(protocolVersion = ProtocolVersion.v4)
  28. def set_mediator_deduplication_timeout(newMediatorDeduplicationTimeout: NonNegativeFiniteDuration): Unit
    Annotations
    @Summary(s = "Update the mediator deduplication timeout", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """The method will fail:
    |
    |- if the domain does not support the ``mediatorDeduplicationTimeout`` parameter,
    |- if the new value of ``mediatorDeduplicationTimeout`` is less than twice the value of ``ledgerTimeRecordTimeTolerance.``"""    )     @AvailableFrom(protocolVersion = ProtocolVersion.v4)
  29. def set_reconciliation_interval(newReconciliationInterval: PositiveDurationSeconds): Unit
    Annotations
    @Summary(s = "Try to update the reconciliation interval for the domain", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """If the reconciliation interval is dynamic, update the value.
    |If the reconciliation interval is not dynamic (i.e., if the domain is running
    |on protocol version lower than `4`), then it will throw an error.
    """    )     @AvailableFrom(protocolVersion = ProtocolVersion.v4)
  30. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  31. def toString(): String
    Definition Classes
    AnyRef → Any
  32. def update_dynamic_domain_parameters(modifier: (DynamicDomainParameters) => DynamicDomainParameters, force: Boolean = false): Unit
    Annotations
    @Summary(s = "Update the Dynamic Domain Parameters for the domain", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """force: Enable potentially dangerous changes. Required to increase ``ledgerTimeRecordTimeTolerance``.
    |Use ``set_ledger_time_record_time_tolerance_securely`` to securely increase ``ledgerTimeRecordTimeTolerance``."""    )
  33. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  34. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  35. 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
  2. def set_max_inbound_message_size(maxRequestSize: NonNegativeInt, force: Boolean = false): Unit
    Annotations
    @Summary(s = "Try to update the max request size for the domain", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """If the max request size is dynamic, update the value.
    |The update won't have any effect unless the sequencer server is restarted.
    |If the max request size is not dynamic (i.e., if the domain is running
    |on protocol version lower than `4`), then it will throw an error.
    """    )     @AvailableFrom(protocolVersion = ProtocolVersion.v4) @deprecated
    Deprecated

    (Since version 2.5.0) Use set_max_request_size instead

  3. def update_dynamic_parameters(modifier: (DynamicDomainParameters) => DynamicDomainParameters, force: Boolean = false): Unit
    Annotations
    @Summary(s = "Update the Dynamic Domain Parameters for the domain", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """force: Enable potentially dangerous changes. Required to increase ``ledgerTimeRecordTimeTolerance``.
    |Use ``set_ledger_time_record_time_tolerance_securely`` to securely increase ``ledgerTimeRecordTimeTolerance``."""    )     @deprecated
    Deprecated

    (Since version 2.5.0) Use set_max_request_size instead

Inherited from Helpful

Inherited from AnyRef

Inherited from Any

Ungrouped