Packages

t

com.digitalasset.canton.console

LocalDomainReference

trait LocalDomainReference extends DomainReference with BaseInspection[Domain] with LocalInstanceReference

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LocalDomainReference
  2. LocalInstanceReference
  3. BaseInspection
  4. DomainReference
  5. InstanceReferenceWithSequencerConnection
  6. DomainAdministration
  7. InstanceReference
  8. CertificateAdministration
  9. PrettyPrinting
  10. PrettyUtil
  11. ShowUtil
  12. ShowSyntax
  13. ToShowOps
  14. FeatureFlagFilter
  15. NoTracing
  16. NamedLogging
  17. Helpful
  18. AdminCommandRunner
  19. AnyRef
  20. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. type InstanceId = DomainId
    Definition Classes
    DomainReferenceInstanceReference
  2. type Status = DomainStatus
    Definition Classes
    DomainReferenceInstanceReference
  3. implicit class ShowAnyRefSyntax extends AnyRef
    Definition Classes
    ShowUtil
  4. implicit class ShowEitherSyntax[L, R] extends AnyRef

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

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

    Definition Classes
    ShowUtil
  5. implicit class ShowLengthLimitedStringSyntax extends StringOperators
    Definition Classes
    ShowUtil
  6. implicit class ShowLengthLimitedStringWrapperSyntax extends StringOperators
    Definition Classes
    ShowUtil
  7. implicit class ShowOptionSyntax[T] extends AnyRef
    Definition Classes
    ShowUtil
  8. implicit class ShowProductSyntax extends AnyRef
    Definition Classes
    ShowUtil
    Annotations
    @SuppressWarnings()
  9. implicit class ShowStringSyntax extends StringOperators
    Definition Classes
    ShowUtil
  10. 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
  11. 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

