Type Members

1.  final case class AcsCommitmentsCatchUpParameters(catchUpIntervalSkip: PositiveInt, nrIntervalsToTriggerCatchUp: PositiveInt) extends PrettyPrinting with Product with Serializable
2.  final case class AddPartyStatus(partyId: PartyId, synchronizerId: SynchronizerId, sourceParticipantId: ParticipantId, targetParticipantId: ParticipantId, status: Status) extends Product with Serializable
3.  final case class CantonStatus(sequencerStatus: Map[String, SequencerStatus], unreachableSequencers: Map[String, Failure], mediatorStatus: Map[String, MediatorStatus], unreachableMediators: Map[String, Failure], participantStatus: Map[String, ParticipantStatus], unreachableParticipants: Map[String, Failure]) extends PrettyPrinting with Product with Serializable
4.  sealed trait ComponentHealthState extends PrettyPrinting

   Generic State implementation of a component This can be used as a base health state for most component.

   Generic State implementation of a component This can be used as a base health state for most component. However ComponentHealth (below) does not enforce the use of this class and a custom State class can be used instead

5.  final case class ComponentStatus(name: String, state: ComponentHealthState) extends PrettyPrinting with Product with Serializable
6.  final case class DarContents(description: DarDescription, packages: Seq[PackageDescription]) extends PrettyPrinting with Product with Serializable
7.  final case class DarDescription(mainPackageId: String, name: String, version: String, description: String) extends Product with Serializable
8.  final case class DynamicSynchronizerParameters(confirmationResponseTimeout: NonNegativeFiniteDuration, mediatorReactionTimeout: NonNegativeFiniteDuration, assignmentExclusivityTimeout: NonNegativeFiniteDuration, topologyChangeDelay: NonNegativeFiniteDuration, ledgerTimeRecordTimeTolerance: NonNegativeFiniteDuration, mediatorDeduplicationTimeout: NonNegativeFiniteDuration, reconciliationInterval: PositiveDurationSeconds, maxRequestSize: NonNegativeInt, sequencerAggregateSubmissionTimeout: NonNegativeFiniteDuration, trafficControl: Option[TrafficControlParameters], onboardingRestriction: OnboardingRestriction, acsCommitmentsCatchUp: Option[AcsCommitmentsCatchUpParameters], participantSynchronizerLimits: ParticipantSynchronizerLimits, preparationTimeRecordTimeTolerance: NonNegativeFiniteDuration) extends PrettyPrinting with Product with Serializable
9.  final case class InFlightCount(pendingSubmissions: NonNegativeInt, pendingTransactions: NonNegativeInt) extends PrettyPrinting with Product with Serializable

   Represents in-flight command submissions and transactions.

10.  final case class LedgerApiObjectMeta(resourceVersion: String, annotations: Map[String, String]) extends Product with Serializable
11.  final case class LedgerApiUser(id: String, primaryParty: Option[PartyId], isDeactivated: Boolean, metadata: LedgerApiObjectMeta, identityProviderId: String) extends Product with Serializable
12.  final case class ListConnectedSynchronizersResult(synchronizerAlias: SynchronizerAlias, synchronizerId: SynchronizerId, healthy: Boolean) extends Product with Serializable
13.  final case class ListKeyOwnersResult(store: SynchronizerId, owner: Member, signingKeys: Seq[SigningPublicKey], encryptionKeys: Seq[EncryptionPublicKey]) extends Product with Serializable
14.  final case class ListLedgerApiUsersResult(users: Seq[LedgerApiUser], nextPageToken: String) extends Product with Serializable
15.  final case class ListPartiesResult(party: PartyId, participants: Seq[ParticipantSynchronizers]) extends Product with Serializable
16.  final case class MediatorStatus(uid: UniqueIdentifier, synchronizerId: SynchronizerId, uptime: Duration, ports: Map[String, Port], active: Boolean, topologyQueue: TopologyQueueStatus, components: Seq[ComponentStatus], version: ReleaseVersion, protocolVersion: ProtocolVersion) extends Status with Product with Serializable
17.  final case class ModifyingNonModifiablePartyDetailsPropertiesError() extends RuntimeException with NoStackTrace with Product with Serializable
18.  final case class ModifyingNonModifiableUserPropertiesError() extends RuntimeException with NoStackTrace with Product with Serializable
19.  sealed trait NodeStatus[+S <: Status] extends PrettyPrinting with Product with Serializable
20.  sealed trait OnboardingRestriction extends Product with Serializable with PrettyPrinting
21.  final case class PackageDescription(packageId: String, name: String, version: String, uploadedAt: CantonTimestamp, packageSize: Int) extends PrettyPrinting with Product with Serializable
22.  final case class ParticipantPruningSchedule(schedule: PruningSchedule, pruneInternallyOnly: Boolean) extends Product with Serializable
23.  final case class ParticipantStatus(id: ParticipantId, uptime: Duration, ports: Map[String, Port], connectedSynchronizers: Map[SynchronizerId, SubmissionReady], active: Boolean, topologyQueue: TopologyQueueStatus, components: Seq[ComponentStatus], version: ReleaseVersion, supportedProtocolVersions: Seq[ProtocolVersion]) extends Status with Product with Serializable
24.  final case class ParticipantSynchronizerLimits(confirmationRequestsMaxRate: NonNegativeInt) extends PrettyPrinting with Product with Serializable
25.  final case class PartyDetails(party: PartyId, isLocal: Boolean, annotations: Map[String, String], identityProviderId: String) extends Product with Serializable

    Represents a party details value exposed in the Canton console

    Represents a party details value exposed in the Canton console

    isLocal

    true if party is hosted by the participant and the party shares the same identity provider as the user issuing the request.

