Packages

c

com.digitalasset.canton.console

EnterpriseRemoteDomainReference

class EnterpriseRemoteDomainReference extends EnterpriseDomainReference with RemoteDomainReference

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EnterpriseRemoteDomainReference
  2. RemoteDomainReference
  3. GrpcRemoteInstanceReference
  4. RemoteInstanceReference
  5. EnterpriseDomainReference
  6. DomainReference
  7. InstanceReferenceWithSequencer
  8. InstanceReferenceWithSequencerConnection
  9. DomainAdministration
  10. InstanceReference
  11. InstanceReferenceCommon
  12. PrettyPrinting
  13. PrettyUtil
  14. ShowUtil
  15. ShowSyntax
  16. ToShowOps
  17. FeatureFlagFilter
  18. NamedLogging
  19. Helpful
  20. AdminCommandRunner
  21. AnyRef
  22. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new EnterpriseRemoteDomainReference(consoleEnvironment: ConsoleEnvironment, name: String)

Type Members

  1. type Status = DomainStatus
  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. 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
    GrpcRemoteInstanceReferenceAdminCommandRunner
  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 config: RemoteDomainConfig
    Definition Classes
    RemoteDomainReferenceGrpcRemoteInstanceReference
    Annotations
    @Summary(s = "Returns the remote domain configuration", flag = console.this.Help.Summary.<init>$default$2)
  12. val consoleEnvironment: ConsoleEnvironment
  13. 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
  14. def defaultDomainConnection: DomainConnectionConfig
    Definition Classes
    DomainReference
    Annotations
    @Summary(s = "Yields a domain connection config with default values except for the domain alias and the sequencer connection. " +
    "May throw an exception if the domain alias or sequencer connection is misconfigured."
    , flag = console.this.Help.Summary.<init>$default$2)
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(obj: Any): Boolean
    Definition Classes
    DomainReference → AnyRef → Any
  17. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  18. def executionContext: ExecutionContext
    Attributes
    protected[canton]
    Definition Classes
    EnterpriseRemoteDomainReferenceInstanceReferenceCommon
  19. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  20. def hashCode(): Int
    Definition Classes
    InstanceReferenceCommon → AnyRef → Any
  21. def health: HealthAdministration[Status]
    Definition Classes
    DomainReferenceDomainAdministrationInstanceReferenceCommon
    Annotations
    @Summary(s = "Health and diagnostic related commands", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Health")
  22. 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"))
  23. def help()(implicit consoleEnvironment: ConsoleEnvironment): Unit
    Definition Classes
    Helpful
  24. def id: DomainId
    Definition Classes
    DomainReferenceDomainAdministrationInstanceReferenceCommon
    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)
  25. 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
  26. val instanceType: String
    Attributes
    protected
    Definition Classes
    DomainReferenceInstanceReferenceCommon
  27. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  28. val keys: KeyAdministrationGroup
    Definition Classes
    RemoteInstanceReferenceInstanceReferenceCommon
    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. def mediator: MediatorAdministrationGroup
    Definition Classes
    DomainReference
    Annotations
    @Summary(s = "Manage the mediator", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Mediator")
  32. val name: String
  33. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  34. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  35. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  36. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  37. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  38. 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
  39. def paramIfDefined[T, V](name: String, getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  40. def paramIfNonEmpty[T, V <: IterableOnce[_]](name: String, getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  41. 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
  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[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
  46. def prettyInfix[T]: PrettyInfixPartiallyApplied[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 sequencer: SequencerAdministrationGroup
    Definition Classes
    DomainReferenceInstanceReferenceWithSequencer
    Annotations
    @Summary(s = "Manage the sequencer", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Sequencer")
  53. def sequencerConnection: SequencerConnection
  54. implicit final def showInterpolator(sc: StringContext): ShowInterpolator
    Definition Classes
    ShowSyntax
  55. 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
  56. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  57. def timeouts: ConsoleCommandTimeout
    Attributes
    protected
    Definition Classes
    DomainAdministration
  58. implicit def toShow[A](target: A)(implicit tc: Show[A]): Ops[A]
    Definition Classes
    ToShowOps
  59. 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
  60. def topology: TopologyAdministrationGroup
    Definition Classes
    DomainReferenceDomainAdministrationInstanceReferenceInstanceReferenceCommon
    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.")
  61. def tracedLogger: TracedLogger
    Attributes
    protected[console]
    Definition Classes
    InstanceReferenceCommonAdminCommandRunner
  62. 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
  63. def unnamedParamIfDefined[T, V](getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  64. def unnamedParamIfNonEmpty[T, V <: IterableOnce[_]](getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  65. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  66. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  67. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  68. object participants extends Helpful
    Definition Classes
    DomainAdministration
    Annotations
    @Summary(s = "Manage participant permissions", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Participants")
  69. 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
    Deprecated

Inherited from RemoteDomainReference

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 NamedLogging

Inherited from Helpful

Inherited from AdminCommandRunner

Inherited from AnyRef

Inherited from Any

Ungrouped