Type Members

1.  final case class AdditionSuccess() extends GeneratedMessage with Updatable[AdditionSuccess] with Product with Serializable

   Annotations

   @SerialVersionUID()

2.  final case class AuthorizationData(change: TopologyChangeOp, signedBy: String, replaceExisting: Boolean, forceChange: Boolean) extends GeneratedMessage with Updatable[AuthorizationData] with Product with Serializable
   change

   * Add / Remove / Replace

   signedBy

   * Fingerprint of the key signing the authorization The signing key is used to identify a particular NamespaceDelegation or IdentifierDelegation certificate, which is used to justify the given authorization.

   replaceExisting

   * if true, the authorization will also replace the existing (makes only sense for adds)

   forceChange

   * Force change even if dangerous

   Annotations

   @SerialVersionUID()

3.  final case class AuthorizationSuccess(serialized: ByteString) extends GeneratedMessage with Updatable[AuthorizationSuccess] with Product with Serializable

   Annotations

   @SerialVersionUID()

4.  final case class BaseQuery(filterStore: String, useStateStore: Boolean, operation: TopologyChangeOp, filterOperation: Boolean, timeQuery: TimeQuery, filterSignedKey: String) extends GeneratedMessage with Updatable[BaseQuery] with Product with Serializable
   filterOperation

   * if true, then we'll filter the results according to above defined operation

   Annotations

   @SerialVersionUID()

5.  final case class BaseResult(store: String, sequenced: Option[Timestamp], validFrom: Option[Timestamp], validUntil: Option[Timestamp], operation: TopologyChangeOp, serialized: ByteString, signedByFingerprint: String) extends GeneratedMessage with Updatable[BaseResult] with Product with Serializable
   sequenced

   TODO(i9014) reorder once we break the admin api

   Annotations

   @SerialVersionUID()

6.  final case class DomainParametersChangeAuthorization(authorization: Option[AuthorizationData], domain: String, parameters: Option[DynamicDomainParameters]) extends GeneratedMessage with Updatable[DomainParametersChangeAuthorization] with Product with Serializable
   domain

   * domain this authorization refers to

   parameters

   * new parameters for the domain

   Annotations

   @SerialVersionUID()

7.  final case class GetIdResponse(initialized: Boolean, uniqueIdentifier: String, instance: String) extends GeneratedMessage with Updatable[GetIdResponse] with Product with Serializable

   Annotations

   @SerialVersionUID()

8.  final case class IdentifierDelegationAuthorization(authorization: Option[AuthorizationData], identifier: String, fingerprintOfAuthorizedKey: String) extends GeneratedMessage with Updatable[IdentifierDelegationAuthorization] with Product with Serializable
   fingerprintOfAuthorizedKey

   * The fingerprint of the signing key which will be authorized to issue topology transaction for this particular identifier. As with NamespaceDelegations, the key needs to be present locally.

   Annotations

   @SerialVersionUID()

9.  final case class InitIdRequest(identifier: String, fingerprint: String, instance: String) extends GeneratedMessage with Updatable[InitIdRequest] with Product with Serializable
   instance

   optional - instance id, if supplied value is empty then one will be generated

   Annotations

   @SerialVersionUID()

