Packages

t

com.digitalasset.canton.console

LocalInstanceReference

trait LocalInstanceReference extends LocalInstanceReferenceCommon with InstanceReference

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LocalInstanceReference
  2. InstanceReference
  3. LocalInstanceReferenceCommon
  4. NoTracing
  5. InstanceReferenceCommon
  6. PrettyPrinting
  7. PrettyUtil
  8. ShowUtil
  9. ShowSyntax
  10. ToShowOps
  11. FeatureFlagFilter
  12. NamedLogging
  13. Helpful
  14. AdminCommandRunner
  15. AnyRef
  16. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. abstract type Status <: health.admin.data.NodeStatus.Status
    Definition Classes
    InstanceReferenceCommon
  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

Abstract Value Members

  1. abstract def config: LocalNodeConfig
    Definition Classes
    LocalInstanceReferenceCommon
    Annotations
    @Summary(s = "Config of node instance", flag = console.this.Help.Summary.<init>$default$2)
  2. abstract val consoleEnvironment: ConsoleEnvironment
  3. abstract def crypto: Crypto
    Attributes
    protected[canton]
    Definition Classes
    LocalInstanceReferenceCommon
  4. abstract def executionContext: ExecutionContext
    Attributes
    protected[canton]
    Definition Classes
    InstanceReferenceCommon
  5. abstract def health: HealthAdministrationCommon[Status]
    Definition Classes
    InstanceReferenceCommon
  6. abstract def id: NodeIdentity
    Definition Classes
    InstanceReferenceCommon
  7. abstract val instanceType: String
    Attributes
    protected
    Definition Classes
    InstanceReferenceCommon
  8. abstract def loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    NamedLogging
  9. abstract val name: String
  10. abstract def parties: PartiesAdministrationGroup
    Definition Classes
    InstanceReference
  11. abstract def topology: TopologyAdministrationGroup

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 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
  5. def adminCommand[Result](grpcCommand: 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
    LocalInstanceReferenceCommonAdminCommandRunner
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def cantonConfig: CantonConfig
    Attributes
    protected
    Definition Classes
    FeatureFlagFilter
  8. def check[T](flag: FeatureFlag)(command: => T): T
    Attributes
    protected
    Definition Classes
    FeatureFlagFilter
  9. 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.")
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  11. 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
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  16. def hashCode(): Int
    Definition Classes
    InstanceReferenceCommon → AnyRef → Any
  17. 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"))
  18. def help()(implicit consoleEnvironment: ConsoleEnvironment): Unit
    Definition Classes
    Helpful
  19. def indicateOmittedFields[T]: (T) => Option[Tree]

    Use this to indicate that you've omitted fields from pretty printing

    Use this to indicate that you've omitted fields from pretty printing

    Definition Classes
    PrettyUtil
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. def is_initialized: Boolean
    Definition Classes
    LocalInstanceReferenceCommon
    Annotations
    @Summary(s = "Check if the local instance is running and is fully initialized", flag = console.this.Help.Summary.<init>$default$2)
  22. def is_running: Boolean
    Definition Classes
    LocalInstanceReferenceCommon
    Annotations
    @Summary(s = "Check if the local instance is running", flag = console.this.Help.Summary.<init>$default$2)
  23. def keys: LocalKeyAdministrationGroup
    Definition Classes
    LocalInstanceReferenceCommonInstanceReferenceCommon
    Annotations
    @Summary(s = "Manage public and secret keys", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Keys")
  24. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  25. def migrateInstanceDb(): Either[StartupError, _]
    Attributes
    protected
    Definition Classes
    LocalInstanceReferenceCommon
  26. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  27. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  29. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  31. 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
  32. def paramIfDefined[T, V](name: String, getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  33. def paramIfNonEmpty[T, V <: IterableOnce[_]](name: String, getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  34. def paramIfNotDefault[T, V](name: String, getValue: (T) => V, default: V)(implicit arg0: Pretty[V]): (T) => Option[Tree]

    A tree only written if not matching the default value

    A tree only written if not matching the default value

    Definition Classes
    PrettyUtil
  35. def paramIfTrue[T](label: String, getValue: (T) => Boolean): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  36. 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
  37. 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
  38. def prettyInfix[T]: PrettyInfixPartiallyApplied[T]
    Definition Classes
    PrettyUtil
  39. 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
  40. 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
  41. 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
  42. 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
  43. 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
  44. def repairMigrationOfInstance(force: Boolean): Either[StartupError, Unit]
    Attributes
    protected
    Definition Classes
    LocalInstanceReferenceCommon
  45. def runCommandIfRunning[Result](runner: => ConsoleCommandResult[Result]): ConsoleCommandResult[Result]
    Attributes
    protected
    Definition Classes
    LocalInstanceReferenceCommon
  46. implicit final def showInterpolator(sc: StringContext): ShowInterpolator
    Definition Classes
    ShowSyntax
  47. 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
  48. def start(): Unit
    Definition Classes
    LocalInstanceReferenceCommon
    Annotations
    @Summary(s = "Start the instance", flag = console.this.Help.Summary.<init>$default$2)
  49. def startInstance(): Either[StartupError, Unit]
    Attributes
    protected
    Definition Classes
    LocalInstanceReferenceCommon
  50. def stop(): Unit
    Definition Classes
    LocalInstanceReferenceCommon
    Annotations
    @Summary(s = "Stop the instance", flag = console.this.Help.Summary.<init>$default$2)
  51. def stopInstance(): Either[ShutdownError, Unit]
    Attributes
    protected
    Definition Classes
    LocalInstanceReferenceCommon
  52. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  53. implicit def toShow[A](target: A)(implicit tc: Show[A]): Ops[A]
    Definition Classes
    ToShowOps
  54. 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
  55. implicit def traceContext: TraceContext
    Attributes
    protected
    Definition Classes
    NoTracing
  56. def tracedLogger: TracedLogger
    Attributes
    protected[console]
    Definition Classes
    InstanceReferenceCommonAdminCommandRunner
  57. 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
  58. def unnamedParamIfDefined[T, V](getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  59. def unnamedParamIfNonEmpty[T, V <: IterableOnce[_]](getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  60. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  61. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  62. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  63. object db extends Helpful
    Definition Classes
    LocalInstanceReferenceCommon
    Annotations
    @Summary(s = "Database related operations", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Database")

Deprecated Value Members

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

Inherited from InstanceReference

Inherited from NoTracing

Inherited from PrettyPrinting

Inherited from PrettyUtil

Inherited from ShowUtil

Inherited from ShowSyntax

Inherited from ToShowOps

Inherited from FeatureFlagFilter

Inherited from NamedLogging

Inherited from Helpful

Inherited from AdminCommandRunner

Inherited from AnyRef

Inherited from Any

Ungrouped