Abstract Value Members

  1. abstract val consoleEnvironment: ConsoleEnvironment
  2. abstract val name: String

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. def access[T](ops: (Domain) => T): T
    Attributes
    protected[console]
    Definition Classes
    BaseInspection
  5. 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
  6. def adminCommand[Result](grpcCommand: GrpcAdminCommand[_, _, Result], httpCommand: HttpAdminCommand[_, _, Result]): ConsoleCommandResult[Result]

    Run an admin command and return its result.

    Run an admin command and return its result. Depending on the admin client config details, it will either run the GRPC or the HTTP admin command.

    Attributes
    protected[console]
    Definition Classes
    LocalInstanceReferenceAdminCommandRunner
  7. def adminCommand[Result](command: GrpcAdminCommand[_, _, Result]): ConsoleCommandResult[Result]

    Run a GRPC admin command and return its result.

    Run a GRPC admin command and return its result. Most of the commands are only defined for the GRPC interface, so we default to showing an error message if the command is called for a node configured with an HTTP interface.

    Attributes
    protected[console]
    Definition Classes
    AdminCommandRunner
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def cantonConfig: CantonConfig
    Attributes
    protected
    Definition Classes
    FeatureFlagFilter
  10. def check[T](flag: FeatureFlag)(command: => T): T
    Attributes
    protected
    Definition Classes
    FeatureFlagFilter
  11. def clear_cache(): Unit
    Definition Classes
    InstanceReference
    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.")
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  13. def config: environment.Environment.Config.DomainConfigType
    Definition Classes
    LocalDomainReferenceLocalInstanceReference
    Annotations
    @Summary(s = "Returns the domain configuration", flag = console.this.Help.Summary.<init>$default$2)
  14. def crypto: Crypto
    Attributes
    protected[canton]
    Definition Classes
    BaseInspection
  15. 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
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(obj: Any): Boolean
    Definition Classes
    DomainReference → AnyRef → Any
  18. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. def hashCode(): Int
    Definition Classes
    InstanceReference → AnyRef → Any
  20. def health: HealthAdministration[DomainStatus]
    Definition Classes
    DomainReferenceInstanceReference
    Annotations
    @Summary(s = "Health and diagnostic related commands", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Health")
  21. 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"))
  22. def help()(implicit consoleEnvironment: ConsoleEnvironment): Unit
    Definition Classes
    Helpful
  23. def id: DomainId
    Definition Classes
    DomainReferenceDomainAdministrationInstanceReference
    Annotations
    @Summary(s = "Yields the globally unique id of this domain. " +
    "Throws an exception, if the id has not yet been allocated (e.g., the domain has not yet been started)."
    , flag = console.this.Help.Summary.<init>$default$2)
  24. val instanceType: String
    Attributes
    protected
    Definition Classes
    DomainReferenceInstanceReference
  25. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  26. def is_initialized: Boolean
    Definition Classes
    LocalInstanceReference
    Annotations
    @Summary(s = "Check if the local instance is running and is fully initialized", flag = console.this.Help.Summary.<init>$default$2)
  27. def is_running: Boolean
    Definition Classes
    LocalInstanceReference
    Annotations
    @Summary(s = "Check if the local instance is running", flag = console.this.Help.Summary.<init>$default$2)
  28. def keys: LocalKeyAdministrationGroup
    Definition Classes
    LocalInstanceReferenceInstanceReference
    Annotations
    @Summary(s = "Manage public and secret keys", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Keys")
  29. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  30. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    DomainReferenceNamedLogging
  31. implicit def loggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  32. def mediator: MediatorAdministrationGroup
    Definition Classes
    DomainReference
    Annotations
    @Summary(s = "Manage the mediator", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Mediator")
  33. def migrateInstanceDb(): Either[StartupError, _]
    Attributes
    protected
    Definition Classes
    LocalInstanceReference
  34. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  35. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  36. val nodes: DomainNodes[environment.Environment.Config.DomainConfigType]
    Attributes
    protected
    Definition Classes
    LocalDomainReferenceLocalInstanceReference
  37. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  38. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  39. 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
  40. def paramIfDefined[T, V](name: String, getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  41. def paramIfNonEmpty[T, V <: IterableOnce[_]](name: String, getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  42. def paramIfTrue[T](label: String, getValue: (T) => Boolean): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  43. 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
  44. def parties: PartiesAdministrationGroup
    Definition Classes
    DomainReferenceInstanceReference
    Annotations
    @Summary(s = "Inspect configured parties", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Parties")
  45. def pretty: Pretty[InstanceReference]

    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
    InstanceReferencePrettyPrinting
  46. 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
  47. 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
  48. 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
  49. 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
  50. 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
  51. 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
  52. def repairMigrationOfInstance(force: Boolean): Either[StartupError, Unit]
    Attributes
    protected
    Definition Classes
    LocalInstanceReference
  53. def runCommandIfRunning[Result](runner: => ConsoleCommandResult[Result]): ConsoleCommandResult[Result]
    Attributes
    protected
    Definition Classes
    LocalInstanceReference
  54. def runningNode: Option[DomainNodeBootstrap]
    Attributes
    protected[console]
    Definition Classes
    LocalDomainReferenceBaseInspection
  55. def sequencer: SequencerAdministrationGroup
    Definition Classes
    DomainReferenceInstanceReferenceWithSequencerConnection
    Annotations
    @Summary(s = "Manage the sequencer", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Sequencer")
  56. def sequencerConnection: SequencerConnection
  57. implicit final def showInterpolator(sc: StringContext): ShowInterpolator
    Definition Classes
    ShowSyntax
  58. 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
  59. def start(): Unit
    Definition Classes
    LocalInstanceReference
    Annotations
    @Summary(s = "Start the instance", flag = console.this.Help.Summary.<init>$default$2)
  60. def startInstance(): Either[StartupError, Unit]
    Attributes
    protected
    Definition Classes
    LocalInstanceReference
  61. def stop(): Unit
    Definition Classes
    LocalInstanceReference
    Annotations
    @Summary(s = "Stop the instance", flag = console.this.Help.Summary.<init>$default$2)
  62. def stopInstance(): Either[ShutdownError, Unit]
    Attributes
    protected
    Definition Classes
    LocalInstanceReference
  63. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  64. def timeouts: ConsoleCommandTimeout
    Attributes
    protected
    Definition Classes
    DomainAdministration
  65. implicit def toShow[A](target: A)(implicit tc: Show[A]): Ops[A]
    Definition Classes
    ToShowOps
  66. 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
  67. def topology: TopologyAdministrationGroup
    Definition Classes
    DomainReferenceDomainAdministrationInstanceReference
    Annotations
    @Summary(s = "Topology management related commands", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Topology") @Description(s = "This group contains access to the full set of topology management commands.")
  68. implicit def traceContext: TraceContext
    Attributes
    protected
    Definition Classes
    NoTracing
  69. def tracedLogger: TracedLogger
    Attributes
    protected[console]
    Definition Classes
    InstanceReferenceAdminCommandRunner
  70. def underlying: Option[Domain]
    Definition Classes
    BaseInspection
  71. 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
  72. def unnamedParamIfDefined[T, V](getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  73. def unnamedParamIfNonEmpty[T, V <: IterableOnce[_]](getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  74. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  75. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  76. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  77. object db extends Helpful
    Definition Classes
    LocalInstanceReference
    Annotations
    @Summary(s = "Database related operations", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Database")
  78. object certs
    Definition Classes
    CertificateAdministration
    Annotations
    @Summary(s = "Manage your certificates", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Certificates")
  79. object participants extends Helpful
    Definition Classes
    DomainAdministration
    Annotations
    @Summary(s = "Manage participant permissions", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Participants")
  80. object service extends Helpful
    Definition Classes
    DomainAdministration
    Annotations
    @Summary(s = "Domain service commands", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Service")

Deprecated Value Members

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

Inherited from LocalInstanceReference

Inherited from BaseInspection[Domain]

Inherited from DomainReference

Inherited from DomainAdministration

Inherited from InstanceReference

Inherited from PrettyPrinting

Inherited from PrettyUtil

Inherited from ShowUtil

Inherited from ShowSyntax

Inherited from ToShowOps

Inherited from FeatureFlagFilter

Inherited from NoTracing

Inherited from NamedLogging

Inherited from Helpful

Inherited from AdminCommandRunner

Inherited from AnyRef

Inherited from Any

Ungrouped