Packages

final case class ImportAcsRequest(acsSnapshot: ByteString, workflowIdPrefix: String, contractImportMode: ContractImportMode, excludedStakeholderIds: Seq[String], representativePackageIdOverride: Option[RepresentativePackageIdOverride]) 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

Custom prefix for the workflow ID to easily identify all transactions generated by this import. Optional. If left empty, the service will generate a prefix such as import-<random_UUID>.

contractImportMode

How imported contracts should be validated upon import NOTE: The representative package IDs assigned to imported contracts must ensure proper type-checking for those contracts. Importing contracts representative_package_id's that do not type-check may cause unexpected behavior, including INTERNAL errors on Ledger API read queries or incorrect Daml value representations. If unsure, perform the ACS import with ContractImportMode set to CONTRACT_IMPORT_MODE_VALIDATION to ensure that the assigned representative package IDs correctly validate the imported contracts. Required

excludedStakeholderIds

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

representativePackageIdOverride

The representative package ID override rules to be applied during import. Optional

Annotations
@SerialVersionUID()
Linear Supertypes
Updatable[ImportAcsRequest], GeneratedMessage, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ImportAcsRequest
  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 ImportAcsRequest(acsSnapshot: ByteString, workflowIdPrefix: String, contractImportMode: ContractImportMode, excludedStakeholderIds: Seq[String], representativePackageIdOverride: Option[RepresentativePackageIdOverride])

    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

    Custom prefix for the workflow ID to easily identify all transactions generated by this import. Optional. If left empty, the service will generate a prefix such as import-<random_UUID>.

    contractImportMode

    How imported contracts should be validated upon import NOTE: The representative package IDs assigned to imported contracts must ensure proper type-checking for those contracts. Importing contracts representative_package_id's that do not type-check may cause unexpected behavior, including INTERNAL errors on Ledger API read queries or incorrect Daml value representations. If unsure, perform the ACS import with ContractImportMode set to CONTRACT_IMPORT_MODE_VALIDATION to ensure that the assigned representative package IDs correctly validate the imported contracts. Required

    excludedStakeholderIds

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

    representativePackageIdOverride

    The representative package ID override rules to be applied during import. 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. val acsSnapshot: ByteString
  5. def addAllExcludedStakeholderIds(__vs: Iterable[String]): ImportAcsRequest
  6. def addExcludedStakeholderIds(__vs: String*): ImportAcsRequest
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clearExcludedStakeholderIds: ImportAcsRequest
  9. def clearRepresentativePackageIdOverride: ImportAcsRequest
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  11. def companion: ImportAcsRequest.type
    Definition Classes
    ImportAcsRequest → GeneratedMessage
  12. val contractImportMode: ContractImportMode
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. val excludedStakeholderIds: Seq[String]
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    ImportAcsRequest → GeneratedMessage
  17. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    ImportAcsRequest → GeneratedMessage
  18. def getRepresentativePackageIdOverride: RepresentativePackageIdOverride
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. def productElementNames: Iterator[String]
    Definition Classes
    Product
  24. val representativePackageIdOverride: Option[RepresentativePackageIdOverride]
  25. def serializedSize: Int
    Definition Classes
    ImportAcsRequest → GeneratedMessage
  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  28. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  29. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  30. def toProtoString: String
    Definition Classes
    ImportAcsRequest → GeneratedMessage
  31. def update(ms: (Lens[ImportAcsRequest, ImportAcsRequest]) => Mutation[ImportAcsRequest]*): ImportAcsRequest
    Definition Classes
    Updatable
  32. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  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. def withAcsSnapshot(__v: ByteString): ImportAcsRequest
  36. def withContractImportMode(__v: ContractImportMode): ImportAcsRequest
  37. def withExcludedStakeholderIds(__v: Seq[String]): ImportAcsRequest
  38. def withRepresentativePackageIdOverride(__v: RepresentativePackageIdOverride): ImportAcsRequest
  39. def withWorkflowIdPrefix(__v: String): ImportAcsRequest
  40. val workflowIdPrefix: String
  41. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  42. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    ImportAcsRequest → GeneratedMessage
  43. 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[ImportAcsRequest]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped