Packages

c

com.digitalasset.canton.console

ParticipantReference

abstract class ParticipantReference extends InstanceReference with ParticipantAdministration with BaseLedgerApiClient with LedgerApiAdministration with LedgerApiCommandRunner

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ParticipantReference
  2. LedgerApiCommandRunner
  3. LedgerApiAdministration
  4. BaseLedgerApiAdministration
  5. BaseLedgerApiClient
  6. ParticipantAdministration
  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

Instance Constructors

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

Type Members

  1. implicit class ShowAnyRefSyntax extends AnyRef
    Definition Classes
    ShowUtil
  2. implicit class ShowEitherSyntax[L, R] extends AnyRef

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

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

    Definition Classes
    ShowUtil
  3. implicit class ShowOptionSyntax[T] extends AnyRef
    Definition Classes
    ShowUtil
  4. implicit class ShowProductSyntax extends AnyRef
    Definition Classes
    ShowUtil
    Annotations
    @SuppressWarnings()
  5. implicit class ShowStringSyntax 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
  6. 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

Abstract Value Members

  1. abstract def adminCommand[Svc <: AbstractStub[Svc], Result](command: AdminCommand[Svc, _, _, Result]): ConsoleCommandResult[Result]

    Run an admin command and return its result.

    Run an admin command and return its result.

    Attributes
    protected[console]
    Definition Classes
    AdminCommandRunner
  2. abstract def config: BaseParticipantConfig
  3. abstract def keys: KeyAdministrationGroup
    Definition Classes
    InstanceReference
  4. abstract def ledgerApiCommand[Svc <: AbstractStub[Svc], Result](command: AdminCommand[Svc, _, _, 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[Svc <: AbstractStub[Svc], Result](commandGenerator: (CryptoPureApi) => AdminCommand[Svc, _, _, Result]): ConsoleCommandResult[Result]

    Generate a command for a potentially running instance then run it and return its result.

    Generate a command for a potentially running instance then run it and return its result.

    Attributes
    protected[console]
    Definition Classes
    InstanceReferenceAdminCommandRunner
  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 clearLedgerId(): Unit
    Attributes
    protected
    Definition Classes
    BaseLedgerApiClient
  10. def clear_cache(): Unit
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  12. val consoleEnvironment: ConsoleEnvironment
  13. val cryptoPureApi: CryptoPureApi
    Attributes
    protected
    Definition Classes
    InstanceReference
  14. 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
  15. def domainOfTransaction(transactionId: String): DomainId
    Attributes
    protected
    Definition Classes
    LedgerApiAdministrationBaseLedgerApiAdministration
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: AnyRef): Boolean
    Definition Classes
    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: ParticipantHealthAdministration
    Definition Classes
    ParticipantReferenceInstanceReference
    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: ParticipantId
    Definition Classes
    ParticipantReferenceParticipantAdministration
    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)
  24. def identity: IdentityAdministrationGroup
    Definition Classes
    ParticipantReferenceParticipantAdministrationInstanceReference
    Annotations
    @Summary(s = "Identity management related commands", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Identity") @Description(s = "This group contains access to the full set of identity management commands.")
  25. val instanceType: String
    Attributes
    protected
    Definition Classes
    ParticipantReferenceInstanceReference
  26. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  27. def ledgerApiCommand[Svc <: AbstractStub[Svc], Result](command: (LedgerId) => AdminCommand[Svc, _, _, Result]): ConsoleCommandResult[Result]
    Attributes
    protected[console]
    Definition Classes
    BaseLedgerApiClient
  28. def ledgerId(): Either[CommandError, LedgerId]
    Attributes
    protected[console]
    Definition Classes
    BaseLedgerApiClient
  29. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  30. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    ParticipantReferenceNamedLogging
  31. implicit def loggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  32. val name: String
  33. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  34. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  35. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  36. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  37. def optionallyAwait[Tx](tx: Tx, txId: String, optTimeout: Option[Duration]): Tx
    Attributes
    protected
    Definition Classes
    LedgerApiAdministrationBaseLedgerApiAdministration
  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 paramIfTrue[T](label: String, getValue: (T) => Boolean): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  42. 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
  43. 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
  44. 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
  45. 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
  46. 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
  47. 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
  48. 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
  49. 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
  50. implicit final def showInterpolator(sc: StringContext): ShowInterpolator
    Definition Classes
    ShowSyntax
  51. 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
  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
    InstanceReferenceAdminCommandRunner
  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 ledger_api extends Helpful
    Definition Classes
    BaseLedgerApiAdministration
    Annotations
    @Summary(s = "Group of commands that access the ledger-api", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Ledger Api")
  64. object certs
    Definition Classes
    CertificateAdministration
    Annotations
    @Summary(s = "Manage your certificates", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Certificates")
  65. 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")
  66. object domains extends Helpful
    Definition Classes
    ParticipantAdministration
    Annotations
    @Summary(s = "Manage domain connections", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Domains")
  67. 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")
  68. 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")
  69. 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 BaseLedgerApiClient

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