abstract class ParticipantReference extends InstanceReference with ConsoleCommandGroup with ParticipantAdministration with LedgerApiAdministration with LedgerApiCommandRunner
Linear Supertypes
Known Subclasses
Ordering
- Alphabetic
- By Inheritance
Inherited
- ParticipantReference
- LedgerApiCommandRunner
- LedgerApiAdministration
- BaseLedgerApiAdministration
- StreamingCommandHelper
- NoTracing
- ParticipantAdministration
- ConsoleCommandGroup
- InstanceReference
- PrettyPrinting
- PrettyUtil
- ShowUtil
- ShowSyntax
- ToShowOps
- FeatureFlagFilter
- NamedLogging
- Helpful
- HasUniqueIdentifier
- HasNamespace
- HasFingerprint
- AdminCommandRunner
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- Protected
Instance Constructors
- new ParticipantReference(consoleEnvironment: ConsoleEnvironment, name: String)
Type Members
- type Status = ParticipantStatus
- Definition Classes
- ParticipantReference → InstanceReference
- implicit class ShowAnyRefSyntax extends AnyRef
- Definition Classes
- ShowUtil
- implicit class ShowEitherSyntax[L, R] extends AnyRef
Enables the syntax
show"${myEither.showMerged}".Enables the syntax
show"${myEither.showMerged}".- Definition Classes
- ShowUtil
- implicit class ShowLengthLimitedStringSyntax extends StringOperators
- Definition Classes
- ShowUtil
- implicit class ShowLengthLimitedStringWrapperSyntax extends StringOperators
- Definition Classes
- ShowUtil
- implicit class ShowOptionSyntax[T] extends AnyRef
- Definition Classes
- ShowUtil
- implicit class ShowProductSyntax extends AnyRef
- Definition Classes
- ShowUtil
- Annotations
- @SuppressWarnings()
- implicit class ShowStringSyntax extends StringOperators
- Definition Classes
- ShowUtil
- 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 class StringOperators extends AnyRef
Enables syntax like:
Enables syntax like:
show"This is a string: ${myString.doubleQuoted}"and:
show"This is a hash: ${myHash.readableHash}"- Definition Classes
- ShowUtil
Abstract Value Members
- 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
- abstract def adminToken: Option[String]
- Definition Classes
- InstanceReference
- abstract def config: BaseParticipantConfig
- abstract def keys: KeyAdministrationGroup
- Definition Classes
- InstanceReference
- abstract def ledgerApiCommand[Result](command: GrpcAdminCommand[_, _, Result]): ConsoleCommandResult[Result]
- Attributes
- protected[console]
- Definition Classes
- LedgerApiCommandRunner
- abstract def testing: ParticipantTestingGroup
- Annotations
- @Summary(s = "Commands used for development and testing", flag = FeatureFlag.Testing) @Group(name = "Testing")
- abstract def token: Option[String]
- Attributes
- protected[console]
- Definition Classes
- LedgerApiCommandRunner
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- 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
- Instances of
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def cantonConfig: CantonConfig
- Attributes
- protected
- Definition Classes
- FeatureFlagFilter
- def check[T](flag: FeatureFlag)(command: => T): T
- Attributes
- protected
- Definition Classes
- FeatureFlagFilter
- 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.")
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- def commitments: CommitmentsAdministrationGroup
- Annotations
- @Summary(s = "Commands to inspect and extract bilateral commitments", flag = FeatureFlag.Preview) @Group(name = "Commitments")
- val consoleEnvironment: ConsoleEnvironment
- 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
- def defaultLimit: PositiveInt
- Attributes
- protected
- Definition Classes
- BaseLedgerApiAdministration
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
- Attributes
- protected
- Definition Classes
- NamedLogging
- implicit lazy val executionContext: ExecutionContext
- Attributes
- protected[canton]
- Definition Classes
- BaseLedgerApiAdministration
- final def fingerprint: Fingerprint
- Definition Classes
- HasNamespace → HasFingerprint
- Annotations
- @inline()
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- InstanceReference → AnyRef → Any
- def health: ParticipantHealthAdministration
- Definition Classes
- ParticipantReference → InstanceReference
- Annotations
- @Summary(s = "Health and diagnostic related commands", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Health")
- 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"))
- def help()(implicit consoleEnvironment: ConsoleEnvironment): Unit
- Definition Classes
- Helpful
- def id: ParticipantId
- Definition Classes
- ParticipantReference → ParticipantAdministration → InstanceReference
- 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)
- final def identifier: String185
- Definition Classes
- HasUniqueIdentifier
- Annotations
- @inline()
- 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
- val instanceType: String
- Attributes
- protected[canton]
- Definition Classes
- ParticipantReference → InstanceReference
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def logger: TracedLogger
- Attributes
- protected
- Definition Classes
- NamedLogging
- val loggerFactory: NamedLoggerFactory
- Attributes
- protected
- Definition Classes
- ParticipantReference → NamedLogging
- def maybeId: Option[ParticipantId]
- Definition Classes
- ParticipantReference → InstanceReference
- Annotations
- @Summary(s = "Yields Some(id) of this participant if id present. " +
"Returns None, if the id has not yet been allocated (e.g., the participant has not yet been initialised).", flag = console.this.Help.Summary.<init>$default$2)
- def mkResult[Res](call: => AutoCloseable, requestDescription: String, observer: RecordingStreamObserver[Res], timeout: NonNegativeDuration): Seq[Res]
- Definition Classes
- StreamingCommandHelper
- val name: String
- Definition Classes
- ParticipantReference → LedgerApiAdministration → BaseLedgerApiAdministration → StreamingCommandHelper → InstanceReference
- implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
- Attributes
- protected
- Definition Classes
- NamedLogging
- final def namespace: Namespace
- Definition Classes
- HasUniqueIdentifier → HasNamespace
- Annotations
- @inline()
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def noTracingLogger: Logger
- Attributes
- protected
- Definition Classes
- NamedLogging
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- def optionallyAwait[Tx](tx: Tx, txId: String, txSynchronizerId: String, optTimeout: Option[NonNegativeDuration]): Tx
- Attributes
- protected
- Definition Classes
- LedgerApiAdministration → BaseLedgerApiAdministration
- 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
- def paramIfDefined[T, V](name: String, getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
- Definition Classes
- PrettyUtil
- def paramIfNonEmpty[T, V <: IterableOnce[_]](name: String, getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
- Definition Classes
- PrettyUtil
- 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
- def paramIfTrue[T](label: String, getValue: (T) => Boolean): (T) => Option[Tree]
- Definition Classes
- PrettyUtil
- 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
- def participantIsActiveOnSynchronizer(synchronizerId: SynchronizerId, participantId: ParticipantId): Boolean
- Attributes
- protected
- Definition Classes
- ParticipantReference → ParticipantAdministration
- def parties: ParticipantPartiesAdministrationGroup
- Definition Classes
- ParticipantReference → InstanceReference
- Annotations
- @Summary(s = "Inspect and manage parties", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Parties")
- def pretty: Pretty[InstanceReference]
Indicates how to pretty print this instance.
Indicates how to pretty print this instance. See
PrettyPrintingTestfor examples on how to implement this method.- Attributes
- protected
- Definition Classes
- InstanceReference → PrettyPrinting
- def prettyInfix[T]: PrettyInfixPartiallyApplied[T]
- Definition Classes
- PrettyUtil
- 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
- 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
- def prettyOfClassWithName[T](name: String)(getParamTrees: (T) => Option[Tree]*): Pretty[T]
Like prettyOfClass, except takes an explicit name for the class.
Like prettyOfClass, except takes an explicit name for the class.
- Definition Classes
- PrettyUtil
- 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
- 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
- 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
- def pruning: ParticipantPruningAdministrationGroup
- Annotations
- @Summary(s = "Commands to pruning the archive of the ledger", flag = FeatureFlag.Preview) @Group(name = "Ledger Pruning")
- def repair: ParticipantRepairAdministration
- Annotations
- @Summary(s = "Commands to repair the participant contract state", flag = FeatureFlag.Repair) @Group(name = "Repair")
- def replication: ParticipantReplicationAdministrationGroup
- def runner: AdminCommandRunner
- Attributes
- protected
- Definition Classes
- ParticipantReference → ConsoleCommandGroup
- implicit final def showInterpolator(sc: StringContext): ShowInterpolator
- Definition Classes
- ShowSyntax
- 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
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- implicit def toShow[A](target: A)(implicit tc: Show[A]): Ops[A]
- Definition Classes
- ToShowOps
- 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.
Finalto avoid accidental overwriting.- Definition Classes
- PrettyPrinting → AnyRef → Any
- def topology: TopologyAdministrationGroup
- Definition Classes
- ParticipantReference → InstanceReference
- 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.")
- implicit def traceContext: TraceContext
- Attributes
- protected
- Definition Classes
- NoTracing
- def tracedLogger: TracedLogger
- Attributes
- protected[console]
- Definition Classes
- InstanceReference → AdminCommandRunner
- def traffic_control: TrafficControlAdministrationGroup
- Definition Classes
- InstanceReference
- Annotations
- @Summary(s = "Traffic control related commands", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Traffic")
- final def uid: UniqueIdentifier
- Definition Classes
- InstanceReference → HasUniqueIdentifier
- Annotations
- @inline()
- 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
- def unnamedParamIfDefined[T, V](getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
- Definition Classes
- PrettyUtil
- def unnamedParamIfNonEmpty[T, V <: IterableOnce[_]](getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
- Definition Classes
- PrettyUtil
- lazy val userId: String
- Attributes
- protected
- Definition Classes
- BaseLedgerApiAdministration
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def waitPackagesVetted(timeout: NonNegativeDuration): Unit
Waits until for every participant p (drawn from consoleEnvironment.participants.all) that is running and initialized and for each synchronizer to which both this participant and p are connected the vetted_package transactions in the authorized store are the same as in the synchronizer store.
Waits until for every participant p (drawn from consoleEnvironment.participants.all) that is running and initialized and for each synchronizer to which both this participant and p are connected the vetted_package transactions in the authorized store are the same as in the synchronizer store.
- Attributes
- protected
- Definition Classes
- ParticipantReference → ParticipantAdministration
- object ledger_api extends Helpful
- Definition Classes
- BaseLedgerApiAdministration
- Annotations
- @Summary(s = "Group of commands that access the ledger-api V2", flag = FeatureFlag.Testing) @Group(name = "Ledger Api")
- 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")
- 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")
- 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")
- object synchronizers extends Helpful
- Definition Classes
- ParticipantAdministration
- Annotations
- @Summary(s = "Manage synchronizer connections", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Synchronizers")