10.  final case class InitIdResponse(uniqueIdentifier: String, instance: String) extends GeneratedMessage with Updatable[InitIdResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

11.  final case class ListAllRequest(baseQuery: Option[BaseQuery]) extends GeneratedMessage with Updatable[ListAllRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

12.  final case class ListAllResponse(result: Option[TopologyTransactions]) extends GeneratedMessage with Updatable[ListAllResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

13.  final case class ListAvailableStoresRequest() extends GeneratedMessage with Updatable[ListAvailableStoresRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

14.  final case class ListAvailableStoresResult(storeIds: Seq[String]) extends GeneratedMessage with Updatable[ListAvailableStoresResult] with Product with Serializable

    Annotations

    @SerialVersionUID()

15.  final case class ListDomainParametersChangesRequest(baseQuery: Option[BaseQuery]) extends GeneratedMessage with Updatable[ListDomainParametersChangesRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

16.  final case class ListDomainParametersChangesResult(results: Seq[Result]) extends GeneratedMessage with Updatable[ListDomainParametersChangesResult] with Product with Serializable

    Annotations

    @SerialVersionUID()

17.  final case class ListIdentifierDelegationRequest(baseQuery: Option[BaseQuery], filterUid: String) extends GeneratedMessage with Updatable[ListIdentifierDelegationRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

18.  final case class ListIdentifierDelegationResult(results: Seq[Result]) extends GeneratedMessage with Updatable[ListIdentifierDelegationResult] with Product with Serializable

    Annotations

    @SerialVersionUID()

19.  final case class ListKeyOwnersRequest(asOf: Option[Timestamp], limit: Int, filterDomain: String, filterKeyOwnerType: String, filterKeyOwnerUid: String) extends GeneratedMessage with Updatable[ListKeyOwnersRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

20.  final case class ListKeyOwnersResponse(results: Seq[Result]) extends GeneratedMessage with Updatable[ListKeyOwnersResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

21.  final case class ListMediatorDomainStateRequest(baseQuery: Option[BaseQuery], filterDomain: String, filterMediator: String) extends GeneratedMessage with Updatable[ListMediatorDomainStateRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

22.  final case class ListMediatorDomainStateResult(results: Seq[Result]) extends GeneratedMessage with Updatable[ListMediatorDomainStateResult] with Product with Serializable

    Annotations

    @SerialVersionUID()

23.  final case class ListNamespaceDelegationRequest(baseQuery: Option[BaseQuery], filterNamespace: String) extends GeneratedMessage with Updatable[ListNamespaceDelegationRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

24.  final case class ListNamespaceDelegationResult(results: Seq[Result]) extends GeneratedMessage with Updatable[ListNamespaceDelegationResult] with Product with Serializable

    Annotations

    @SerialVersionUID()

25.  final case class ListOwnerToKeyMappingRequest(baseQuery: Option[BaseQuery], filterKeyOwnerType: String, filterKeyOwnerUid: String, filterKeyPurpose: Option[FilterKeyPurpose]) extends GeneratedMessage with Updatable[ListOwnerToKeyMappingRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

26.  final case class ListOwnerToKeyMappingResult(results: Seq[Result]) extends GeneratedMessage with Updatable[ListOwnerToKeyMappingResult] with Product with Serializable

    Annotations

    @SerialVersionUID()

27.  final case class ListParticipantDomainStateRequest(baseQuery: Option[BaseQuery], filterDomain: String, filterParticipant: String) extends GeneratedMessage with Updatable[ListParticipantDomainStateRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

28.  final case class ListParticipantDomainStateResult(results: Seq[Result]) extends GeneratedMessage with Updatable[ListParticipantDomainStateResult] with Product with Serializable

    Annotations

    @SerialVersionUID()

29.  final case class ListPartiesRequest(asOf: Option[Timestamp], limit: Int, filterDomain: String, filterParty: String, filterParticipant: String) extends GeneratedMessage with Updatable[ListPartiesRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

30.  final case class ListPartiesResponse(results: Seq[Result]) extends GeneratedMessage with Updatable[ListPartiesResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

31.  final case class ListPartyToParticipantRequest(baseQuery: Option[BaseQuery], filterParty: String, filterParticipant: String, filterRequestSide: Option[FilterRequestSide], filterPermission: Option[FilterPermission]) extends GeneratedMessage with Updatable[ListPartyToParticipantRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

32.  final case class ListPartyToParticipantResult(results: Seq[Result]) extends GeneratedMessage with Updatable[ListPartyToParticipantResult] with Product with Serializable

    Annotations

    @SerialVersionUID()

33.  final case class ListSignedLegalIdentityClaimRequest(baseQuery: Option[BaseQuery], filterUid: String) extends GeneratedMessage with Updatable[ListSignedLegalIdentityClaimRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

34.  final case class ListSignedLegalIdentityClaimResult(results: Seq[Result]) extends GeneratedMessage with Updatable[ListSignedLegalIdentityClaimResult] with Product with Serializable

    Annotations

    @SerialVersionUID()

35.  final case class ListVettedPackagesRequest(baseQuery: Option[BaseQuery], filterParticipant: String) extends GeneratedMessage with Updatable[ListVettedPackagesRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

36.  final case class ListVettedPackagesResult(results: Seq[Result]) extends GeneratedMessage with Updatable[ListVettedPackagesResult] with Product with Serializable

    Annotations

    @SerialVersionUID()

37.  final case class MediatorDomainStateAuthorization(authorization: Option[AuthorizationData], side: RequestSide, domain: String, mediator: String) extends GeneratedMessage with Updatable[MediatorDomainStateAuthorization] with Product with Serializable
    side

    * which side (domain or mediator) is attempting to issue the authorization

    domain

    * domain this authorization refers to

    mediator

    * mediator that should be authorized

    Annotations

    @SerialVersionUID()

38.  final case class NamespaceDelegationAuthorization(authorization: Option[AuthorizationData], namespace: String, fingerprintOfAuthorizedKey: String, isRootDelegation: Boolean) extends GeneratedMessage with Updatable[NamespaceDelegationAuthorization] with Product with Serializable
    namespace

    The namespace for which the authorization is issued.

    fingerprintOfAuthorizedKey

    * The fingerprint of the signing key which will be authorized to issue topology transactions for this namespace. The key needs to be present in the local key registry either by being locally generated or by having been previously imported.

    isRootDelegation

    * Flag indicating whether authorization is a root key delegation

    Annotations

    @SerialVersionUID()

39.  final case class OwnerToKeyMappingAuthorization(authorization: Option[AuthorizationData], keyOwner: String, fingerprintOfKey: String, keyPurpose: KeyPurpose) extends GeneratedMessage with Updatable[OwnerToKeyMappingAuthorization] with Product with Serializable
    keyOwner

    * The key owner An entity in Canton is described by his role and his unique identifier. As such, the same unique identifier can be used for a mediator, sequencer, domain topology manager or even participant. Therefore, we expect here the protoPrimitive of a key owner which is in effect its type as a three letter code separated from the unique identifier.

    fingerprintOfKey

    * The fingerprint of the key that will be authorized The key needs to be present in the local key registry (can be imported via KeyService)

    keyPurpose

    * Purpose of the key

    Annotations

    @SerialVersionUID()

40.  final case class ParticipantDomainStateAuthorization(authorization: Option[AuthorizationData], side: RequestSide, domain: String, participant: String, permission: ParticipantPermission, trustLevel: TrustLevel) extends GeneratedMessage with Updatable[ParticipantDomainStateAuthorization] with Product with Serializable
    side

    * which side (domain or participant) is attempting to issue the authorization

    domain

    * domain this authorization refers to

    participant

    * participant that should be authorized

    permission

    * permission that should be used (lower of From / To)

    trustLevel

    * trust level that should be used (ignored for side from, defaults to Ordinary)

    Annotations

    @SerialVersionUID()

41.  final case class PartyToParticipantAuthorization(authorization: Option[AuthorizationData], side: RequestSide, party: String, participant: String, permission: ParticipantPermission) extends GeneratedMessage with Updatable[PartyToParticipantAuthorization] with Product with Serializable
    side

    * The request side of this transaction A party to participant mapping can map a party from one namespace on a participant from another namespace. Such a mapping needs to be authorized by both namespace keys. If the namespace is the same, we use RequestSide.Both and collapse into a single transaction. Otherwise, From needs to be signed by a namespace key of the party and To needs to be signed by a namespace key of the participant.

    party

    The unique identifier of the party

    participant

    The unique identifier of the participant

    permission

    The permission of the participant that will allow him to act on behalf of the party.

    Annotations

    @SerialVersionUID()

42.  final case class SignedLegalIdentityClaimAuthorization(authorization: Option[AuthorizationData], claim: Option[SignedLegalIdentityClaim]) extends GeneratedMessage with Updatable[SignedLegalIdentityClaimAuthorization] with Product with Serializable

    Annotations

    @SerialVersionUID()

43.  final case class SignedLegalIdentityClaimGeneration(request: Request) extends GeneratedMessage with Updatable[SignedLegalIdentityClaimGeneration] with Product with Serializable

    Annotations

    @SerialVersionUID()

44.  final case class SignedTopologyTransactionAddition(serialized: ByteString) extends GeneratedMessage with Updatable[SignedTopologyTransactionAddition] with Product with Serializable

    Annotations

    @SerialVersionUID()

45.  final case class VettedPackagesAuthorization(authorization: Option[AuthorizationData], participant: String, packageIds: Seq[String]) extends GeneratedMessage with Updatable[VettedPackagesAuthorization] with Product with Serializable

    Annotations

    @SerialVersionUID()