Packages

c

com.digitalasset.canton.console

RemoteSequencerNodeReferenceX

class RemoteSequencerNodeReferenceX extends SequencerNodeReferenceX with RemoteSequencerNodeReferenceCommon

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RemoteSequencerNodeReferenceX
  2. RemoteSequencerNodeReferenceCommon
  3. RemoteInstanceReference
  4. SequencerNodeReferenceX
  5. DomainBootstrapGroup
  6. SequencerNodeAdministrationGroupXWithInit
  7. SequencerAdministrationGroupX
  8. SequencerAdministrationGroupCommon
  9. ConsoleCommandGroup
  10. InstanceReferenceX
  11. SequencerNodeReferenceCommon
  12. InstanceReferenceWithSequencerConnection
  13. InstanceReferenceCommon
  14. PrettyPrinting
  15. PrettyUtil
  16. ShowUtil
  17. ShowSyntax
  18. ToShowOps
  19. FeatureFlagFilter
  20. NamedLogging
  21. Helpful
  22. AdminCommandRunner
  23. AnyRef
  24. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new RemoteSequencerNodeReferenceX(environment: EnterpriseConsoleEnvironment, name: String)

Type Members

  1. type Status = SequencerNodeStatus
  2. implicit class ShowAnyRefSyntax extends AnyRef
    Definition Classes
    ShowUtil
  3. implicit class ShowEitherSyntax[L, R] extends AnyRef

    Enables the syntax show"${myEither.showMerged}".

    Enables the syntax show"${myEither.showMerged}".

    Definition Classes
    ShowUtil
  4. implicit class ShowLengthLimitedStringSyntax extends StringOperators
    Definition Classes
    ShowUtil
  5. implicit class ShowLengthLimitedStringWrapperSyntax extends StringOperators
    Definition Classes
    ShowUtil
  6. implicit class ShowOptionSyntax[T] extends AnyRef
    Definition Classes
    ShowUtil
  7. implicit class ShowProductSyntax extends AnyRef
    Definition Classes
    ShowUtil
    Annotations
    @SuppressWarnings()
  8. implicit class ShowStringSyntax extends StringOperators
    Definition Classes
    ShowUtil
  9. implicit class ShowTraversableSyntax[T] extends AnyRef

    Enables syntax like show"Found several elements: ${myCollection.mkShow()}".

    Enables syntax like show"Found several elements: ${myCollection.mkShow()}".

    Definition Classes
    ShowUtil
  10. abstract class StringOperators extends AnyRef

    Enables syntax like show"This is a string: ${myString.doubleQuoted}" and show"This is a hash: ${myHash.readableHash}".

    Enables syntax like show"This is a string: ${myString.doubleQuoted}" and show"This is a hash: ${myHash.readableHash}".

    Definition Classes
    ShowUtil

