Type Members

1.  final case class AcceptAgreementRequest(domainAlias: String, agreementId: String) extends GeneratedMessage with Updatable[AcceptAgreementRequest] with Product with Serializable

   Annotations

   @SerialVersionUID()

2.  final case class AcceptAgreementResponse() extends GeneratedMessage with Updatable[AcceptAgreementResponse] with Product with Serializable

   Annotations

   @SerialVersionUID()

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

   TODO(i14441): Remove deprecated ACS download / upload functionality

   TODO(i14441): Remove deprecated ACS download / upload functionality

   chunk

   a chunk of the acs snapshot download

   Annotations

   @SerialVersionUID()

4.  final case class ActiveContract(protocolVersion: Int, domainId: String, contract: ByteString) extends GeneratedMessage with Updatable[ActiveContract] with Product with Serializable

   Annotations

   @SerialVersionUID()

5.  final case class AdminTransferInRequest(submittingPartyId: String, targetDomain: String, transferId: Option[TransferId], applicationId: String, submissionId: String, workflowId: String, commandId: String) extends GeneratedMessage with Updatable[AdminTransferInRequest] with Product with Serializable
   submissionId

   optional

   workflowId

   optional

   commandId

   optional

   Annotations

   @SerialVersionUID()

6.  final case class AdminTransferInResponse() extends GeneratedMessage with Updatable[AdminTransferInResponse] with Product with Serializable

   Annotations

   @SerialVersionUID()

7.  final case class AdminTransferOutRequest(submittingParty: String, contractId: String, originDomain: String, targetDomain: String, applicationId: String, submissionId: String, workflowId: String, commandId: String) extends GeneratedMessage with Updatable[AdminTransferOutRequest] with Product with Serializable
   submissionId

   optional

   workflowId

   optional

   commandId

   optional

   Annotations

   @SerialVersionUID()

8.  final case class AdminTransferOutResponse(transferId: Option[TransferId]) extends GeneratedMessage with Updatable[AdminTransferOutResponse] with Product with Serializable

   Annotations

   @SerialVersionUID()

9.  final case class AdminTransferSearchQuery(searchDomain: String, filterOriginDomain: String, filterTimestamp: Option[Timestamp], filterSubmittingParty: String, limit: Long) extends GeneratedMessage with Updatable[AdminTransferSearchQuery] with Product with Serializable
   filterOriginDomain

   exact match if non-empty

   filterTimestamp

   optional; exact match if set

   Annotations

   @SerialVersionUID()

