Packages

package v30

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. Protected

Type Members

  1. final case class ActiveContract(activeContract: ByteString) extends GeneratedMessage with Updatable[ActiveContract] with Product with Serializable

    Schema definition for the exported active contract

    Schema definition for the exported active contract

    activeContract

    Opaque active contract, assumed to be the bytes of a LAPI active contract Required

    Annotations
    @SerialVersionUID()
  2. final case class ActiveContractOld(synchronizerId: String, contract: Option[Contract], reassignmentCounter: Long) extends GeneratedMessage with Updatable[ActiveContractOld] with Product with Serializable

    TODO(#24610) – Remove; replaced by the new ActiveContract that uses LAPI active contract Schema definition for the exported ACS snapshot

    TODO(#24610) – Remove; replaced by the new ActiveContract that uses LAPI active contract Schema definition for the exported ACS snapshot

    synchronizerId

    The ID of the synchronizer where the contract was assigned at the time of the export Required

    contract

    The contract and its associated metadata Required

    reassignmentCounter

    The number of times the contract has been reassigned at the time of the export Required

    Annotations
    @SerialVersionUID()
  3. final case class AddPartyAsyncRequest(partyId: String, synchronizerId: String, sourceParticipantUid: String, serial: Int) extends GeneratedMessage with Updatable[AddPartyAsyncRequest] with Product with Serializable

    partyId

    The party to replicate Required

    synchronizerId

    The synchronizer in which to replicate the party Required

    sourceParticipantUid

    Optionally, the source participant already hosting the party Required if the party is already hosted on multiple participants.

    serial

    Optionally, the topology serial number of this request (auto-determined if omitted) NOTE: omitting the serial MAY end up overwriting previous mappings processed concurrently. To avoid such cases, first read the PartyToParticipant state using the TopologyManagerReadService and update the mappings accordingly, incrementing the serial by one and setting it explicitly.

    Annotations
    @SerialVersionUID()
  4. final case class AddPartyAsyncResponse(addPartyRequestId: String) extends GeneratedMessage with Updatable[AddPartyAsyncResponse] with Product with Serializable

    addPartyRequestId

    The identifier used to uniquely track the add party request.

    Annotations
    @SerialVersionUID()
  5. final case class ChangeAssignationRequest(sourceSynchronizerAlias: String, targetSynchronizerAlias: String, skipInactive: Boolean, contracts: Seq[ChangeAssignationRequest.Contract]) extends GeneratedMessage with Updatable[ChangeAssignationRequest] with Product with Serializable

    sourceSynchronizerAlias

    Alias of the synchronizer to which the contracts are currently assigned Required

    targetSynchronizerAlias

    New assignation Required

    skipInactive

    Whether to skip inactive contracts. Default: true.

    Annotations
    @SerialVersionUID()
  6. final case class ChangeAssignationResponse() extends GeneratedMessage with Updatable[ChangeAssignationResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  7. final case class CommitmentContract(cid: ByteString, activeOnExpectedSynchronizer: Boolean, serializedContract: Option[Contract], states: Seq[SynchronizerState]) extends GeneratedMessage with Updatable[CommitmentContract] with Product with Serializable
    Annotations
    @SerialVersionUID()
  8. final case class CommitmentContractMeta(cid: ByteString, reassignmentCounter: Long) extends GeneratedMessage with Updatable[CommitmentContractMeta] with Product with Serializable

    Contract ids (cids) need to be authenticated, otherwise the cid does not uniquely identify the stakeholders and the contract hash

    Contract ids (cids) need to be authenticated, otherwise the cid does not uniquely identify the stakeholders and the contract hash

    Annotations
    @SerialVersionUID()
  9. final case class ConnectSynchronizerRequest(config: Option[SynchronizerConnectionConfig], sequencerConnectionValidation: SequencerConnectionValidation) extends GeneratedMessage with Updatable[ConnectSynchronizerRequest] with Product with Serializable

    sequencerConnectionValidation

    Determines how well the provided sequencer connections should be validated before they are persisted. The more paranoid the validation, the higher the chance of the command failing, as it will require the sequencer to be online and responsive.

    Annotations
    @SerialVersionUID()
  10. final case class ConnectSynchronizerResponse(connectedSuccessfully: Boolean) extends GeneratedMessage with Updatable[ConnectSynchronizerResponse] with Product with Serializable

    connectedSuccessfully

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

    Annotations
    @SerialVersionUID()
  11. final case class ConnectedSynchronizer(synchronizerId: String, health: Health) extends GeneratedMessage with Updatable[ConnectedSynchronizer] with Product with Serializable
    Annotations
    @SerialVersionUID()
  12. final case class Contract(contractId: String, rawContractInstance: ByteString, metadata: Option[Metadata], ledgerCreateTime: Option[Timestamp], contractSalt: Option[Salt]) extends GeneratedMessage with Updatable[Contract] with Product with Serializable

    ledgerCreateTime

    in microseconds of UTC time since Unix epoch

    contractSalt

    optional

    Annotations
    @SerialVersionUID()
  13. sealed abstract class ContractIdImportMode extends GeneratedEnum
  14. final case class ContractState() extends GeneratedMessage with Updatable[ContractState] with Product with Serializable
    Annotations
    @SerialVersionUID()
  15. final case class CountInFlightRequest(synchronizerId: String) extends GeneratedMessage with Updatable[CountInFlightRequest] with Product with Serializable

    synchronizerId

    the synchronizer to query for pending submissions and in-flight transactions

    Annotations
    @SerialVersionUID()
  16. final case class CountInFlightResponse(pendingSubmissions: Int, pendingTransactions: Int) extends GeneratedMessage with Updatable[CountInFlightResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  17. final case class CounterParticipantInfo(counterParticipantUid: String, synchronizerId: String, intervalsBehind: Long, behindSince: Option[Duration], asOfSequencingTimestamp: Option[Timestamp]) extends GeneratedMessage with Updatable[CounterParticipantInfo] with Product with Serializable

    intervalsBehind

    MaxInt(2147483647) means that the counter-participant never sent a commitment

    behindSince

    how long time the corresponding intervals correlate to (Timestamp in the future means it has never sent a commitment) this is to help debugging, especially in the case where the reconciliation interval have been changed. for example, if we have a counter participant that is three intervals behind, and each interval is one minute. if the reconciliation interval is changed to 24 hours, then it might look like that counter-participant is three days behind (when it is actually only three minutes behind).

    asOfSequencingTimestamp

    the "as of" sequencing timestamp at which this information was obtained

    Annotations
    @SerialVersionUID()
  18. final case class DarDescription(main: String, name: String, version: String, description: String) extends GeneratedMessage with Updatable[DarDescription] with Product with Serializable
    Annotations
    @SerialVersionUID()
  19. final case class DisconnectAllSynchronizersRequest() extends GeneratedMessage with Updatable[DisconnectAllSynchronizersRequest] with Product with Serializable
    Annotations
    @SerialVersionUID()
  20. final case class DisconnectAllSynchronizersResponse() extends GeneratedMessage with Updatable[DisconnectAllSynchronizersResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  21. final case class DisconnectSynchronizerRequest(synchronizerAlias: String) extends GeneratedMessage with Updatable[DisconnectSynchronizerRequest] with Product with Serializable
    Annotations
    @SerialVersionUID()
  22. final case class DisconnectSynchronizerResponse() extends GeneratedMessage with Updatable[DisconnectSynchronizerResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  23. final case class ExportAcsAtTimestampRequest(partyIds: Seq[String], synchronizerId: String, topologyTransactionEffectiveTime: Option[Timestamp]) extends GeneratedMessage with Updatable[ExportAcsAtTimestampRequest] with Product with Serializable

    partyIds

    The identifiers of the parties for which the Active Contract Set (ACS) will be exported. This field must contain at least one party ID. Required

    synchronizerId

    The identifier of the synchronizer. This is used to filter contracts and topology transactions on the ledger. Required

    topologyTransactionEffectiveTime

    The effective time of a specific topology transaction. The system will locate the topology transaction on the ledger with this effective time and the synchronizer identifier. And then take an ACS snapshot at the corresponding ledger offset. Required

    Annotations
    @SerialVersionUID()
  24. final case class ExportAcsAtTimestampResponse(chunk: ByteString) extends GeneratedMessage with Updatable[ExportAcsAtTimestampResponse] with Product with Serializable

    chunk

    A chunk of the Active Contract Set (ACS) snapshot. This response is streamed, with each message containing a portion of the complete ACS data. The raw binary data within each chunk consists of Ledger API active contract messages, specifically wrapped in v30.active_contract.ActiveContract messages. However, a single chunk does not necessarily contain exactly one complete message. This field will be populated in each streamed response. Required

    Annotations
    @SerialVersionUID()
  25. final case class ExportAcsOldRequest(parties: Seq[String], filterSynchronizerId: String, timestamp: Option[Timestamp], contractSynchronizerRenames: Map[String, TargetSynchronizer], force: Boolean, partiesOffboarding: Boolean) extends GeneratedMessage with Updatable[ExportAcsOldRequest] with Product with Serializable

    parties

    The parties for which the ACS should be exported Required

    filterSynchronizerId

    The IDs of the synchronizers to filter the contracts by Optional, if set the contracts will be filtered by the exact match of the ID of the synchronizer to which it's assigned optional; exact match if set

    timestamp

    The timestamp at which the ACS should be valid. If provided, it will be checked that the ACS is available at the given timestamp (i.e. the timestamp is considered clean and the ACS has not been pruned). Optional, if missing the latest clean timestamp will be used

    contractSynchronizerRenames

    Mapping from one synchronizer id and protocol version. If provided, the contracts currently assigned to the synchronizer ID in the key will be assigned to the synchronizer id and protocol version in the value. This is not a proper synchronizer migration of contracts and it's supposed to be used only in exceptional cases. Optional, if not provided the contracts will be exported with the same synchronizer id as they are currently assigned

    force

    If true, do not check whether the provided timestamp is clean (see timestamp field). NOT FOR PRODUCTION USE. For this option to yield a consistent snapshot, you need to wait at least confirmationResponseTimeout + mediatorReactionTimeout after the last submitted request. Recommended value is false

    partiesOffboarding

    true if the parties will be offboarded after the replication (party migration) Recommended value is false

    Annotations
    @SerialVersionUID()
  26. final case class ExportAcsOldResponse(chunk: ByteString) extends GeneratedMessage with Updatable[ExportAcsOldResponse] with Product with Serializable

    chunk

    The raw binary of the ACS snapshot to be imported This is meant to be streamed and every message should be a chunk of the snapshot Required

    Annotations
    @SerialVersionUID()
  27. final case class ExportAcsRequest(partyIds: Seq[String], synchronizerId: String, ledgerOffset: Long, contractSynchronizerRenames: Map[String, ExportAcsTargetSynchronizer]) extends GeneratedMessage with Updatable[ExportAcsRequest] with Product with Serializable

    partyIds

    The identifiers of the parties for which the Active Contract Set (ACS) will be exported. This field must contain at least one party ID. Required

    synchronizerId

    The identifier of the synchronizer to filter contracts. Optional. If provided, only contracts assigned to a synchronizer with this exact ID will be included in the exported ACS. If not set (empty string), all contracts for the specified parties will be included. Optional; filters by exact synchronizer ID if set

    ledgerOffset

    The ledger offset at which the ACS snapshot should be taken. This determines the point in the ledger history from which the active contracts will be retrieved. Required

    contractSynchronizerRenames

    A mapping to modify the synchronizer assignment of contracts in the exported ACS. Note: This mapping is not a proper contract reassignment. That is no actual reassignment happens, and thus the reassignment counter is not increased. Optional. If not provided (empty map), the contracts in the exported ACS will retain their original synchronizer assignments.

    Annotations
    @SerialVersionUID()
  28. final case class ExportAcsResponse(chunk: ByteString) extends GeneratedMessage with Updatable[ExportAcsResponse] with Product with Serializable

    chunk

    A chunk of the Active Contract Set (ACS) snapshot. This response is streamed, with each message containing a portion of the complete ACS data. The raw binary data within each chunk consists of Ledger API active contract messages, specifically wrapped in v30.active_contract.ActiveContract messages. However, a single chunk does not necessarily contain exactly one complete message. This field will be populated in each streamed response. Required

    Annotations
    @SerialVersionUID()
  29. final case class ExportAcsTargetSynchronizer(targetSynchronizerId: String) extends GeneratedMessage with Updatable[ExportAcsTargetSynchronizer] with Product with Serializable

    targetSynchronizerId

    The identifier of the synchronizer to which contracts should be assigned upon exporting the Active Contract Set (ACS). Required.

    Annotations
    @SerialVersionUID()
  30. final case class GetAddPartyStatusRequest(addPartyRequestId: String) extends GeneratedMessage with Updatable[GetAddPartyStatusRequest] with Product with Serializable

    addPartyRequestId

    The add party request ID returned by AddPartyAsync Required

    Annotations
    @SerialVersionUID()
  31. final case class GetAddPartyStatusResponse(partyId: String, synchronizerId: String, sourceParticipantUid: String, targetParticipantUid: String, status: Option[Status]) extends GeneratedMessage with Updatable[GetAddPartyStatusResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  32. final case class GetConfigForSlowCounterParticipantsRequest(synchronizerIds: Seq[String]) extends GeneratedMessage with Updatable[GetConfigForSlowCounterParticipantsRequest] with Product with Serializable

    synchronizerIds

    filters by synchronizers

    Annotations
    @SerialVersionUID()
  33. final case class GetConfigForSlowCounterParticipantsResponse(configs: Seq[SlowCounterParticipantSynchronizerConfig]) extends GeneratedMessage with Updatable[GetConfigForSlowCounterParticipantsResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  34. final case class GetDarContentsRequest(mainPackageId: String) extends GeneratedMessage with Updatable[GetDarContentsRequest] with Product with Serializable
    Annotations
    @SerialVersionUID()
  35. final case class GetDarContentsResponse(description: Option[DarDescription], packages: Seq[PackageDescription]) extends GeneratedMessage with Updatable[GetDarContentsResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  36. final case class GetDarRequest(mainPackageId: String) extends GeneratedMessage with Updatable[GetDarRequest] with Product with Serializable
    Annotations
    @SerialVersionUID()
  37. final case class GetDarResponse(payload: ByteString, data: Option[DarDescription]) extends GeneratedMessage with Updatable[GetDarResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  38. final case class GetHighestOffsetByTimestampRequest(synchronizerId: String, timestamp: Option[Timestamp], force: Boolean) extends GeneratedMessage with Updatable[GetHighestOffsetByTimestampRequest] with Product with Serializable

    Requests the highest ledger offset among all events belonging to the synchronizer (synchronizer_id) that have a record time before or at the given timestamp.

    Requests the highest ledger offset among all events belonging to the synchronizer (synchronizer_id) that have a record time before or at the given timestamp.

    This endpoint features a force message field. This is intended for disaster recovery scenarios only.

    synchronizerId

    The identifier of the synchronizer. Required

    timestamp

    The requested timestamp for which a ledger offset should be found. Required

    force

    If true, return the highest known ledger offset with a record time before or at the specified timestamp even if higher offsets with a record time before or at timestamp can be created in the future. Required, defaults to false.

    Annotations
    @SerialVersionUID()
  39. final case class GetHighestOffsetByTimestampResponse(ledgerOffset: Long) extends GeneratedMessage with Updatable[GetHighestOffsetByTimestampResponse] with Product with Serializable

    ledgerOffset

    The highest ledger offset among events that have their record time before or at the requested timestamp. An error when no such offset (yet) exists. Required

    Annotations
    @SerialVersionUID()
  40. final case class GetIntervalsBehindForCounterParticipantsRequest(counterParticipantUids: Seq[String], synchronizerIds: Seq[String], threshold: Option[Long]) extends GeneratedMessage with Updatable[GetIntervalsBehindForCounterParticipantsRequest] with Product with Serializable

    counterParticipantUids

    if empty, all counter-participants are considered

    synchronizerIds

    if empty, all synchronizers are considered

    threshold

    if set, only counter-participants that are behind by at least this number of intervals are returned

    Annotations
    @SerialVersionUID()
  41. final case class GetIntervalsBehindForCounterParticipantsResponse(intervalsBehind: Seq[CounterParticipantInfo]) extends GeneratedMessage with Updatable[GetIntervalsBehindForCounterParticipantsResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  42. final case class GetPackageContentsRequest(packageId: String) extends GeneratedMessage with Updatable[GetPackageContentsRequest] with Product with Serializable
    Annotations
    @SerialVersionUID()
  43. final case class GetPackageContentsResponse(description: Option[PackageDescription], modules: Seq[ModuleDescription], isUtilityPackage: Boolean, languageVersion: String) extends GeneratedMessage with Updatable[GetPackageContentsResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  44. final case class GetPackageReferencesRequest(packageId: String) extends GeneratedMessage with Updatable[GetPackageReferencesRequest] with Product with Serializable
    Annotations
    @SerialVersionUID()
  45. final case class GetPackageReferencesResponse(dars: Seq[DarDescription]) extends GeneratedMessage with Updatable[GetPackageReferencesResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  46. final case class GetResourceLimitsRequest() extends GeneratedMessage with Updatable[GetResourceLimitsRequest] with Product with Serializable
    Annotations
    @SerialVersionUID()
  47. final case class GetResourceLimitsResponse(currentLimits: Option[ResourceLimits]) extends GeneratedMessage with Updatable[GetResourceLimitsResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  48. final case class GetSafePruningOffsetRequest(beforeOrAt: Option[Timestamp], ledgerEnd: Long) extends GeneratedMessage with Updatable[GetSafePruningOffsetRequest] with Product with Serializable
    Annotations
    @SerialVersionUID()
  49. final case class GetSafePruningOffsetResponse(response: Response) extends GeneratedMessage with Updatable[GetSafePruningOffsetResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  50. final case class GetSynchronizerIdRequest(synchronizerAlias: String) extends GeneratedMessage with Updatable[GetSynchronizerIdRequest] with Product with Serializable
    Annotations
    @SerialVersionUID()
  51. final case class GetSynchronizerIdResponse(synchronizerId: String) extends GeneratedMessage with Updatable[GetSynchronizerIdResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  52. final case class IgnoreEventsRequest(synchronizerId: 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()
  53. final case class IgnoreEventsResponse() extends GeneratedMessage with Updatable[IgnoreEventsResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  54. final case class ImportAcsOldRequest(acsSnapshot: ByteString, workflowIdPrefix: String, allowContractIdSuffixRecomputation: Boolean) extends GeneratedMessage with Updatable[ImportAcsOldRequest] with Product with Serializable

    acsSnapshot

    The raw binary of the ACS snapshot to be imported Required

    workflowIdPrefix

    The synchronizer id prefix to be used for the imported contracts Optional, if not provided the service will generate a prefix

    allowContractIdSuffixRecomputation

    If false, the service will fail if any contract ID suffix doesn't match the scheme associated to the synchronizer where the contract is being assigned as a result of the import. If true, any contract ID suffix will be recomputed to match the scheme associated to the synchronizer. Recommended value is false

    Annotations
    @SerialVersionUID()
  55. final case class ImportAcsOldResponse(contractIdMapping: Map[String, String]) extends GeneratedMessage with Updatable[ImportAcsOldResponse] with Product with Serializable

    contractIdMapping

    Mapping from the old contract id to the new contract id

    Annotations
    @SerialVersionUID()
  56. final case class ImportAcsRequest(acsSnapshot: ByteString, workflowIdPrefix: String, contractIdSuffixRecomputationMode: ContractIdImportMode) extends GeneratedMessage with Updatable[ImportAcsRequest] with Product with Serializable

    acsSnapshot

    The raw binary of the ACS snapshot to be imported The binary contents does not align on individual active contracts! It may contain bytes that are part of an active contract, or include several active contracts - depending on how much data fits into the configured gRPC message size. Required

    workflowIdPrefix

    The synchronizer id prefix to be used for the imported contracts Optional, if not provided the service will generate a prefix

    contractIdSuffixRecomputationMode

    How contract ID should be evaluated upon import Required

    Annotations
    @SerialVersionUID()
  57. final case class ImportAcsResponse(contractIdMappings: Map[String, String]) extends GeneratedMessage with Updatable[ImportAcsResponse] with Product with Serializable

    contractIdMappings

    Maps old contract IDs to newly recomputed contract IDs iff the recomputation contract ID import mode has been selected, empty otherwise.

    Annotations
    @SerialVersionUID()
  58. final case class InspectCommitmentContractsRequest(cids: Seq[ByteString], expectedSynchronizerId: String, timestamp: Option[Timestamp], downloadPayload: Boolean) extends GeneratedMessage with Updatable[InspectCommitmentContractsRequest] with Product with Serializable

    The participant needs to be authorized to see the requested contracts, for example using JWT authorization

    The participant needs to be authorized to see the requested contracts, for example using JWT authorization

    cids

    the contracts whose state and payload we want to retrieve

    expectedSynchronizerId

    the synchronizer on which we expect the contracts to be active

    timestamp

    timestamp at which we retrieve the state of the contracts on the expected synchronizer

    downloadPayload

    whether to retrieve the payload of the contracts

    Annotations
    @SerialVersionUID()
  59. final case class InspectCommitmentContractsResponse(chunk: ByteString) extends GeneratedMessage with Updatable[InspectCommitmentContractsResponse] with Product with Serializable

    chunk

    commitment contracts

    Annotations
    @SerialVersionUID()
  60. final case class Interval(startTickExclusive: Option[Timestamp], endTickInclusive: Option[Timestamp]) extends GeneratedMessage with Updatable[Interval] with Product with Serializable

    timestamps *do fall* on commitment period boundaries/ticks

    timestamps *do fall* on commitment period boundaries/ticks

    Annotations
    @SerialVersionUID()
  61. final case class ListConnectedSynchronizersRequest() extends GeneratedMessage with Updatable[ListConnectedSynchronizersRequest] with Product with Serializable
    Annotations
    @SerialVersionUID()
  62. final case class ListConnectedSynchronizersResponse(connectedSynchronizers: Seq[Result]) extends GeneratedMessage with Updatable[ListConnectedSynchronizersResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  63. final case class ListDarsRequest(limit: Int, filterName: String) extends GeneratedMessage with Updatable[ListDarsRequest] with Product with Serializable
    Annotations
    @SerialVersionUID()
  64. final case class ListDarsResponse(dars: Seq[DarDescription]) extends GeneratedMessage with Updatable[ListDarsResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  65. final case class ListPackagesRequest(limit: Int, filterName: String) extends GeneratedMessage with Updatable[ListPackagesRequest] with Product with Serializable
    Annotations
    @SerialVersionUID()
  66. final case class ListPackagesResponse(packageDescriptions: Seq[PackageDescription]) extends GeneratedMessage with Updatable[ListPackagesResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  67. final case class ListRegisteredSynchronizersRequest() extends GeneratedMessage with Updatable[ListRegisteredSynchronizersRequest] with Product with Serializable
    Annotations
    @SerialVersionUID()
  68. final case class ListRegisteredSynchronizersResponse(results: Seq[Result]) extends GeneratedMessage with Updatable[ListRegisteredSynchronizersResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  69. final case class LogoutRequest(synchronizerAlias: String) extends GeneratedMessage with Updatable[LogoutRequest] with Product with Serializable
    Annotations
    @SerialVersionUID()
  70. final case class LogoutResponse() extends GeneratedMessage with Updatable[LogoutResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  71. final case class LookupOffsetByTimeRequest(timestamp: Option[Timestamp]) extends GeneratedMessage with Updatable[LookupOffsetByTimeRequest] with Product with Serializable

    timestamp

    the timestamp to look up the offset for

    Annotations
    @SerialVersionUID()
  72. final case class LookupOffsetByTimeResponse(offset: Option[Long]) extends GeneratedMessage with Updatable[LookupOffsetByTimeResponse] with Product with Serializable

    offset

    if specified, the absolute offset as an integer corresponding to the specified timestamp. if absent, no such offset exists.

    Annotations
    @SerialVersionUID()
  73. final case class LookupReceivedAcsCommitmentsRequest(timeRanges: Seq[SynchronizerTimeRange], counterParticipantUids: Seq[String], commitmentState: Seq[ReceivedCommitmentState], verbose: Boolean) extends GeneratedMessage with Updatable[LookupReceivedAcsCommitmentsRequest] with Product with Serializable

    list the commitments received from counter-participants optional filtering by synchronizer, time ranges, counter participants, commitment state and verbosity

    list the commitments received from counter-participants optional filtering by synchronizer, time ranges, counter participants, commitment state and verbosity

    timeRanges

    filter specific time ranges per synchronizer a synchronizer can appear multiple times with various time ranges, in which case we consider the union of the time ranges. return only the received commitments with an interval overlapping any of the given time ranges per synchronizer defaults: if empty, all synchronizers known to the participant are considered

    counterParticipantUids

    retrieve commitments received from specific counter participants if a specified counter participant is not a counter-participant in some synchronizer, we do not return it in the response an empty set means we return commitments received from all counter participants on the synchronizers matching the synchronizer filter.

    commitmentState

    filter by commitment state: only return commitments with the states below if no state is given, we return all commitments

    verbose

    include the actual commitment in the response

    Annotations
    @SerialVersionUID()
  74. final case class LookupReceivedAcsCommitmentsResponse(received: Seq[ReceivedAcsCommitmentPerSynchronizer]) extends GeneratedMessage with Updatable[LookupReceivedAcsCommitmentsResponse] with Product with Serializable

    Returns a sequence of commitments for each synchronizer.

    Returns a sequence of commitments for each synchronizer. Synchronizers should not repeat in the response, otherwise the caller considers the response invalid. If all commitments received on a synchronizer have been pruned, we return an error. No streaming, because a response with verbose mode on contains around 1kb to 3kb of data (depending on whether we ship the LtHash16 bytes directly or just a hash thereof). Therefore, 1000 commitments fit into a couple of MBs, and we can expect the gRPC admin API to handle messages of a couple of MBs. It is the application developer's job to find suitable filter ranges.

    Annotations
    @SerialVersionUID()
  75. final case class LookupSentAcsCommitmentsRequest(timeRanges: Seq[SynchronizerTimeRange], counterParticipantUids: Seq[String], commitmentState: Seq[SentCommitmentState], verbose: Boolean) extends GeneratedMessage with Updatable[LookupSentAcsCommitmentsRequest] with Product with Serializable

    list the commitments computed and sent to counter-participants optional filtering by synchronizer, time ranges, counter participants, commitment state and verbosity

    list the commitments computed and sent to counter-participants optional filtering by synchronizer, time ranges, counter participants, commitment state and verbosity

    timeRanges

    filter specific time ranges per synchronizer a synchronizer can appear multiple times with various time ranges, in which case we consider the union of the time ranges. return only the sent commitments with an interval overlapping any of the given time ranges per synchronizer defaults: if empty, all synchronizers known to the participant are considered

    counterParticipantUids

    retrieve commitments sent to specific counter participants if a specified counter participant is not a counter-participant in some synchronizer, we do not return it in the response an empty set means we return commitments sent to all counter participants on the synchronizers matching the synchronizer filter.

    commitmentState

    filter by commitment state: only return commitments with the states below if no state is given, we return all commitments

    verbose

    include the actual commitment in the response

    Annotations
    @SerialVersionUID()
  76. final case class LookupSentAcsCommitmentsResponse(sent: Seq[SentAcsCommitmentPerSynchronizer]) extends GeneratedMessage with Updatable[LookupSentAcsCommitmentsResponse] with Product with Serializable

    Returns a sequence of commitments for each synchronizer.

    Returns a sequence of commitments for each synchronizer. Synchronizers should not repeat in the response, otherwise the caller considers the response invalid. If all commitments sent on a synchronizer have been pruned, we return an error. No streaming, because a response with verbose mode on contains around 1kb to 3kb of data (depending on whether we ship the LtHash16 bytes directly or just a hash thereof). Therefore, 1000 commitments fit into a couple of MBs, and we can expect the gRPC admin API to handle messages of a couple of MBs. It is the application developer's job to find suitable filter ranges.

    Annotations
    @SerialVersionUID()
  77. final case class MigrateSynchronizerRequest(sourceSynchronizerAlias: String, targetSynchronizerConnectionConfig: Option[SynchronizerConnectionConfig], force: Boolean) extends GeneratedMessage with Updatable[MigrateSynchronizerRequest] with Product with Serializable

    sourceSynchronizerAlias

    Alias of the synchronizer to which the contracts are currently assigned Required

    targetSynchronizerConnectionConfig

    Configuration to connect to the synchronizer on which the contracts will be assigned as a result of the migration Required

    force

    Whether to force the migration in spite of risking a potential ledger fork Recommended value is false

    Annotations
    @SerialVersionUID()
  78. final case class MigrateSynchronizerResponse() extends GeneratedMessage with Updatable[MigrateSynchronizerResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  79. final case class ModifySynchronizerRequest(newConfig: Option[SynchronizerConnectionConfig], sequencerConnectionValidation: SequencerConnectionValidation) extends GeneratedMessage with Updatable[ModifySynchronizerRequest] with Product with Serializable
    Annotations
    @SerialVersionUID()
  80. final case class ModifySynchronizerResponse() extends GeneratedMessage with Updatable[ModifySynchronizerResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  81. final case class ModuleDescription(name: String) extends GeneratedMessage with Updatable[ModuleDescription] with Product with Serializable
    Annotations
    @SerialVersionUID()
  82. final case class OpenCommitmentRequest(commitment: ByteString, synchronizerId: String, computedForCounterParticipantUid: String, periodEndTick: Option[Timestamp]) extends GeneratedMessage with Updatable[OpenCommitmentRequest] with Product with Serializable

    commitment

    the commitment to be opened

    computedForCounterParticipantUid

    the participant for whom the receiving participant computed the commitment

    periodEndTick

    interval end tick which the commitment corresponds to

    Annotations
    @SerialVersionUID()
  83. final case class OpenCommitmentResponse(chunk: ByteString) extends GeneratedMessage with Updatable[OpenCommitmentResponse] with Product with Serializable

    chunk

    commitment contracts metadata

    Annotations
    @SerialVersionUID()
  84. final case class PackageDescription(packageId: String, name: String, version: String, uploadedAt: Option[Timestamp], size: Int) extends GeneratedMessage with Updatable[PackageDescription] with Product with Serializable
    Annotations
    @SerialVersionUID()
  85. final case class ParticipantStatusRequest() extends GeneratedMessage with Updatable[ParticipantStatusRequest] with Product with Serializable
    Annotations
    @SerialVersionUID()
  86. final case class ParticipantStatusResponse(kind: Kind) extends GeneratedMessage with Updatable[ParticipantStatusResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  87. final case class PingFailure(reason: String) extends GeneratedMessage with Updatable[PingFailure] with Product with Serializable
    Annotations
    @SerialVersionUID()
  88. final case class PingRequest(targetParties: Seq[String], validators: Seq[String], timeout: Option[Duration], levels: Int, synchronizerId: String, workflowId: String, id: String) extends GeneratedMessage with Updatable[PingRequest] with Product with Serializable

    synchronizerId

    optional

    workflowId

    optional

    id

    optional UUID to be used for ping test

    Annotations
    @SerialVersionUID()
  89. final case class PingResponse(response: Response) extends GeneratedMessage with Updatable[PingResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  90. final case class PingSuccess(pingTime: Long, responder: String) extends GeneratedMessage with Updatable[PingSuccess] with Product with Serializable
    Annotations
    @SerialVersionUID()
  91. final case class PruneRequest(pruneUpTo: Long) extends GeneratedMessage with Updatable[PruneRequest] with Product with Serializable

    pruneUpTo

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

    Annotations
    @SerialVersionUID()
  92. 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()
  93. final case class PurgeContractsRequest(synchronizerAlias: String, contractIds: Seq[String], ignoreAlreadyPurged: Boolean) extends GeneratedMessage with Updatable[PurgeContractsRequest] with Product with Serializable

    synchronizerAlias

    Alias of the synchronizer to which the contracts are currently assigned Required

    contractIds

    Contracts to be purged Required

    ignoreAlreadyPurged

    If true, will ignore already purged contract; if false, will return an error if a contract is already purged Useful re-run the same request in case of failure in an idempotent fashion Recommended value is true

    Annotations
    @SerialVersionUID()
  94. final case class PurgeContractsResponse() extends GeneratedMessage with Updatable[PurgeContractsResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  95. final case class PurgeDeactivatedSynchronizerRequest(synchronizerAlias: String) extends GeneratedMessage with Updatable[PurgeDeactivatedSynchronizerRequest] with Product with Serializable

    synchronizerAlias

    Alias of the deactivated synchronizer to purge data from

    Annotations
    @SerialVersionUID()
  96. final case class PurgeDeactivatedSynchronizerResponse() extends GeneratedMessage with Updatable[PurgeDeactivatedSynchronizerResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  97. final case class ReassignmentId(sourceSynchronizerId: String, timestamp: Option[Timestamp]) extends GeneratedMessage with Updatable[ReassignmentId] with Product with Serializable
    Annotations
    @SerialVersionUID()
  98. final case class ReceivedAcsCommitment(interval: Option[Interval], originCounterParticipantUid: String, receivedCommitment: Option[ByteString], ownCommitment: Option[ByteString], state: ReceivedCommitmentState) extends GeneratedMessage with Updatable[ReceivedAcsCommitment] with Product with Serializable

    originCounterParticipantUid

    the counter participant that computed and sent the commitment, from whom the current participant received the commitment

    receivedCommitment

    the commitment received from the counter participant, unsigned because the admin trusts own participant's reply populated only if verbose mode is on

    ownCommitment

    own commitment of participant that was compared with the received commitment, unsigned because the admin trusts own participant's reply populated only in case there is a mismatch and verbose mode is on might not correspond to the same interval as the received commitment, however, the matching timestamp is the end of the returned interval

    Annotations
    @SerialVersionUID()
  99. final case class ReceivedAcsCommitmentPerSynchronizer(synchronizerId: String, received: Seq[ReceivedAcsCommitment]) extends GeneratedMessage with Updatable[ReceivedAcsCommitmentPerSynchronizer] with Product with Serializable
    Annotations
    @SerialVersionUID()
  100. sealed abstract class ReceivedCommitmentState extends GeneratedEnum
  101. final case class ReconnectSynchronizerRequest(synchronizerAlias: String, retry: Boolean) extends GeneratedMessage with Updatable[ReconnectSynchronizerRequest] with Product with Serializable

    retry

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

    Annotations
    @SerialVersionUID()
  102. final case class ReconnectSynchronizerResponse(connectedSuccessfully: Boolean) extends GeneratedMessage with Updatable[ReconnectSynchronizerResponse] with Product with Serializable

    connectedSuccessfully

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

    Annotations
    @SerialVersionUID()
  103. final case class ReconnectSynchronizersRequest(ignoreFailures: Boolean) extends GeneratedMessage with Updatable[ReconnectSynchronizersRequest] with Product with Serializable

    ignoreFailures

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

    Annotations
    @SerialVersionUID()
  104. final case class ReconnectSynchronizersResponse() extends GeneratedMessage with Updatable[ReconnectSynchronizersResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  105. final case class RegisterSynchronizerRequest(config: Option[SynchronizerConnectionConfig], synchronizerConnection: SynchronizerConnection, sequencerConnectionValidation: SequencerConnectionValidation) extends GeneratedMessage with Updatable[RegisterSynchronizerRequest] with Product with Serializable

    * Register connection configuration of a new synchronizer

    * Register connection configuration of a new synchronizer

    synchronizerConnection

    Whether requests to the synchronizer are made

    sequencerConnectionValidation

    Determines how well the provided sequencer connections should be validated before they are persisted. The more paranoid the validation, the higher the chance of the command failing, as it will require the sequencer to be online and responsive.

    Annotations
    @SerialVersionUID()
  106. final case class RegisterSynchronizerResponse() extends GeneratedMessage with Updatable[RegisterSynchronizerResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  107. final case class RemoveDarRequest(mainPackageId: String) extends GeneratedMessage with Updatable[RemoveDarRequest] with Product with Serializable
    Annotations
    @SerialVersionUID()
  108. final case class RemoveDarResponse() extends GeneratedMessage with Updatable[RemoveDarResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  109. final case class RemovePackageRequest(packageId: String, force: Boolean) extends GeneratedMessage with Updatable[RemovePackageRequest] with Product with Serializable
    Annotations
    @SerialVersionUID()
  110. final case class RemovePackageResponse(success: Option[Empty]) extends GeneratedMessage with Updatable[RemovePackageResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  111. final case class RepairCommitmentsStatus(synchronizerId: String, status: Status) extends GeneratedMessage with Updatable[RepairCommitmentsStatus] with Product with Serializable
    Annotations
    @SerialVersionUID()
  112. final case class RepairCommitmentsUsingAcsRequest(synchronizerIds: Seq[String], counterParticipantIds: Seq[String], partyIds: Seq[String], timeoutSeconds: Option[Duration]) extends GeneratedMessage with Updatable[RepairCommitmentsUsingAcsRequest] with Product with Serializable

    synchronizerIds

    The IDs of the synchronizers where to reinitialize commitments from ACS If empty, we reinitialize commitments for all synchronizers

    counterParticipantIds

    Reinitialize commitments only for the given counter-participant If empty, we reinitialize commitments for all counter-participants

    partyIds

    Reinitialize commitments only for the stakeholder groups containing the given parties If empty, we reinitialize commitments for all stakeholder groups

    timeoutSeconds

    The timeout to wait for command to return success The success status can also be queried later using the CommitmentsService

    Annotations
    @SerialVersionUID()
  113. final case class RepairCommitmentsUsingAcsResponse(statuses: Seq[RepairCommitmentsStatus]) extends GeneratedMessage with Updatable[RepairCommitmentsUsingAcsResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  114. final case class ResourceLimits(maxInflightValidationRequests: Option[Int], maxSubmissionRate: Option[Int], maxSubmissionBurstFactor: Double) extends GeneratedMessage with Updatable[ResourceLimits] with Product with Serializable

    maxInflightValidationRequests

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

    maxSubmissionRate

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

    maxSubmissionBurstFactor

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

    Annotations
    @SerialVersionUID()
  115. final case class RollbackUnassignmentRequest(unassignId: String, sourceSynchronizerId: String, targetSynchronizerId: String) extends GeneratedMessage with Updatable[RollbackUnassignmentRequest] with Product with Serializable

    unassignId

    The ID of the unassignment. For one contract the (unassign_id, source synchronizer_id) pair is unique. Must be a valid LedgerString (as described in value.proto). Required

    sourceSynchronizerId

    The ID of the source synchronizer Must be a valid synchronizer id Required

    targetSynchronizerId

    The ID of the target synchronizer Must be a valid synchronizer id Required

    Annotations
    @SerialVersionUID()
  116. final case class RollbackUnassignmentResponse() extends GeneratedMessage with Updatable[RollbackUnassignmentResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  117. final case class SentAcsCommitment(interval: Option[Interval], destCounterParticipantUid: String, ownCommitment: Option[ByteString], receivedCommitment: Option[ByteString], state: SentCommitmentState) extends GeneratedMessage with Updatable[SentAcsCommitment] with Product with Serializable

    destCounterParticipantUid

    the counter participant to whom we sent the commitment

    ownCommitment

    own computed commitment sent to counter participant, unsigned because the admin trusts own participant's reply populated only if verbose mode is on

    receivedCommitment

    commitment of the counter participant that was compared with own commitment, unsigned because the admin trusts own participant's reply populated only in case there is a mismatch and verbose mode is on might not correspond to the same interval as the sent commitment, however, the mismatch timestamp is the end of the returned interval

    Annotations
    @SerialVersionUID()
  118. final case class SentAcsCommitmentPerSynchronizer(synchronizerId: String, sent: Seq[SentAcsCommitment]) extends GeneratedMessage with Updatable[SentAcsCommitmentPerSynchronizer] with Product with Serializable
    Annotations
    @SerialVersionUID()
  119. sealed abstract class SentCommitmentState extends GeneratedEnum
  120. final case class SetConfigForSlowCounterParticipantsRequest(configs: Seq[SlowCounterParticipantSynchronizerConfig]) extends GeneratedMessage with Updatable[SetConfigForSlowCounterParticipantsRequest] with Product with Serializable

    configs

    we can specify multiple configurations, each being applied to one or more synchronizers if the synchronizer ids in the different configs overlap, the latest config in the order of the "configs" takes precedence

    Annotations
    @SerialVersionUID()
  121. final case class SetConfigForSlowCounterParticipantsResponse() extends GeneratedMessage with Updatable[SetConfigForSlowCounterParticipantsResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  122. final case class SetPassiveRequest() extends GeneratedMessage with Updatable[SetPassiveRequest] with Product with Serializable
    Annotations
    @SerialVersionUID()
  123. final case class SetPassiveResponse() extends GeneratedMessage with Updatable[SetPassiveResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  124. final case class SetResourceLimitsRequest(newLimits: Option[ResourceLimits]) extends GeneratedMessage with Updatable[SetResourceLimitsRequest] with Product with Serializable
    Annotations
    @SerialVersionUID()
  125. final case class SetResourceLimitsResponse() extends GeneratedMessage with Updatable[SetResourceLimitsResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  126. final case class SlowCounterParticipantSynchronizerConfig(synchronizerIds: Seq[String], distinguishedParticipantUids: Seq[String], thresholdDistinguished: Long, thresholdDefault: Long, participantUidsMetrics: Seq[String]) extends GeneratedMessage with Updatable[SlowCounterParticipantSynchronizerConfig] with Product with Serializable

    The configuration concerns the following metrics, issued per synchronizer; threshold_distinguished & threshold_default are overwritten, distinguished_participant_uids & participant_uids_metrics is additive: - The maximum number of intervals that a distinguished participant falls behind - The maximum number of intervals that a participant in the "default" group falls behind - The number of participants in the distinguished group that are behind by at least thresholdDistinguished reconciliation intervals.

    The configuration concerns the following metrics, issued per synchronizer; threshold_distinguished & threshold_default are overwritten, distinguished_participant_uids & participant_uids_metrics is additive: - The maximum number of intervals that a distinguished participant falls behind - The maximum number of intervals that a participant in the "default" group falls behind - The number of participants in the distinguished group that are behind by at least thresholdDistinguished reconciliation intervals. - The number of participants in the "default" group that are behind by at least thresholdDefault reconciliation intervals. - Selected participants for which we publish independent metrics counting how many intervals they are behind

    synchronizerIds

    the synchronizers for which we apply the settings below

    distinguishedParticipantUids

    all non-distinguished counter-participants are implicitly part of the group "default"

    thresholdDistinguished

    the number of reconciliation intervals for a distinguished counter-participant to be considered slow

    thresholdDefault

    the number of reconciliation intervals for an "other" counter-participant to be considered slow

    participantUidsMetrics

    participants for which we publish independent metrics counting how many intervals they are behind

    Annotations
    @SerialVersionUID()
  127. final case class SynchronizerConnectionConfig(synchronizerAlias: String, sequencerConnections: Option[SequencerConnections], manualConnect: Boolean, synchronizerId: String, priority: Int, initialRetryDelay: Option[Duration], maxRetryDelay: Option[Duration], timeTracker: Option[SynchronizerTimeTrackerConfig], initializeFromTrustedSynchronizer: Boolean) extends GeneratedMessage with Updatable[SynchronizerConnectionConfig] with Product with Serializable

    synchronizerAlias

    participant local identifier of the target synchronizer

    sequencerConnections

    connection information to sequencers

    manualConnect

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

    synchronizerId

    optional synchronizer id (if TLS isn't to be trusted)

    priority

    optional. Influences whether the participant submits to this synchronizer, if several synchronizers 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 synchronizer

    initializeFromTrustedSynchronizer

    If true, allows a participant to connect to a synchronizer that it was previously connected to, without issuing a new synchronizer trust certificate.

    Annotations
    @SerialVersionUID()
  128. final case class SynchronizerTimeRange(synchronizerId: String, interval: Option[TimeRange]) extends GeneratedMessage with Updatable[SynchronizerTimeRange] with Product with Serializable

    interval

    optional; if not given, the latest reconciliation period the participant knows of for that synchronizer is considered

    Annotations
    @SerialVersionUID()
  129. final case class TimeRange(fromExclusive: Option[Timestamp], toInclusive: Option[Timestamp]) extends GeneratedMessage with Updatable[TimeRange] with Product with Serializable

    timestamps *do not* have to fall on commitment period boundaries/ticks

    timestamps *do not* have to fall on commitment period boundaries/ticks

    Annotations
    @SerialVersionUID()
  130. final case class TrafficControlStateRequest(synchronizerId: String) extends GeneratedMessage with Updatable[TrafficControlStateRequest] with Product with Serializable

    synchronizerId

    Synchronizer id for which to retrieve the traffic state

    Annotations
    @SerialVersionUID()
  131. final case class TrafficControlStateResponse(trafficState: Option[TrafficState]) extends GeneratedMessage with Updatable[TrafficControlStateResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  132. final case class TrafficState(extraTrafficPurchased: Long, extraTrafficConsumed: Long, baseTrafficRemainder: Long, lastConsumedCost: Long, timestamp: Long, serial: Option[Int]) extends GeneratedMessage with Updatable[TrafficState] with Product with Serializable

    Traffic state of a member at a given timestamp - This is a clone of the TrafficState message in sequencing.proto We have to duplicate it here because the admin API protos are self contained and do not depend on the sequencer API protos

    Traffic state of a member at a given timestamp - This is a clone of the TrafficState message in sequencing.proto We have to duplicate it here because the admin API protos are self contained and do not depend on the sequencer API protos

    extraTrafficPurchased

    Total amount of extra traffic purchased

    extraTrafficConsumed

    Total amount of extra traffic consumed

    baseTrafficRemainder

    Amount of base traffic remaining

    lastConsumedCost

    Cost deducted at timestamp, only present when traffic was consumed at timestamp, otherwise is set to 0

    timestamp

    Timestamp at which the state is valid

    serial

    Optional serial of the balance update that updated the extra traffic limit

    Annotations
    @SerialVersionUID()
  133. final case class UnignoreEventsRequest(synchronizerId: 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()
  134. final case class UnignoreEventsResponse() extends GeneratedMessage with Updatable[UnignoreEventsResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  135. final case class UnvetDarRequest(mainPackageId: String) extends GeneratedMessage with Updatable[UnvetDarRequest] with Product with Serializable
    Annotations
    @SerialVersionUID()
  136. final case class UnvetDarResponse() extends GeneratedMessage with Updatable[UnvetDarResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  137. final case class UploadDarRequest(dars: Seq[UploadDarData], vetAllPackages: Boolean, synchronizeVetting: Boolean) extends GeneratedMessage with Updatable[UploadDarRequest] with Product with Serializable

    vetAllPackages

    if set to true (should be used by default), we'll register the vetting topology transactions on all synchronizers

    synchronizeVetting

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

    Annotations
    @SerialVersionUID()
  138. final case class UploadDarResponse(darIds: Seq[String]) extends GeneratedMessage with Updatable[UploadDarResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  139. final case class ValidateDarRequest(data: ByteString, filename: String) extends GeneratedMessage with Updatable[ValidateDarRequest] with Product with Serializable

    Performs the same checks that UploadDarRequest would perform, but doesn't upload the DAR.

    Performs the same checks that UploadDarRequest would perform, but doesn't upload the DAR.

    Annotations
    @SerialVersionUID()
  140. final case class ValidateDarResponse(mainPackageId: String) extends GeneratedMessage with Updatable[ValidateDarResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  141. final case class VetDarRequest(mainPackageId: 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 synchronizers.

    Annotations
    @SerialVersionUID()
  142. final case class VetDarResponse() extends GeneratedMessage with Updatable[VetDarResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()

Value Members

  1. object ActiveContract extends GeneratedMessageCompanion[ActiveContract] with StableProtoVersion
  2. object ActiveContractOld extends GeneratedMessageCompanion[ActiveContractOld] with StableProtoVersion
  3. object ActiveContractProto extends GeneratedFileObject
  4. object AddPartyAsyncRequest extends GeneratedMessageCompanion[AddPartyAsyncRequest] with AlphaProtoVersion
  5. object AddPartyAsyncResponse extends GeneratedMessageCompanion[AddPartyAsyncResponse] with AlphaProtoVersion
  6. object ChangeAssignationRequest extends GeneratedMessageCompanion[ChangeAssignationRequest]
  7. object ChangeAssignationResponse extends GeneratedMessageCompanion[ChangeAssignationResponse]
  8. object CommitmentContract extends GeneratedMessageCompanion[CommitmentContract] with StableProtoVersion
  9. object CommitmentContractMeta extends GeneratedMessageCompanion[CommitmentContractMeta] with StableProtoVersion
  10. object ConnectSynchronizerRequest extends GeneratedMessageCompanion[ConnectSynchronizerRequest]
  11. object ConnectSynchronizerResponse extends GeneratedMessageCompanion[ConnectSynchronizerResponse]
  12. object ConnectedSynchronizer extends GeneratedMessageCompanion[ConnectedSynchronizer]
  13. object Contract extends GeneratedMessageCompanion[Contract]
  14. object ContractIdImportMode extends GeneratedEnumCompanion[ContractIdImportMode]
  15. object ContractState extends GeneratedMessageCompanion[ContractState]
  16. object CountInFlightRequest extends GeneratedMessageCompanion[CountInFlightRequest]
  17. object CountInFlightResponse extends GeneratedMessageCompanion[CountInFlightResponse]
  18. object CounterParticipantInfo extends GeneratedMessageCompanion[CounterParticipantInfo]
  19. object DarDescription extends GeneratedMessageCompanion[DarDescription]
  20. object DisconnectAllSynchronizersRequest extends GeneratedMessageCompanion[DisconnectAllSynchronizersRequest]
  21. object DisconnectAllSynchronizersResponse extends GeneratedMessageCompanion[DisconnectAllSynchronizersResponse]
  22. object DisconnectSynchronizerRequest extends GeneratedMessageCompanion[DisconnectSynchronizerRequest]
  23. object DisconnectSynchronizerResponse extends GeneratedMessageCompanion[DisconnectSynchronizerResponse]
  24. object EnterpriseParticipantReplicationServiceGrpc
  25. object EnterpriseParticipantReplicationServiceProto extends GeneratedFileObject
  26. object ExportAcsAtTimestampRequest extends GeneratedMessageCompanion[ExportAcsAtTimestampRequest]
  27. object ExportAcsAtTimestampResponse extends GeneratedMessageCompanion[ExportAcsAtTimestampResponse]
  28. object ExportAcsOldRequest extends GeneratedMessageCompanion[ExportAcsOldRequest]
  29. object ExportAcsOldResponse extends GeneratedMessageCompanion[ExportAcsOldResponse]
  30. object ExportAcsRequest extends GeneratedMessageCompanion[ExportAcsRequest]
  31. object ExportAcsResponse extends GeneratedMessageCompanion[ExportAcsResponse]
  32. object ExportAcsTargetSynchronizer extends GeneratedMessageCompanion[ExportAcsTargetSynchronizer]
  33. object GetAddPartyStatusRequest extends GeneratedMessageCompanion[GetAddPartyStatusRequest] with AlphaProtoVersion
  34. object GetAddPartyStatusResponse extends GeneratedMessageCompanion[GetAddPartyStatusResponse] with AlphaProtoVersion
  35. object GetConfigForSlowCounterParticipantsRequest extends GeneratedMessageCompanion[GetConfigForSlowCounterParticipantsRequest]
  36. object GetConfigForSlowCounterParticipantsResponse extends GeneratedMessageCompanion[GetConfigForSlowCounterParticipantsResponse]
  37. object GetDarContentsRequest extends GeneratedMessageCompanion[GetDarContentsRequest]
  38. object GetDarContentsResponse extends GeneratedMessageCompanion[GetDarContentsResponse]
  39. object GetDarRequest extends GeneratedMessageCompanion[GetDarRequest]
  40. object GetDarResponse extends GeneratedMessageCompanion[GetDarResponse]
  41. object GetHighestOffsetByTimestampRequest extends GeneratedMessageCompanion[GetHighestOffsetByTimestampRequest]
  42. object GetHighestOffsetByTimestampResponse extends GeneratedMessageCompanion[GetHighestOffsetByTimestampResponse]
  43. object GetIntervalsBehindForCounterParticipantsRequest extends GeneratedMessageCompanion[GetIntervalsBehindForCounterParticipantsRequest]
  44. object GetIntervalsBehindForCounterParticipantsResponse extends GeneratedMessageCompanion[GetIntervalsBehindForCounterParticipantsResponse]
  45. object GetPackageContentsRequest extends GeneratedMessageCompanion[GetPackageContentsRequest]
  46. object GetPackageContentsResponse extends GeneratedMessageCompanion[GetPackageContentsResponse]
  47. object GetPackageReferencesRequest extends GeneratedMessageCompanion[GetPackageReferencesRequest]
  48. object GetPackageReferencesResponse extends GeneratedMessageCompanion[GetPackageReferencesResponse]
  49. object GetResourceLimitsRequest extends GeneratedMessageCompanion[GetResourceLimitsRequest]
  50. object GetResourceLimitsResponse extends GeneratedMessageCompanion[GetResourceLimitsResponse]
  51. object GetSafePruningOffsetRequest extends GeneratedMessageCompanion[GetSafePruningOffsetRequest]
  52. object GetSafePruningOffsetResponse extends GeneratedMessageCompanion[GetSafePruningOffsetResponse]
  53. object GetSynchronizerIdRequest extends GeneratedMessageCompanion[GetSynchronizerIdRequest]
  54. object GetSynchronizerIdResponse extends GeneratedMessageCompanion[GetSynchronizerIdResponse]
  55. object IgnoreEventsRequest extends GeneratedMessageCompanion[IgnoreEventsRequest]
  56. object IgnoreEventsResponse extends GeneratedMessageCompanion[IgnoreEventsResponse]
  57. object ImportAcsOldRequest extends GeneratedMessageCompanion[ImportAcsOldRequest]
  58. object ImportAcsOldResponse extends GeneratedMessageCompanion[ImportAcsOldResponse]
  59. object ImportAcsRequest extends GeneratedMessageCompanion[ImportAcsRequest]
  60. object ImportAcsResponse extends GeneratedMessageCompanion[ImportAcsResponse]
  61. object InspectCommitmentContractsRequest extends GeneratedMessageCompanion[InspectCommitmentContractsRequest]
  62. object InspectCommitmentContractsResponse extends GeneratedMessageCompanion[InspectCommitmentContractsResponse]
  63. object Interval extends GeneratedMessageCompanion[Interval]
  64. object ListConnectedSynchronizersRequest extends GeneratedMessageCompanion[ListConnectedSynchronizersRequest]
  65. object ListConnectedSynchronizersResponse extends GeneratedMessageCompanion[ListConnectedSynchronizersResponse]
  66. object ListDarsRequest extends GeneratedMessageCompanion[ListDarsRequest]
  67. object ListDarsResponse extends GeneratedMessageCompanion[ListDarsResponse]
  68. object ListPackagesRequest extends GeneratedMessageCompanion[ListPackagesRequest]
  69. object ListPackagesResponse extends GeneratedMessageCompanion[ListPackagesResponse]
  70. object ListRegisteredSynchronizersRequest extends GeneratedMessageCompanion[ListRegisteredSynchronizersRequest]
  71. object ListRegisteredSynchronizersResponse extends GeneratedMessageCompanion[ListRegisteredSynchronizersResponse]
  72. object LogoutRequest extends GeneratedMessageCompanion[LogoutRequest]
  73. object LogoutResponse extends GeneratedMessageCompanion[LogoutResponse]
  74. object LookupOffsetByTimeRequest extends GeneratedMessageCompanion[LookupOffsetByTimeRequest]
  75. object LookupOffsetByTimeResponse extends GeneratedMessageCompanion[LookupOffsetByTimeResponse]
  76. object LookupReceivedAcsCommitmentsRequest extends GeneratedMessageCompanion[LookupReceivedAcsCommitmentsRequest]
  77. object LookupReceivedAcsCommitmentsResponse extends GeneratedMessageCompanion[LookupReceivedAcsCommitmentsResponse]
  78. object LookupSentAcsCommitmentsRequest extends GeneratedMessageCompanion[LookupSentAcsCommitmentsRequest]
  79. object LookupSentAcsCommitmentsResponse extends GeneratedMessageCompanion[LookupSentAcsCommitmentsResponse]
  80. object MigrateSynchronizerRequest extends GeneratedMessageCompanion[MigrateSynchronizerRequest]
  81. object MigrateSynchronizerResponse extends GeneratedMessageCompanion[MigrateSynchronizerResponse]
  82. object ModifySynchronizerRequest extends GeneratedMessageCompanion[ModifySynchronizerRequest]
  83. object ModifySynchronizerResponse extends GeneratedMessageCompanion[ModifySynchronizerResponse]
  84. object ModuleDescription extends GeneratedMessageCompanion[ModuleDescription]
  85. object OpenCommitmentRequest extends GeneratedMessageCompanion[OpenCommitmentRequest]
  86. object OpenCommitmentResponse extends GeneratedMessageCompanion[OpenCommitmentResponse]
  87. object PackageDescription extends GeneratedMessageCompanion[PackageDescription]
  88. object PackageServiceGrpc
  89. object PackageServiceProto extends GeneratedFileObject
  90. object ParticipantInspectionServiceGrpc
  91. object ParticipantInspectionServiceProto extends GeneratedFileObject
  92. object ParticipantRepairServiceGrpc
  93. object ParticipantRepairServiceProto extends GeneratedFileObject
  94. object ParticipantStatusRequest extends GeneratedMessageCompanion[ParticipantStatusRequest]
  95. object ParticipantStatusResponse extends GeneratedMessageCompanion[ParticipantStatusResponse]
  96. object ParticipantStatusServiceGrpc
  97. object ParticipantStatusServiceProto extends GeneratedFileObject
  98. object PartyManagementServiceGrpc
  99. object PartyManagementServiceProto extends GeneratedFileObject
  100. object PingFailure extends GeneratedMessageCompanion[PingFailure]
  101. object PingPongServiceProto extends GeneratedFileObject
  102. object PingRequest extends GeneratedMessageCompanion[PingRequest]
  103. object PingResponse extends GeneratedMessageCompanion[PingResponse]
  104. object PingServiceGrpc
  105. object PingSuccess extends GeneratedMessageCompanion[PingSuccess]
  106. object PruneRequest extends GeneratedMessageCompanion[PruneRequest]
  107. object PruneResponse extends GeneratedMessageCompanion[PruneResponse]
  108. object PruningServiceGrpc
  109. object PruningServiceProto extends GeneratedFileObject
  110. object PurgeContractsRequest extends GeneratedMessageCompanion[PurgeContractsRequest]
  111. object PurgeContractsResponse extends GeneratedMessageCompanion[PurgeContractsResponse]
  112. object PurgeDeactivatedSynchronizerRequest extends GeneratedMessageCompanion[PurgeDeactivatedSynchronizerRequest]
  113. object PurgeDeactivatedSynchronizerResponse extends GeneratedMessageCompanion[PurgeDeactivatedSynchronizerResponse]
  114. object ReassignmentId extends GeneratedMessageCompanion[ReassignmentId]
  115. object ReassignmentIdProto extends GeneratedFileObject
  116. object ReceivedAcsCommitment extends GeneratedMessageCompanion[ReceivedAcsCommitment]
  117. object ReceivedAcsCommitmentPerSynchronizer extends GeneratedMessageCompanion[ReceivedAcsCommitmentPerSynchronizer]
  118. object ReceivedCommitmentState extends GeneratedEnumCompanion[ReceivedCommitmentState]
  119. object ReconnectSynchronizerRequest extends GeneratedMessageCompanion[ReconnectSynchronizerRequest]
  120. object ReconnectSynchronizerResponse extends GeneratedMessageCompanion[ReconnectSynchronizerResponse]
  121. object ReconnectSynchronizersRequest extends GeneratedMessageCompanion[ReconnectSynchronizersRequest]
  122. object ReconnectSynchronizersResponse extends GeneratedMessageCompanion[ReconnectSynchronizersResponse]
  123. object RegisterSynchronizerRequest extends GeneratedMessageCompanion[RegisterSynchronizerRequest]
  124. object RegisterSynchronizerResponse extends GeneratedMessageCompanion[RegisterSynchronizerResponse]
  125. object RemoveDarRequest extends GeneratedMessageCompanion[RemoveDarRequest]
  126. object RemoveDarResponse extends GeneratedMessageCompanion[RemoveDarResponse]
  127. object RemovePackageRequest extends GeneratedMessageCompanion[RemovePackageRequest]
  128. object RemovePackageResponse extends GeneratedMessageCompanion[RemovePackageResponse]
  129. object RepairCommitmentsStatus extends GeneratedMessageCompanion[RepairCommitmentsStatus]
  130. object RepairCommitmentsUsingAcsRequest extends GeneratedMessageCompanion[RepairCommitmentsUsingAcsRequest]
  131. object RepairCommitmentsUsingAcsResponse extends GeneratedMessageCompanion[RepairCommitmentsUsingAcsResponse]
  132. object ResourceLimits extends GeneratedMessageCompanion[ResourceLimits]
  133. object ResourceManagementServiceGrpc
  134. object ResourceManagementServiceProto extends GeneratedFileObject
  135. object RollbackUnassignmentRequest extends GeneratedMessageCompanion[RollbackUnassignmentRequest]
  136. object RollbackUnassignmentResponse extends GeneratedMessageCompanion[RollbackUnassignmentResponse]
  137. object SentAcsCommitment extends GeneratedMessageCompanion[SentAcsCommitment]
  138. object SentAcsCommitmentPerSynchronizer extends GeneratedMessageCompanion[SentAcsCommitmentPerSynchronizer]
  139. object SentCommitmentState extends GeneratedEnumCompanion[SentCommitmentState]
  140. object SetConfigForSlowCounterParticipantsRequest extends GeneratedMessageCompanion[SetConfigForSlowCounterParticipantsRequest]
  141. object SetConfigForSlowCounterParticipantsResponse extends GeneratedMessageCompanion[SetConfigForSlowCounterParticipantsResponse]
  142. object SetPassiveRequest extends GeneratedMessageCompanion[SetPassiveRequest]
  143. object SetPassiveResponse extends GeneratedMessageCompanion[SetPassiveResponse]
  144. object SetResourceLimitsRequest extends GeneratedMessageCompanion[SetResourceLimitsRequest]
  145. object SetResourceLimitsResponse extends GeneratedMessageCompanion[SetResourceLimitsResponse]
  146. object SlowCounterParticipantSynchronizerConfig extends GeneratedMessageCompanion[SlowCounterParticipantSynchronizerConfig]
  147. object SynchronizerConnectionConfig extends GeneratedMessageCompanion[SynchronizerConnectionConfig]
  148. object SynchronizerConnectivityProto extends GeneratedFileObject
  149. object SynchronizerConnectivityServiceGrpc
  150. object SynchronizerTimeRange extends GeneratedMessageCompanion[SynchronizerTimeRange]
  151. object TimeRange extends GeneratedMessageCompanion[TimeRange]
  152. object TrafficControlServiceGrpc
  153. object TrafficControlServiceProto extends GeneratedFileObject
  154. object TrafficControlStateRequest extends GeneratedMessageCompanion[TrafficControlStateRequest]
  155. object TrafficControlStateResponse extends GeneratedMessageCompanion[TrafficControlStateResponse]
  156. object TrafficState extends GeneratedMessageCompanion[TrafficState]
  157. object UnignoreEventsRequest extends GeneratedMessageCompanion[UnignoreEventsRequest]
  158. object UnignoreEventsResponse extends GeneratedMessageCompanion[UnignoreEventsResponse]
  159. object UnvetDarRequest extends GeneratedMessageCompanion[UnvetDarRequest]
  160. object UnvetDarResponse extends GeneratedMessageCompanion[UnvetDarResponse]
  161. object UploadDarRequest extends GeneratedMessageCompanion[UploadDarRequest]
  162. object UploadDarResponse extends GeneratedMessageCompanion[UploadDarResponse]
  163. object ValidateDarRequest extends GeneratedMessageCompanion[ValidateDarRequest]
  164. object ValidateDarResponse extends GeneratedMessageCompanion[ValidateDarResponse]
  165. object VetDarRequest extends GeneratedMessageCompanion[VetDarRequest]
  166. object VetDarResponse extends GeneratedMessageCompanion[VetDarResponse]

Ungrouped