26.  final case class PruningSchedule(cron: String, maxDuration: PositiveDurationSeconds, retention: PositiveDurationSeconds) extends Product with Serializable
27.  final case class SequencerAdminStatus(acceptsAdminChanges: Boolean) extends PrettyPrinting with Product with Serializable

    Admin status of the sequencer node.

    Admin status of the sequencer node.

    acceptsAdminChanges

    indicates whether the sequencer node accepts administration commands

28.  final case class SequencerHealthStatus(isActive: Boolean, details: Option[String] = None) extends PrettyPrinting with Product with Serializable

    Health status of the sequencer component itself.

    Health status of the sequencer component itself.

    isActive

    implementation specific flag indicating whether the sequencer is active

29.  final case class SequencerStatus(uid: UniqueIdentifier, synchronizerId: SynchronizerId, uptime: Duration, ports: Map[String, Port], connectedParticipants: Seq[ParticipantId], connectedMediators: Seq[MediatorId], sequencer: SequencerHealthStatus, topologyQueue: TopologyQueueStatus, admin: SequencerAdminStatus, components: Seq[ComponentStatus], version: ReleaseVersion, protocolVersion: ProtocolVersion) extends Status with Product with Serializable
30.  final case class SimpleStatus(uid: UniqueIdentifier, uptime: Duration, ports: Map[String, Port], active: Boolean, topologyQueue: TopologyQueueStatus, components: Seq[ComponentStatus], version: ReleaseVersion) extends Status with Product with Serializable
31.  final case class StaticSynchronizerParameters(requiredSigningSpecs: RequiredSigningSpecs, requiredEncryptionSpecs: RequiredEncryptionSpecs, requiredSymmetricKeySchemes: NonEmpty[Set[SymmetricKeyScheme]], requiredHashAlgorithms: NonEmpty[Set[HashAlgorithm]], requiredCryptoKeyFormats: NonEmpty[Set[CryptoKeyFormat]], requiredSignatureFormats: NonEmpty[Set[SignatureFormat]], protocolVersion: ProtocolVersion) extends Product with Serializable
32.  final case class TemplateId(packageId: String, moduleName: String, entityName: String) extends Product with Serializable
33.  final case class TopologyQueueStatus(manager: Int, dispatcher: Int, clients: Int) extends PrettyPrinting with Product with Serializable

    Topology manager queue status

    Topology manager queue status

    Status around topology management queues

    manager

    number of queued commands in the topology manager

    dispatcher

    number of queued transactions in the dispatcher

    clients

    number of observed transactions that are not yet effective

34.  final case class TrafficControlParameters(maxBaseTrafficAmount: NonNegativeLong, readVsWriteScalingFactor: PositiveInt, maxBaseTrafficAccumulationDuration: PositiveFiniteDuration, setBalanceRequestSubmissionWindowSize: PositiveFiniteDuration, enforceRateLimiting: Boolean, baseEventCost: NonNegativeLong) extends PrettyPrinting with Product with Serializable
35.  final case class User(id: String, primaryParty: Option[PartyId], isDeactivated: Boolean, annotations: Map[String, String], identityProviderId: String) extends Product with Serializable

    Represents a user value exposed in the Canton console

36.  final case class UserRights(actAs: Set[PartyId], readAs: Set[PartyId], readAsAnyParty: Boolean, participantAdmin: Boolean, identityProviderAdmin: Boolean) extends Product with Serializable
37.  final case class UsersPage(users: Seq[User], nextPageToken: String) extends Product with Serializable
38.  sealed abstract class WaitingForExternalInput extends PrettyPrinting