10.  final case class AdminTransferSearchResponse(results: Seq[TransferSearchResult]) extends GeneratedMessage with Updatable[AdminTransferSearchResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

11.  final case class Agreement(id: String, text: String) extends GeneratedMessage with Updatable[Agreement] with Product with Serializable

    Annotations

    @SerialVersionUID()

12.  final case class ConnectDomainRequest(domainAlias: String, retry: Boolean) extends GeneratedMessage with Updatable[ConnectDomainRequest] with Product with Serializable
    retry

    if retry is set to true, we will keep on retrying if the domain is unavailable

    Annotations

    @SerialVersionUID()

13.  final case class ConnectDomainResponse(connectedSuccessfully: Boolean) extends GeneratedMessage with Updatable[ConnectDomainResponse] with Product with Serializable
    connectedSuccessfully

    true if the domain is connected, false if the domain is offline, exception on any other error

    Annotations

    @SerialVersionUID()

14.  final case class DarDescription(hash: String, name: String) extends GeneratedMessage with Updatable[DarDescription] with Product with Serializable

    Annotations

    @SerialVersionUID()

15.  final case class DisconnectDomainRequest(domainAlias: String) extends GeneratedMessage with Updatable[DisconnectDomainRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

16.  final case class DisconnectDomainResponse() extends GeneratedMessage with Updatable[DisconnectDomainResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

17.  final case class DomainConnectionConfig(domainAlias: String, sequencerConnections: Seq[SequencerConnection], manualConnect: Boolean, domainId: String, priority: Int, initialRetryDelay: Option[Duration], maxRetryDelay: Option[Duration], timeTracker: Option[DomainTimeTrackerConfig], sequencerTrustThreshold: Int) extends GeneratedMessage with Updatable[DomainConnectionConfig] with Product with Serializable
    domainAlias

    participant local identifier of the target domain

    sequencerConnections

    connection information to sequencer

    manualConnect

    if false, then domain needs to be manually connected to (default false)

    domainId

    optional domainId (if TLS isn't to be trusted)

    priority

    optional. Influences whether the participant submits to this domain, if several domains are eligible

    initialRetryDelay

    initial delay before an attempt to reconnect to the sequencer

    maxRetryDelay

    maximum delay before an attempt to reconnect to the sequencer

    timeTracker

    configuration for how time is tracked and requested on this domain

    sequencerTrustThreshold

    This field determines the minimum level of agreement, or consensus, required among the sequencers before a message is considered reliable and accepted by the system. The value set here should not be zero. However, to maintain backward compatibility with older clients, a zero value is interpreted as equivalent to the size of sequencer_connections.

    Annotations

    @SerialVersionUID()

18.  final case class DownloadRequest(parties: Seq[String], filterDomainId: String, timestamp: Option[Timestamp], protocolVersion: String, chunkSize: Option[Int], gzipFormat: Boolean, contractDomainRenames: Map[String, String], partiesOffboarding: Boolean) extends GeneratedMessage with Updatable[DownloadRequest] with Product with Serializable

    TODO(i14441): Remove deprecated ACS download / upload functionality

    TODO(i14441): Remove deprecated ACS download / upload functionality

    filterDomainId

    optional; exact match if set

    timestamp

    optional; take acs state for this timestamp

    protocolVersion

    optional; version of serialization to use

    chunkSize

    Size of the byte chunks to stream back. Defaults to 2MB (half of the default gRPC max message size)

    contractDomainRenames

    Optional mapping from one domain id to another to rename the associated domain of contracts in the export NOTE: This is not a proper domain migration of contracts.

    partiesOffboarding

    true if the parties will be offboarded after the replication (party migration)

    Annotations

    @SerialVersionUID()

19.  final case class ExportAcsRequest(parties: Seq[String], filterDomainId: String, timestamp: Option[Timestamp], contractDomainRenames: Map[String, TargetDomain], partiesOffboarding: Boolean) extends GeneratedMessage with Updatable[ExportAcsRequest] with Product with Serializable
    filterDomainId

    optional; exact match if set

    timestamp

    optional; take acs state for this timestamp

    contractDomainRenames

    Optional mapping from one domain id to another to rename the associated domain of contracts in the export NOTE: This is not a proper domain migration of contracts.

    partiesOffboarding

    true if the parties will be offboarded after the replication (party migration)

    Annotations

    @SerialVersionUID()

20.  final case class ExportAcsResponse(chunk: ByteString) extends GeneratedMessage with Updatable[ExportAcsResponse] with Product with Serializable
    chunk

    a chunk of the acs snapshot download

    Annotations

    @SerialVersionUID()

21.  final case class GetAgreementRequest(domainAlias: String) extends GeneratedMessage with Updatable[GetAgreementRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

22.  final case class GetAgreementResponse(domainId: String, agreement: Option[Agreement], accepted: Boolean) extends GeneratedMessage with Updatable[GetAgreementResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

23.  final case class GetDarRequest(hash: String) extends GeneratedMessage with Updatable[GetDarRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

24.  final case class GetDarResponse(data: ByteString, name: String) extends GeneratedMessage with Updatable[GetDarResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

25.  final case class GetDomainIdRequest(domainAlias: String) extends GeneratedMessage with Updatable[GetDomainIdRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

26.  final case class GetDomainIdResponse(domainId: String) extends GeneratedMessage with Updatable[GetDomainIdResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

27.  final case class GetSafePruningOffsetRequest(beforeOrAt: Option[Timestamp], ledgerEnd: String) extends GeneratedMessage with Updatable[GetSafePruningOffsetRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

28.  final case class GetSafePruningOffsetResponse(response: Response) extends GeneratedMessage with Updatable[GetSafePruningOffsetResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

29.  final case class IgnoreEventsRequest(domainId: String, fromInclusive: Long, toInclusive: Long, force: Boolean) extends GeneratedMessage with Updatable[IgnoreEventsRequest] with Product with Serializable
    fromInclusive

    sequencer counter of the first event to ignore

    toInclusive

    sequencer counter of the last event to ignore

    force

    allow to proceed even if some clean events have sequencer counter greater or equal than from_inclusive

    Annotations

    @SerialVersionUID()

30.  final case class IgnoreEventsResponse() extends GeneratedMessage with Updatable[IgnoreEventsResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

31.  final case class ImportAcsRequest(acsSnapshot: ByteString, workflowIdPrefix: String, onboardedParties: Seq[String]) extends GeneratedMessage with Updatable[ImportAcsRequest] with Product with Serializable
    onboardedParties

    Some checks rely on the parties hosted on the participant. While this information is usually derived from a recent topology snapshot, it is not suited for party replication because the party is enabled on the target participant only after the acs import is done. In this case, the list of onboarded parties can be passed explicitly.

    Annotations

    @SerialVersionUID()

32.  final case class ImportAcsResponse() extends GeneratedMessage with Updatable[ImportAcsResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

33.  final case class ListConfiguredDomainsRequest() extends GeneratedMessage with Updatable[ListConfiguredDomainsRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

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

    Annotations

    @SerialVersionUID()

35.  final case class ListConnectedDomainsRequest() extends GeneratedMessage with Updatable[ListConnectedDomainsRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

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

    Annotations

    @SerialVersionUID()

37.  final case class ListDarContentsRequest(darId: String) extends GeneratedMessage with Updatable[ListDarContentsRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

38.  final case class ListDarContentsResponse(description: String, main: String, packages: Seq[String], dependencies: Seq[String]) extends GeneratedMessage with Updatable[ListDarContentsResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

39.  final case class ListDarsRequest(limit: Int) extends GeneratedMessage with Updatable[ListDarsRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

40.  final case class ListDarsResponse(dars: Seq[DarDescription]) extends GeneratedMessage with Updatable[ListDarsResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

41.  final case class ListPackageContentsRequest(packageId: String) extends GeneratedMessage with Updatable[ListPackageContentsRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

42.  final case class ListPackageContentsResponse(modules: Seq[ModuleDescription]) extends GeneratedMessage with Updatable[ListPackageContentsResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

43.  final case class ListPackagesRequest(limit: Int) extends GeneratedMessage with Updatable[ListPackagesRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

44.  final case class ListPackagesResponse(packageDescriptions: Seq[PackageDescription]) extends GeneratedMessage with Updatable[ListPackagesResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

45.  final case class LookupContractDomain() extends GeneratedMessage with Updatable[LookupContractDomain] with Product with Serializable

    Annotations

    @SerialVersionUID()

46.  final case class LookupOffsetByIndex() extends GeneratedMessage with Updatable[LookupOffsetByIndex] with Product with Serializable

    Annotations

    @SerialVersionUID()

47.  final case class LookupOffsetByTime() extends GeneratedMessage with Updatable[LookupOffsetByTime] with Product with Serializable

    Annotations

    @SerialVersionUID()

48.  final case class LookupTransactionDomain() extends GeneratedMessage with Updatable[LookupTransactionDomain] with Product with Serializable

    Annotations

    @SerialVersionUID()

49.  final case class MigrateDomainRequest(sourceAlias: String, targetDomainConnectionConfig: Option[DomainConnectionConfig], force: Option[Boolean]) extends GeneratedMessage with Updatable[MigrateDomainRequest] with Product with Serializable
    sourceAlias

    the alias of the source domain Required

    targetDomainConnectionConfig

    the target domain connection configuration Required

    force

    Whether to force the migration in spite of risking a potential ledger fork Optional, defaults to false

    Annotations

    @SerialVersionUID()

50.  final case class MigrateDomainResponse() extends GeneratedMessage with Updatable[MigrateDomainResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

51.  final case class ModifyDomainRequest(modify: Option[DomainConnectionConfig]) extends GeneratedMessage with Updatable[ModifyDomainRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

52.  final case class ModifyDomainResponse() extends GeneratedMessage with Updatable[ModifyDomainResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

53.  final case class ModuleDescription(name: String) extends GeneratedMessage with Updatable[ModuleDescription] with Product with Serializable

    Annotations

    @SerialVersionUID()

54.  final case class PackageDescription(packageId: String, sourceDescription: String) extends GeneratedMessage with Updatable[PackageDescription] with Product with Serializable

    Annotations

    @SerialVersionUID()

55.  final case class PingFailure() extends GeneratedMessage with Updatable[PingFailure] with Product with Serializable

    Annotations

    @SerialVersionUID()

56.  final case class PingRequest(targetParties: Seq[String], validators: Seq[String], timeoutMilliseconds: Long, levels: Long, gracePeriodMilliseconds: Long, workflowId: String, id: String) extends GeneratedMessage with Updatable[PingRequest] with Product with Serializable
    workflowId

    optional

    id

    optional UUID to be used for ping test

    Annotations

    @SerialVersionUID()

57.  final case class PingResponse(response: Response) extends GeneratedMessage with Updatable[PingResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

58.  final case class PingSuccess(pingTime: Long, responder: String) extends GeneratedMessage with Updatable[PingSuccess] with Product with Serializable

    Annotations

    @SerialVersionUID()

59.  final case class PruneRequest(pruneUpTo: String) extends GeneratedMessage with Updatable[PruneRequest] with Product with Serializable
    pruneUpTo

    Inclusive offset up to which the ledger is to be pruned.

    Annotations

    @SerialVersionUID()

60.  final case class PruneResponse() extends GeneratedMessage with Updatable[PruneResponse] with Product with Serializable

    Empty for now, but may contain fields in the future

    Empty for now, but may contain fields in the future

    Annotations

    @SerialVersionUID()

61.  final case class PurgeContractsRequest(domain: String, contractIds: Seq[String], ignoreAlreadyPurged: Boolean, offboardedParties: Seq[String]) extends GeneratedMessage with Updatable[PurgeContractsRequest] with Product with Serializable
    domain

    Alias of the domain on which the contracts are currently assigned

    contractIds

    Contracts to be purged

    ignoreAlreadyPurged

    If true, will ignore already purged contract; if false, will return an error if a contract is already purged

    offboardedParties

    Some checks rely on the parties hosted on the participant. While this information is usually derived from a recent topology snapshot, it is not suited for party removal/offboarding because the party is removed from the topology snapshot before the contracts are purged. In this case, the list of offboarded parties can be passed explicitly.

    Annotations

    @SerialVersionUID()

62.  final case class PurgeContractsResponse() extends GeneratedMessage with Updatable[PurgeContractsResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

63.  final case class PurgeDeactivatedDomainRequest(domainAlias: String) extends GeneratedMessage with Updatable[PurgeDeactivatedDomainRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

64.  final case class PurgeDeactivatedDomainResponse() extends GeneratedMessage with Updatable[PurgeDeactivatedDomainResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

65.  final case class ReconnectDomainsRequest(ignoreFailures: Boolean) extends GeneratedMessage with Updatable[ReconnectDomainsRequest] with Product with Serializable
    ignoreFailures

    if set to true, the connection attempt will succeed even if one of the connection attempts failed

    Annotations

    @SerialVersionUID()

66.  final case class ReconnectDomainsResponse() extends GeneratedMessage with Updatable[ReconnectDomainsResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

67.  final case class RegisterDomainRequest(add: Option[DomainConnectionConfig]) extends GeneratedMessage with Updatable[RegisterDomainRequest] with Product with Serializable

    * Register and optionally auto-connect to a new domain

    * Register and optionally auto-connect to a new domain

    Annotations

    @SerialVersionUID()

68.  final case class RegisterDomainResponse() extends GeneratedMessage with Updatable[RegisterDomainResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

69.  final case class RemoveDarRequest(darHash: String) extends GeneratedMessage with Updatable[RemoveDarRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

70.  final case class RemoveDarResponse(success: Option[Empty]) extends GeneratedMessage with Updatable[RemoveDarResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

71.  final case class RemovePackageRequest(packageId: String, force: Boolean) extends GeneratedMessage with Updatable[RemovePackageRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

72.  final case class RemovePackageResponse(success: Option[Empty]) extends GeneratedMessage with Updatable[RemovePackageResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

73.  final case class ResourceLimits(maxDirtyRequests: Int, maxRate: Int, maxBurstFactor: Double) extends GeneratedMessage with Updatable[ResourceLimits] with Product with Serializable
    maxDirtyRequests

    The maximum number of dirty requests. A negative value indicates that there is no limit.

    maxRate

    The maximum rate of command submissions through the ledger api. A negative value indicates that there is no limit.

    maxBurstFactor

    The maximum burst acceptable (factor > 0) before steady state throtteling kicks in.

    Annotations

    @SerialVersionUID()

74.  final case class SetPartyDisplayNameRequest(partyId: String, displayName: String) extends GeneratedMessage with Updatable[SetPartyDisplayNameRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

75.  final case class SetPartyDisplayNameResponse() extends GeneratedMessage with Updatable[SetPartyDisplayNameResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

76.  final case class SetPassive() extends GeneratedMessage with Updatable[SetPassive] with Product with Serializable

    Annotations

    @SerialVersionUID()

77.  final case class UnignoreEventsRequest(domainId: String, fromInclusive: Long, toInclusive: Long, force: Boolean) extends GeneratedMessage with Updatable[UnignoreEventsRequest] with Product with Serializable
    fromInclusive

    sequencer counter of the first event to unignore

    toInclusive

    sequencer counter of the last event to unignore

    force

    allow to proceed even if some clean events have sequencer counter greater or equal than from_inclusive

    Annotations

    @SerialVersionUID()

78.  final case class UnignoreEventsResponse() extends GeneratedMessage with Updatable[UnignoreEventsResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

79.  final case class UnvetDarRequest(darHash: String) extends GeneratedMessage with Updatable[UnvetDarRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

80.  final case class UnvetDarResponse() extends GeneratedMessage with Updatable[UnvetDarResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

81.  final case class UploadDarRequest(data: ByteString, filename: String, vetAllPackages: Boolean, synchronizeVetting: Boolean) extends GeneratedMessage with Updatable[UploadDarRequest] with Product with Serializable
    vetAllPackages

    if set to true, we'll register the vetting topology transactions with the idm

    synchronizeVetting

    if set to true, we'll wait until the vetting transaction has been observed by this participant on all connected domains

    Annotations

    @SerialVersionUID()

82.  final case class UploadDarResponse(value: Value) extends GeneratedMessage with Updatable[UploadDarResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

83.  final case class UploadRequest(acsSnapshot: ByteString, gzipFormat: Boolean) extends GeneratedMessage with Updatable[UploadRequest] with Product with Serializable

    TODO(i14441): Remove deprecated ACS download / upload functionality

    TODO(i14441): Remove deprecated ACS download / upload functionality

    Annotations

    @SerialVersionUID()

84.  final case class UploadResponse() extends GeneratedMessage with Updatable[UploadResponse] with Product with Serializable

    TODO(i14441): Remove deprecated ACS download / upload functionality

    TODO(i14441): Remove deprecated ACS download / upload functionality

    Annotations

    @SerialVersionUID()

85.  final case class ValidateDarRequest(data: ByteString, filename: String) extends GeneratedMessage with Updatable[ValidateDarRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

86.  final case class ValidateDarResponse(hash: String) extends GeneratedMessage with Updatable[ValidateDarResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

87.  final case class VetDarRequest(darHash: String, synchronize: Boolean) extends GeneratedMessage with Updatable[VetDarRequest] with Product with Serializable
    synchronize

    if set to true, the API call waits until the vetting transaction has been observed by this participant on all connected domains.

    Annotations

    @SerialVersionUID()

88.  final case class VetDarResponse() extends GeneratedMessage with Updatable[VetDarResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()