Packages

c

com.digitalasset.canton.console.commands

ParticipantHealthAdministration

class ParticipantHealthAdministration extends HealthAdministration[ParticipantStatus] with FeatureFlagFilter with ParticipantHealthAdministrationCommon

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ParticipantHealthAdministration
  2. ParticipantHealthAdministrationCommon
  3. FeatureFlagFilter
  4. NamedLogging
  5. HealthAdministration
  6. HealthAdministrationCommon
  7. Helpful
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ParticipantHealthAdministration(runner: AdminCommandRunner, consoleEnvironment: ConsoleEnvironment, loggerFactory: NamedLoggerFactory)

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 active: Boolean
    Definition Classes
    HealthAdministrationCommon
    Annotations
    @Summary(s = "Check if the node is running and is the active instance (mediator, participant)", flag = console.this.Help.Summary.<init>$default$2)
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def cantonConfig: CantonConfig
    Attributes
    protected
    Definition Classes
    FeatureFlagFilter
  7. def check[T](flag: FeatureFlag)(command: => T): T
    Attributes
    protected
    Definition Classes
    FeatureFlagFilter
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  9. val consoleEnvironment: ConsoleEnvironment
  10. def dump(outputFile: File = CantonHealthAdministration.defaultHealthDumpName, timeout: NonNegativeDuration = timeouts.ledgerCommand, chunkSize: Option[Int] = None): String
    Definition Classes
    HealthAdministrationCommon
    Annotations
    @Summary(s = "Creates a zip file containing diagnostic information about the canton process running this node", flag = console.this.Help.Summary.<init>$default$2)
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  13. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  14. def falseIfUnreachable(command: ConsoleCommandResult[Boolean]): Boolean
    Definition Classes
    HealthAdministrationCommon
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def has_identity(): Boolean
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. 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"))
  19. def help()(implicit consoleEnvironment: ConsoleEnvironment): Unit
    Definition Classes
    Helpful
  20. def initialized(): Boolean
    Definition Classes
    HealthAdministrationCommon
    Annotations
    @Summary(s = "Returns true if node has been initialized.", flag = console.this.Help.Summary.<init>$default$2)
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  23. val loggerFactory: NamedLoggerFactory
  24. def maybe_ping(participantId: ParticipantId, timeout: NonNegativeDuration = consoleEnvironment.commandTimeouts.ping, workflowId: String = "", id: String = ""): Option[Duration]
    Definition Classes
    ParticipantHealthAdministrationCommon
    Annotations
    @Summary(s = "Sends a ping to the target participant over the ledger. Yields Some(duration) in case of success and None in case of failure.", flag = FeatureFlag.Testing)
  25. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  28. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  29. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  30. def ping(participantId: ParticipantId, timeout: NonNegativeDuration = consoleEnvironment.commandTimeouts.ping, workflowId: String = "", id: String = ""): Duration
    Definition Classes
    ParticipantHealthAdministrationCommon
    Annotations
    @Summary(s = "Sends a ping to the target participant over the ledger. " +
    "Yields the duration in case of success and throws a RuntimeException in case of failure."
    , flag = console.this.Help.Summary.<init>$default$2)
  31. val runner: AdminCommandRunner
  32. def running(): Boolean
    Definition Classes
    HealthAdministrationCommon
    Annotations
    @Summary(s = "Check if the node is running", flag = console.this.Help.Summary.<init>$default$2)
  33. def status: NodeStatus[ParticipantStatus]
    Definition Classes
    HealthAdministrationCommon
    Annotations
    @Summary(s = "Get human (and machine) readable status info", flag = console.this.Help.Summary.<init>$default$2)
  34. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  35. def toString(): String
    Definition Classes
    AnyRef → Any
  36. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  37. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  38. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  39. def waitFor(condition: => Boolean): Unit
    Attributes
    protected
    Definition Classes
    HealthAdministrationCommon
  40. def wait_for_identity(): Unit
    Definition Classes
    HealthAdministrationCommon
    Annotations
    @Summary(s = "Wait for the node to have an identity", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """This is specifically useful for the Domain Manager which needs its identity to be ready for bootstrapping,
    | but for which we can't rely on wait_for_initialized() because it will be initialized only after being bootstrapped."""
    )
  41. def wait_for_initialized(): Unit
    Definition Classes
    HealthAdministrationCommon
    Annotations
    @Summary(s = "Wait for the node to be initialized", flag = console.this.Help.Summary.<init>$default$2)
  42. def wait_for_running(): Unit
    Definition Classes
    HealthAdministrationCommon
    Annotations
    @Summary(s = "Wait for the node to be running", flag = console.this.Help.Summary.<init>$default$2)

Deprecated Value Members

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

Inherited from FeatureFlagFilter

Inherited from NamedLogging

Inherited from Helpful

Inherited from AnyRef

Inherited from Any

Ungrouped