Packages

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()
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PurgeContractsRequest
  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 PurgeContractsRequest(domain: String, contractIds: Seq[String], ignoreAlreadyPurged: Boolean, offboardedParties: Seq[String])

    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.

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 addAllContractIds(__vs: Iterable[String]): PurgeContractsRequest
  5. def addAllOffboardedParties(__vs: Iterable[String]): PurgeContractsRequest
  6. def addContractIds(__vs: String*): PurgeContractsRequest
  7. def addOffboardedParties(__vs: String*): PurgeContractsRequest
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def clearContractIds: PurgeContractsRequest
  10. def clearOffboardedParties: PurgeContractsRequest
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  12. def companion: PurgeContractsRequest.type
    Definition Classes
    PurgeContractsRequest → GeneratedMessage
  13. val contractIds: Seq[String]
  14. val domain: String
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  17. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    PurgeContractsRequest → GeneratedMessage
  18. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    PurgeContractsRequest → GeneratedMessage
  19. val ignoreAlreadyPurged: Boolean
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  24. val offboardedParties: Seq[String]
  25. def productElementNames: Iterator[String]
    Definition Classes
    Product
  26. def serializedSize: Int
    Definition Classes
    PurgeContractsRequest → GeneratedMessage
  27. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  28. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  29. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  30. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  31. def toProtoString: String
    Definition Classes
    PurgeContractsRequest → GeneratedMessage
  32. def update(ms: (Lens[PurgeContractsRequest, PurgeContractsRequest]) => Mutation[PurgeContractsRequest]*): PurgeContractsRequest
    Definition Classes
    Updatable
  33. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  34. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  35. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  36. def withContractIds(__v: Seq[String]): PurgeContractsRequest
  37. def withDomain(__v: String): PurgeContractsRequest
  38. def withIgnoreAlreadyPurged(__v: Boolean): PurgeContractsRequest
  39. def withOffboardedParties(__v: Seq[String]): PurgeContractsRequest
  40. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  41. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    PurgeContractsRequest → GeneratedMessage
  42. 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
    Deprecated

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped