Packages

abstract class ParticipantReference extends ParticipantReferenceCommon with InstanceReference

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ParticipantReference
  2. InstanceReference
  3. ParticipantReferenceCommon
  4. InstanceReferenceCommon
  5. PrettyPrinting
  6. PrettyUtil
  7. ShowUtil
  8. ShowSyntax
  9. ToShowOps
  10. AdminCommandRunner
  11. LedgerApiCommandRunner
  12. LedgerApiAdministration
  13. BaseLedgerApiAdministration
  14. NoTracing
  15. ParticipantAdministration
  16. ConsoleCommandGroup
  17. FeatureFlagFilter
  18. NamedLogging
  19. Helpful
  20. AnyRef
  21. 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 Status = ParticipantStatus
  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 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
    AdminCommandRunner
  2. abstract def config: BaseParticipantConfig
    Definition Classes
    ParticipantReferenceCommon
  3. abstract def keys: KeyAdministrationGroup
    Definition Classes
    InstanceReferenceCommon
  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 repair: ParticipantRepairAdministration
    Definition Classes
    ParticipantReferenceCommon
    Annotations
    @Summary(s = "Commands to repair the participant contract state", flag = FeatureFlag.Repair) @Group(name = "Repair")
  7. abstract def testing: ParticipantTestingGroup
    Definition Classes
    ParticipantReferenceCommon
    Annotations
    @Summary(s = "Commands used for development and testing", flag = FeatureFlag.Testing) @Group(name = "Testing")
  8. abstract def token: Option[String]
    Attributes
    protected[console]
    Definition Classes
    LedgerApiCommandRunner

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. lazy val applicationId: String
    Attributes
    protected
    Definition Classes
    BaseLedgerApiAdministration
  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. 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 defaultLimit: PositiveInt
    Attributes
    protected
    Definition Classes
    BaseLedgerApiAdministration
  14. def domainOfTransaction(transactionId: String): DomainId
    Attributes
    protected
    Definition Classes
    LedgerApiAdministrationBaseLedgerApiAdministration
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  17. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  18. implicit lazy val executionContext: ExecutionContext
    Attributes
    protected[canton]
    Definition Classes
    BaseLedgerApiAdministration
  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: ParticipantHealthAdministration
    Definition Classes
    ParticipantReferenceInstanceReferenceCommon
    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: ParticipantId
    Definition Classes
    ParticipantReferenceParticipantReferenceCommonInstanceReferenceCommonParticipantAdministration
    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)
  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
    ParticipantReferenceInstanceReferenceCommon
  27. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  28. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  29. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    ParticipantReferenceCommonNamedLogging
  30. val name: String
  31. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  32. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  33. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  34. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  35. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  36. def optionallyAwait[Tx](tx: Tx, txId: String, optTimeout: Option[NonNegativeDuration]): Tx
    Attributes
    protected
    Definition Classes
    LedgerApiAdministrationBaseLedgerApiAdministration
  37. 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
  38. def paramIfDefined[T, V](name: String, getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  39. def paramIfNonEmpty[T, V <: IterableOnce[_]](name: String, getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  40. 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
  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 participantIsActiveOnDomain(domainId: DomainId, participantId: ParticipantId): Boolean
    Attributes
    protected
    Definition Classes
    ParticipantReferenceParticipantAdministration
  44. 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
  45. def prettyInfix[T]: PrettyInfixPartiallyApplied[T]
    Definition Classes
    PrettyUtil
  46. 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
  47. 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
  48. 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
  49. 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
  50. 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
  51. def pruning: ParticipantPruningAdministrationGroup
    Definition Classes
    ParticipantReferenceCommon
    Annotations
    @Summary(s = "Commands to pruning the archive of the ledger", flag = FeatureFlag.Preview) @Group(name = "Ledger Pruning")
  52. def replication: ParticipantReplicationAdministrationGroup
    Definition Classes
    ParticipantReferenceCommon
    Annotations
    @Summary(s = "Manage participant replication", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Replication")
  53. def runner: AdminCommandRunner
    Attributes
    protected
    Definition Classes
    ParticipantReferenceConsoleCommandGroup
  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. implicit def toShow[A](target: A)(implicit tc: Show[A]): Ops[A]
    Definition Classes
    ToShowOps
  58. 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
  59. def topology: TopologyAdministrationGroup
    Definition Classes
    ParticipantReferenceInstanceReferenceInstanceReferenceCommon
    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.")
  60. implicit def traceContext: TraceContext
    Attributes
    protected
    Definition Classes
    NoTracing
  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. def vettedPackagesOfParticipant(): Set[PackageId]
    Attributes
    protected
    Definition Classes
    ParticipantReferenceParticipantAdministration
  66. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  67. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  68. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  69. 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")
  70. 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")
  71. object domains extends Helpful
    Definition Classes
    ParticipantAdministration
    Annotations
    @Summary(s = "Manage domain connections", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Domains")
  72. 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")
  73. 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")
  74. 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
    Deprecated

Inherited from InstanceReference

Inherited from PrettyPrinting

Inherited from PrettyUtil

Inherited from ShowUtil

Inherited from ShowSyntax

Inherited from ToShowOps

Inherited from AdminCommandRunner

Inherited from LedgerApiCommandRunner

Inherited from NoTracing

Inherited from ConsoleCommandGroup

Inherited from FeatureFlagFilter

Inherited from NamedLogging

Inherited from Helpful

Inherited from AnyRef

Inherited from Any

Ungrouped