Packages

final case class ExportAcsRequest(partyIds: Seq[String], synchronizerId: String, ledgerOffset: Long, contractSynchronizerRenames: Map[String, ExportAcsTargetSynchronizer], excludedStakeholderIds: Seq[String]) 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.

excludedStakeholderIds

A list of party IDs to exclude from the export. Any contract that has one or more of these parties as a stakeholder will be omitted from the ACS snapshot. Optional

Annotations
@SerialVersionUID()
Linear Supertypes
Updatable[ExportAcsRequest], GeneratedMessage, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ExportAcsRequest
  2. Updatable
  3. GeneratedMessage
  4. Serializable
  5. Product
  6. Equals
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ExportAcsRequest(partyIds: Seq[String], synchronizerId: String, ledgerOffset: Long, contractSynchronizerRenames: Map[String, ExportAcsTargetSynchronizer], excludedStakeholderIds: Seq[String])

    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.

    excludedStakeholderIds

    A list of party IDs to exclude from the export. Any contract that has one or more of these parties as a stakeholder will be omitted from the ACS snapshot. Optional

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addAllContractSynchronizerRenames(__vs: Iterable[(String, ExportAcsTargetSynchronizer)]): ExportAcsRequest
  5. def addAllExcludedStakeholderIds(__vs: Iterable[String]): ExportAcsRequest
  6. def addAllPartyIds(__vs: Iterable[String]): ExportAcsRequest
  7. def addContractSynchronizerRenames(__vs: (String, ExportAcsTargetSynchronizer)*): ExportAcsRequest
  8. def addExcludedStakeholderIds(__vs: String*): ExportAcsRequest
  9. def addPartyIds(__vs: String*): ExportAcsRequest
  10. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  11. def clearContractSynchronizerRenames: ExportAcsRequest
  12. def clearExcludedStakeholderIds: ExportAcsRequest
  13. def clearPartyIds: ExportAcsRequest
  14. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  15. def companion: ExportAcsRequest.type
    Definition Classes
    ExportAcsRequest → GeneratedMessage
  16. val contractSynchronizerRenames: Map[String, ExportAcsTargetSynchronizer]
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. val excludedStakeholderIds: Seq[String]
  19. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    ExportAcsRequest → GeneratedMessage
  21. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    ExportAcsRequest → GeneratedMessage
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. val ledgerOffset: Long
  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. val partyIds: Seq[String]
  28. def productElementNames: Iterator[String]
    Definition Classes
    Product
  29. def serializedSize: Int
    Definition Classes
    ExportAcsRequest → GeneratedMessage
  30. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  31. val synchronizerId: String
  32. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  33. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  34. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  35. def toProtoString: String
    Definition Classes
    ExportAcsRequest → GeneratedMessage
  36. def update(ms: (Lens[ExportAcsRequest, ExportAcsRequest]) => Mutation[ExportAcsRequest]*): ExportAcsRequest
    Definition Classes
    Updatable
  37. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  38. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  39. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  40. def withContractSynchronizerRenames(__v: Map[String, ExportAcsTargetSynchronizer]): ExportAcsRequest
  41. def withExcludedStakeholderIds(__v: Seq[String]): ExportAcsRequest
  42. def withLedgerOffset(__v: Long): ExportAcsRequest
  43. def withPartyIds(__v: Seq[String]): ExportAcsRequest
  44. def withSynchronizerId(__v: String): ExportAcsRequest
  45. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  46. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    ExportAcsRequest → GeneratedMessage
  47. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Updatable[ExportAcsRequest]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped