Packages

c

com.digitalasset.canton.console

ParticipantReference

abstract class ParticipantReference extends InstanceReference with ParticipantAdministration with LedgerApiAdministration with LedgerApiCommandRunner

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ParticipantReference
  2. LedgerApiCommandRunner
  3. LedgerApiAdministration
  4. BaseLedgerApiAdministration
  5. ParticipantAdministration
  6. InstanceReference
  7. CertificateAdministration
  8. PrettyPrinting
  9. PrettyUtil
  10. ShowUtil
  11. ShowSyntax
  12. ToShowOps
  13. FeatureFlagFilter
  14. NoTracing
  15. NamedLogging
  16. Helpful
  17. AdminCommandRunner
  18. AnyRef
  19. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

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

Type Members

  1. type InstanceId = ParticipantId
  2. type Status = ParticipantStatus
  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 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
    AdminCommandRunner
  2. abstract def config: BaseParticipantConfig
  3. abstract def keys: KeyAdministrationGroup
    Definition Classes
    InstanceReference
  4. abstract def ledgerApiCommand[Result](command: GrpcAdminCommand[_, _, Result]): ConsoleCommandResult[Result]
    Attributes
    protected[console]
    Definition Classes
    LedgerApiCommandRunner
  5. abstract def parties: ParticipantPartiesAdministrationGroup
    Definition Classes
    ParticipantReferenceInstanceReference
    Annotations
    @Summary(s = "Inspect and manage parties", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Parties")
  6. abstract def pruning: ParticipantPruningAdministrationGroup
    Annotations
    @Summary(s = "Commands to pruning the archive of the ledger", flag = FeatureFlag.Preview) @Group(name = "Ledger Pruning")
  7. abstract def testing: ParticipantTestingGroup
    Annotations
    @Summary(s = "Commands used for development and testing", flag = FeatureFlag.Testing) @Group(name = "Testing")

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](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
  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
    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.")
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  11. val consoleEnvironment: ConsoleEnvironment
  12. 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
  13. def domainOfTransaction(transactionId: String): DomainId
    Attributes
    protected
    Definition Classes
    LedgerApiAdministrationBaseLedgerApiAdministration
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. def hashCode(): Int
    Definition Classes
    InstanceReference → AnyRef → Any
  18. def health: ParticipantHealthAdministration
    Definition Classes
    ParticipantReferenceInstanceReference
    Annotations
    @Summary(s = "Health and diagnostic related commands", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Health")
  19. 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"))
  20. def help()(implicit consoleEnvironment: ConsoleEnvironment): Unit
    Definition Classes
    Helpful
  21. def id: ParticipantId
    Definition Classes
    ParticipantReferenceParticipantAdministrationInstanceReference
    Annotations
    @Summary(s = "Yields the globally unique id of this participant. " +
    "Throws an exception, if the id has not yet been allocated (e.g., the participant has not yet been started)."
    , flag = console.this.Help.Summary.<init>$default$2)
  22. val instanceType: String
    Attributes
    protected
    Definition Classes
    ParticipantReferenceInstanceReference
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  25. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    ParticipantReferenceNamedLogging
  26. implicit def loggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  27. val name: String
  28. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  30. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  31. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  32. def optionallyAwait[Tx](tx: Tx, txId: String, optTimeout: Option[TimeoutDuration]): Tx
    Attributes
    protected
    Definition Classes
    LedgerApiAdministrationBaseLedgerApiAdministration
  33. 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
  34. def paramIfDefined[T, V](name: String, getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  35. def paramIfNonEmpty[T, V <: IterableOnce[_]](name: String, getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  36. def paramIfTrue[T](label: String, getValue: (T) => Boolean): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  37. 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
  38. 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
  39. 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
  40. 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
  41. 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
  42. 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
  43. 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
  44. 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
  45. implicit final def showInterpolator(sc: StringContext): ShowInterpolator
    Definition Classes
    ShowSyntax
  46. 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
  47. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  48. def timeouts: ConsoleCommandTimeout
    Attributes
    protected
    Definition Classes
    BaseLedgerApiAdministration
  49. implicit def toShow[A](target: A)(implicit tc: Show[A]): Ops[A]
    Definition Classes
    ToShowOps
  50. 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
  51. def topology: TopologyAdministrationGroup
    Definition Classes
    ParticipantReferenceParticipantAdministrationInstanceReference
    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.")
  52. implicit def traceContext: TraceContext
    Attributes
    protected
    Definition Classes
    NoTracing
  53. def tracedLogger: TracedLogger
    Attributes
    protected[console]
    Definition Classes
    InstanceReferenceAdminCommandRunner
  54. 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
  55. def unnamedParamIfDefined[T, V](getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  56. def unnamedParamIfNonEmpty[T, V <: IterableOnce[_]](getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  57. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  58. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  59. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  60. object ledger_api extends Helpful
    Definition Classes
    BaseLedgerApiAdministration
    Annotations
    @Summary(s = "Group of commands that access the ledger-api", flag = FeatureFlag.Testing) @Group(name = "Ledger Api")
  61. object certs
    Definition Classes
    CertificateAdministration
    Annotations
    @Summary(s = "Manage your certificates", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Certificates")
  62. object dars extends Helpful
    Definition Classes
    ParticipantAdministration
    Annotations
    @Summary(s = "Manage DAR packages", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "DAR Management")
  63. object domains extends Helpful
    Definition Classes
    ParticipantAdministration
    Annotations
    @Summary(s = "Manage domain connections", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Domains")
  64. object packages extends Helpful
    Definition Classes
    ParticipantAdministration
    Annotations
    @Summary(s = "Manage raw Daml-LF packages", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Package Management")
  65. object resources extends Helpful
    Definition Classes
    ParticipantAdministration
    Annotations
    @Summary(s = "Functionality for managing resources", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Resource Management")
  66. object transfer extends Helpful
    Definition Classes
    ParticipantAdministration
    Annotations
    @Summary(s = "Composability related functionality", flag = FeatureFlag.Preview) @Group(name = "Transfer")

Deprecated Value Members

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

Inherited from LedgerApiCommandRunner

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