Value Members

  1. def adHocPrettyInstance[T <: Product](implicit c: ClassTag[T]): Pretty[T]

    Use this as a temporary solution, to make the code compile during an ongoing migration.

    Use this as a temporary solution, to make the code compile during an ongoing migration. Drawbacks:

    • Instances of Pretty[T] are ignored.
    • No parameter names
    Definition Classes
    PrettyUtil
  2. def clear_cache(): Unit
    Definition Classes
    InstanceReferenceCommon
    Annotations
    @Summary(s = "Clear locally cached variables", flag = FeatureFlag.Testing) @Description(s = "Some commands cache values on the client side. Use this command to explicitly clear the caches of these values.")
  3. def config: RemoteSequencerConfig
    Definition Classes
    RemoteSequencerNodeReferenceCommon
    Annotations
    @Summary(s = "Returns the remote sequencer configuration", flag = console.this.Help.Summary.<init>$default$2)
  4. val consoleEnvironment: EnterpriseConsoleEnvironment
  5. def customParam[T](getValue: (T) => String, cond: (T) => Boolean = (_: T) => true): (T) => Option[Tree]

    Use this if you need a custom representation of a parameter.

    Use this if you need a custom representation of a parameter. Do not use this to create lengthy strings, as line wrapping is not supported.

    Definition Classes
    PrettyUtil
  6. val environment: EnterpriseConsoleEnvironment
  7. def equals(obj: Any): Boolean
    Definition Classes
    SequencerNodeReferenceX → AnyRef → Any
  8. def hashCode(): Int
    Definition Classes
    InstanceReferenceCommon → AnyRef → Any
  9. def health: HealthAdministrationCommon[Status]
    Definition Classes
    SequencerNodeReferenceXInstanceReferenceCommon
    Annotations
    @Summary(s = "Health and diagnostic related commands", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Health")
  10. 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"))
  11. def help()(implicit consoleEnvironment: ConsoleEnvironment): Unit
    Definition Classes
    Helpful
  12. def id: SequencerId
    Definition Classes
    SequencerNodeReferenceCommonInstanceReferenceCommon
    Annotations
    @Summary(s = "Yields the globally unique id of this sequencer. " +
    "Throws an exception, if the id has not yet been allocated (e.g., the sequencer has not yet been started)."
    , flag = console.this.Help.Summary.<init>$default$2)
  13. val keys: EnterpriseKeyAdministrationGroup
    Definition Classes
    RemoteSequencerNodeReferenceCommonRemoteInstanceReferenceInstanceReferenceCommon
    Annotations
    @Summary(s = "Manage public and secret keys", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Keys")
  14. val name: String
  15. def param[T, V](name: String, getValue: (T) => V, cond: (T) => Boolean = (_: T) => true)(implicit arg0: Pretty[V]): (T) => Option[Tree]

    A tree representing both parameter name and value.

    A tree representing both parameter name and value.

    Definition Classes
    PrettyUtil
  16. def paramIfDefined[T, V](name: String, getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  17. def paramIfNonEmpty[T, V <: IterableOnce[_]](name: String, getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  18. def paramIfTrue[T](label: String, getValue: (T) => Boolean): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  19. def paramWithoutValue[T](name: String, cond: (T) => Boolean = (_: T) => true): (T) => Option[Tree]

    A tree representing a parameter name without a parameter value.

    A tree representing a parameter name without a parameter value. Use this for parameters storing confidential or binary data.

    Definition Classes
    PrettyUtil
  20. def pretty: Pretty[InstanceReferenceCommon]

    Indicates how to pretty print this instance.

    Indicates how to pretty print this instance. See PrettyPrintingTest for examples on how to implement this method.

    Definition Classes
    InstanceReferenceCommonPrettyPrinting
  21. def prettyInfix[T, U, V](first: (T) => U, infixOp: String, second: (T) => V)(implicit arg0: Pretty[U], arg1: Pretty[V]): Pretty[T]
    Definition Classes
    PrettyUtil
  22. def prettyNode[T](label: String, children: (T) => Option[Tree]*): Pretty[T]

    A tree consisting of a labelled node with the given children.

    A tree consisting of a labelled node with the given children.

    Definition Classes
    PrettyUtil
  23. def prettyOfClass[T](getParamTrees: (T) => Option[Tree]*): Pretty[T]

    A tree representing the type name and parameter trees.

    A tree representing the type name and parameter trees.

    Definition Classes
    PrettyUtil
  24. def prettyOfObject[T <: Product]: Pretty[T]

    A tree presenting the type name only.

    A tree presenting the type name only. (E.g., for case objects.)

    Definition Classes
    PrettyUtil
  25. def prettyOfParam[T, V](getValue: (T) => V)(implicit arg0: Pretty[V]): Pretty[T]

    Use this to give a class with a singleton parameter the same pretty representation as the parameter.

    Use this to give a class with a singleton parameter the same pretty representation as the parameter.

    Definition Classes
    PrettyUtil
  26. def prettyOfString[T](toString: (T) => String): Pretty[T]

    Creates a pretty instance from a string function.

    Creates a pretty instance from a string function. Do not use this with lengthy strings, as line wrapping is not supported.

    Definition Classes
    PrettyUtil
  27. def sequencerConnection: SequencerConnection
  28. implicit final def showInterpolator(sc: StringContext): ShowInterpolator
    Definition Classes
    ShowSyntax
  29. implicit def showPretty[T](implicit arg0: Pretty[T]): Show[T]

    Enables the syntax show"This object is pretty: $myPrettyType".

    Enables the syntax show"This object is pretty: $myPrettyType".

    Definition Classes
    ShowUtil
  30. implicit def toShow[A](target: A)(implicit tc: Show[A]): Ops[A]
    Definition Classes
    ToShowOps
  31. final def toString(): String

    Yields a readable string representation based on com.digitalasset.canton.logging.pretty.Pretty.DefaultPprinter.

    Yields a readable string representation based on com.digitalasset.canton.logging.pretty.Pretty.DefaultPprinter. Final to avoid accidental overwriting.

    Definition Classes
    PrettyPrinting → AnyRef → Any
  32. def topology: TopologyAdministrationGroupX
  33. def traffic_control: TrafficControlSequencerAdministrationGroup
    Definition Classes
    SequencerNodeReferenceXInstanceReferenceX
    Annotations
    @Summary(s = "Admin traffic control related commands", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Traffic")
  34. def unnamedParam[T, V](getValue: (T) => V, cond: (T) => Boolean = (_: T) => true)(implicit arg0: Pretty[V]): (T) => Option[Tree]

    A tree representing a parameter value without a parameter name.

    A tree representing a parameter value without a parameter name.

    Definition Classes
    PrettyUtil
  35. def unnamedParamIfDefined[T, V](getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  36. def unnamedParamIfNonEmpty[T, V <: IterableOnce[_]](getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  37. object domain
    Definition Classes
    DomainBootstrapGroup
  38. object pruning extends PruningSchedulerAdministration[EnterpriseSequencerAdministrationServiceStub] with Helpful
    Definition Classes
    SequencerAdministrationGroupCommon
    Annotations
    @Summary(s = "Pruning of the sequencer", flag = console.this.Help.Summary.<init>$default$2)
  39. object repair extends Impl with SequencerAdministrationDisableMember
    Definition Classes
    SequencerAdministrationGroupX
    Annotations
    @Summary(s = "Methods used for repairing the node", flag = console.this.Help.Summary.<init>$default$2)
  40. object setup extends Impl with InitNodeId
    Definition Classes
    SequencerNodeAdministrationGroupXWithInit
    Annotations
    @Summary(s = "Methods used for node initialization", flag = console.this.Help.Summary.<init>$default$2)