com.digitalasset.canton.participant.admin.v0
PurgeContractsRequest
Companion object PurgeContractsRequest
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()
- Alphabetic
- By Inheritance
- PurgeContractsRequest
- Updatable
- GeneratedMessage
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- 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
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def addAllContractIds(__vs: Iterable[String]): PurgeContractsRequest
- def addAllOffboardedParties(__vs: Iterable[String]): PurgeContractsRequest
- def addContractIds(__vs: String*): PurgeContractsRequest
- def addOffboardedParties(__vs: String*): PurgeContractsRequest
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clearContractIds: PurgeContractsRequest
- def clearOffboardedParties: PurgeContractsRequest
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def companion: PurgeContractsRequest.type
- Definition Classes
- PurgeContractsRequest → GeneratedMessage
- val contractIds: Seq[String]
- val domain: String
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def getField(__field: FieldDescriptor): PValue
- Definition Classes
- PurgeContractsRequest → GeneratedMessage
- def getFieldByNumber(__fieldNumber: Int): Any
- Definition Classes
- PurgeContractsRequest → GeneratedMessage
- val ignoreAlreadyPurged: Boolean
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val offboardedParties: Seq[String]
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def serializedSize: Int
- Definition Classes
- PurgeContractsRequest → GeneratedMessage
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def toByteArray: Array[Byte]
- Definition Classes
- GeneratedMessage
- final def toByteString: ByteString
- Definition Classes
- GeneratedMessage
- final def toPMessage: PMessage
- Definition Classes
- GeneratedMessage
- def toProtoString: String
- Definition Classes
- PurgeContractsRequest → GeneratedMessage
- def update(ms: (Lens[PurgeContractsRequest, PurgeContractsRequest]) => Mutation[PurgeContractsRequest]*): PurgeContractsRequest
- Definition Classes
- Updatable
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def withContractIds(__v: Seq[String]): PurgeContractsRequest
- def withDomain(__v: String): PurgeContractsRequest
- def withIgnoreAlreadyPurged(__v: Boolean): PurgeContractsRequest
- def withOffboardedParties(__v: Seq[String]): PurgeContractsRequest
- final def writeDelimitedTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage
- def writeTo(_output__: CodedOutputStream): Unit
- Definition Classes
- PurgeContractsRequest → GeneratedMessage
- final def writeTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage