Type Members

1.  final case class BaseResult(domain: String, validFrom: Instant, validUntil: Option[Instant], operation: TopologyChangeOp, serialized: ByteString, signedBy: Fingerprint) extends Product with Serializable
2.  trait CantonStatus extends PrettyPrinting
3.  final case class CommunityCantonStatus(domainStatus: Map[String, DomainNodeStatus], unreachableDomains: Map[String, Failure], participantStatus: Map[String, ParticipantStatus], unreachableParticipants: Map[String, Failure]) extends CantonStatus 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 DarMetadata(name: String, main: String, packages: Seq[String], dependencies: Seq[String]) extends Product with Serializable
7.  final case class DomainManagerStatus(uid: UniqueIdentifier, uptime: Duration, ports: Map[String, Port], active: Boolean, topologyQueue: TopologyQueueStatus, components: Seq[ComponentStatus], version: Option[ReleaseVersion], protocolVersion: Option[ProtocolVersion]) extends Status with Product with Serializable
8.  final case class DomainNodeStatus(id: DomainId, uptime: Duration, ports: Map[String, Port], connectedParticipants: Seq[ParticipantId], sequencer: SequencerHealthStatus, topologyQueue: TopologyQueueStatus, components: Seq[ComponentStatus], version: Option[ReleaseVersion], protocolVersion: Option[ProtocolVersion]) extends Status with Product with Serializable
9.  sealed trait DynamicDomainParameters extends AnyRef

   Companion object com.digitalasset.canton.protocol.DynamicDomainParameters indicates when the different version were introduces.

10.  final case class DynamicDomainParametersV0(participantResponseTimeout: NonNegativeFiniteDuration, mediatorReactionTimeout: NonNegativeFiniteDuration, transferExclusivityTimeout: NonNegativeFiniteDuration, topologyChangeDelay: NonNegativeFiniteDuration, ledgerTimeRecordTimeTolerance: NonNegativeFiniteDuration) extends DynamicDomainParameters with Product with Serializable
11.  final case class DynamicDomainParametersV1(participantResponseTimeout: NonNegativeFiniteDuration, mediatorReactionTimeout: NonNegativeFiniteDuration, transferExclusivityTimeout: NonNegativeFiniteDuration, topologyChangeDelay: NonNegativeFiniteDuration, ledgerTimeRecordTimeTolerance: NonNegativeFiniteDuration, mediatorDeduplicationTimeout: NonNegativeFiniteDuration, reconciliationInterval: PositiveDurationSeconds, maxRatePerParticipant: NonNegativeInt, maxRequestSize: NonNegativeInt) extends DynamicDomainParameters with Product with Serializable
12.  final case class DynamicDomainParametersV2(participantResponseTimeout: NonNegativeFiniteDuration, mediatorReactionTimeout: NonNegativeFiniteDuration, transferExclusivityTimeout: NonNegativeFiniteDuration, topologyChangeDelay: NonNegativeFiniteDuration, ledgerTimeRecordTimeTolerance: NonNegativeFiniteDuration, mediatorDeduplicationTimeout: NonNegativeFiniteDuration, reconciliationInterval: PositiveDurationSeconds, maxRatePerParticipant: NonNegativeInt, maxRequestSize: NonNegativeInt, catchUpConfig: Option[CatchUpConfig]) extends DynamicDomainParameters with Product with Serializable
13.  final case class EnterpriseCantonStatus(domainStatus: Map[String, DomainNodeStatus], unreachableDomains: Map[String, Failure], participantStatus: Map[String, ParticipantStatus], unreachableParticipants: Map[String, Failure], domainManagerStatus: Map[String, DomainManagerStatus], unreachableDomainManagers: Map[String, Failure], sequencerStatus: Map[String, SequencerStatus], unreachableSequencers: Map[String, Failure], mediatorStatus: Map[String, MediatorStatus], unreachableMediators: Map[String, Failure]) extends CantonStatus with Product with Serializable
14.  final case class InFlightCount(pendingSubmissions: NonNegativeInt, pendingTransactions: NonNegativeInt) extends PrettyPrinting with Product with Serializable

    Represents in-flight command submissions and transactions.

15.  final case class LedgerApiObjectMeta(resourceVersion: String, annotations: Map[String, String]) extends Product with Serializable
16.  final case class LedgerApiUser(id: String, primaryParty: Option[PartyId], isDeactivated: Boolean, metadata: LedgerApiObjectMeta, identityProviderId: String) extends Product with Serializable
17.  final case class ListCheckOnlyPackagesResult(context: BaseResult, item: CheckOnlyPackages) extends Product with Serializable
18.  final case class ListConnectedDomainsResult(domainAlias: DomainAlias, domainId: DomainId, healthy: Boolean) extends Product with Serializable
19.  final case class ListDomainParametersChangeResult(context: BaseResult, item: DynamicDomainParameters) extends Product with Serializable
20.  final case class ListIdentifierDelegationResult(context: BaseResult, item: IdentifierDelegation, targetKey: Fingerprint) extends Product with Serializable
21.  final case class ListKeyOwnersResult(store: DomainId, owner: KeyOwner, signingKeys: Seq[SigningPublicKey], encryptionKeys: Seq[EncryptionPublicKey]) extends Product with Serializable
22.  final case class ListLedgerApiUsersResult(users: Seq[LedgerApiUser], nextPageToken: String) extends Product with Serializable
23.  final case class ListMediatorDomainStateResult(context: BaseResult, item: MediatorDomainState) extends Product with Serializable
24.  final case class ListNamespaceDelegationResult(context: BaseResult, item: NamespaceDelegation, targetKey: Fingerprint) extends Product with Serializable
25.  final case class ListOwnerToKeyMappingResult(context: BaseResult, item: OwnerToKeyMapping, key: Fingerprint) extends Product with Serializable
26.  final case class ListParticipantDomainStateResult(context: BaseResult, item: ParticipantState) extends Product with Serializable
27.  final case class ListPartiesResult(party: PartyId, participants: Seq[ParticipantDomains]) extends Product with Serializable
28.  final case class ListPartyToParticipantResult(context: BaseResult, item: PartyToParticipant) extends Product with Serializable
29.  final case class ListSignedLegalIdentityClaimResult(context: BaseResult, item: LegalIdentityClaim) extends Product with Serializable
30.  final case class ListVettedPackagesResult(context: BaseResult, item: VettedPackages) extends Product with Serializable
31.  final case class MediatorStatus(uid: UniqueIdentifier, domainId: DomainId, uptime: Duration, ports: Map[String, Port], active: Boolean, topologyQueue: TopologyQueueStatus, components: Seq[ComponentStatus], version: Option[ReleaseVersion], protocolVersion: Option[ProtocolVersion]) extends Status with Product with Serializable
32.  final case class ModifyingNonModifiablePartyDetailsPropertiesError() extends RuntimeException with NoStackTrace with Product with Serializable
33.  final case class ModifyingNonModifiableUserPropertiesError() extends RuntimeException with NoStackTrace with Product with Serializable
34.  sealed trait NodeStatus[+S <: Status] extends PrettyPrinting with Product with Serializable
35.  final case class ParticipantPruningSchedule(schedule: PruningSchedule, pruneInternallyOnly: Boolean) extends Product with Serializable
36.  final case class ParticipantStatus(uid: UniqueIdentifier, uptime: Duration, ports: Map[String, Port], connectedDomains: Map[DomainId, Boolean], active: Boolean, topologyQueue: TopologyQueueStatus, components: Seq[ComponentStatus], version: Option[ReleaseVersion], supportedProtocolVersions: Option[Seq[ProtocolVersion]]) extends Status with Product with Serializable
37.  final case class PartyDetails(party: PartyId, displayName: String, isLocal: Boolean, annotations: Map[String, String], identityProviderId: String) extends Product with Serializable

    Represents a party details value exposed in the Canton console

38.  final case class PruningSchedule(cron: String, maxDuration: PositiveDurationSeconds, retention: PositiveDurationSeconds) extends Product with Serializable
39.  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

40.  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

41.  final case class SequencerStatus(uid: UniqueIdentifier, domainId: DomainId, uptime: Duration, ports: Map[String, Port], connectedParticipants: Seq[ParticipantId], connectedMediators: Seq[MediatorId], sequencer: SequencerHealthStatus, topologyQueue: TopologyQueueStatus, admin: Option[SequencerAdminStatus], components: Seq[ComponentStatus], version: Option[ReleaseVersion], protocolVersion: Option[ProtocolVersion]) extends Status with Product with Serializable
42.  final case class SimpleStatus(uid: UniqueIdentifier, uptime: Duration, ports: Map[String, Port], active: Boolean, topologyQueue: TopologyQueueStatus, components: Seq[ComponentStatus], version: Option[ReleaseVersion]) extends Status with Product with Serializable
43.  sealed trait StaticDomainParameters extends AnyRef

    Companion object com.digitalasset.canton.protocol.StaticDomainParameters indicates when the different version were introduces.

44.  sealed abstract case class StaticDomainParametersV0 extends StaticDomainParameters with Product with Serializable
45.  sealed abstract case class StaticDomainParametersV1 extends StaticDomainParameters with Product with Serializable
46.  final case class TemplateId(packageId: String, moduleName: String, entityName: String) extends Product with Serializable
47.  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

48.  final case class User(id: String, primaryParty: Option[PartyId], isActive: Boolean, annotations: Map[String, String], identityProviderId: String) extends Product with Serializable

    Represents a user value exposed in the Canton console

49.  final case class UserRights(actAs: Set[PartyId], readAs: Set[PartyId], participantAdmin: Boolean, identityProviderAdmin: Boolean) extends Product with Serializable
50.  final case class UsersPage(users: Seq[User], nextPageToken: String) extends Product with Serializable