final case class TransferredIn(updateId: LedgerTransactionId, optCompletionInfo: Option[CompletionInfo], submitter: Option[LfPartyId], recordTime: LfTimestamp, ledgerCreateTime: LfTimestamp, createNode: LfNodeCreate, creatingTransactionId: LedgerTransactionId, contractMetadata: Bytes, transferId: TransferId, targetDomain: TargetDomainId, createTransactionAccepted: Boolean, workflowId: Option[LfWorkflowId], isTransferringParticipant: Boolean, hostedStakeholders: List[LfPartyId], transferCounter: TransferCounter) extends TransferEvent with Product with Serializable

Signal the transfer-in of a contract from the source domain to the target domain.

updateId

Uniquely identifies the update.

optCompletionInfo

Must be provided for the participant that submitted the transfer-in.

submitter

The partyId of the transfer submitter, unless the operation is performed offline.

recordTime

The ledger-provided timestamp at which the contract was transferred in.

ledgerCreateTime

The ledger time of the transaction creating the contract

createNode

Denotes the creation of the contract being transferred-in.

contractMetadata

Contains contract metadata of the contract transferred assigned by the ledger implementation

transferId

Uniquely identifies the transfer. See com.digitalasset.canton.protocol.TransferId.

targetDomain

The target domain of the transfer.

createTransactionAccepted

We used to create a TransactionAccepted for the transferIn. This param is used to keep the same behavior.

workflowId

The workflowId specified by the submitter in the transfer command.

isTransferringParticipant

True if the participant is transferring. Note: false if the data comes from an old serialized event

transferCounter

The com.digitalasset.canton.TransferCounter of the contract. For protocol version earlier than com.digitalasset.canton.version.ProtocolVersion.CNTestNet, its value is Long.MinValue

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TransferredIn
  2. TransferEvent
  3. WithDomainId
  4. LedgerSyncEvent
  5. PrettyPrinting
  6. PrettyUtil
  7. ShowUtil
  8. ShowSyntax
  9. ToShowOps
  10. Serializable
  11. Product
  12. Equals
  13. AnyRef
  14. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new TransferredIn(updateId: LedgerTransactionId, optCompletionInfo: Option[CompletionInfo], submitter: Option[LfPartyId], recordTime: LfTimestamp, ledgerCreateTime: LfTimestamp, createNode: LfNodeCreate, creatingTransactionId: LedgerTransactionId, contractMetadata: Bytes, transferId: TransferId, targetDomain: TargetDomainId, createTransactionAccepted: Boolean, workflowId: Option[LfWorkflowId], isTransferringParticipant: Boolean, hostedStakeholders: List[LfPartyId], transferCounter: TransferCounter)

    updateId

    Uniquely identifies the update.

    optCompletionInfo

    Must be provided for the participant that submitted the transfer-in.

    submitter

    The partyId of the transfer submitter, unless the operation is performed offline.

    recordTime

    The ledger-provided timestamp at which the contract was transferred in.

    ledgerCreateTime

    The ledger time of the transaction creating the contract

    createNode

    Denotes the creation of the contract being transferred-in.

    contractMetadata

    Contains contract metadata of the contract transferred assigned by the ledger implementation

    transferId

    Uniquely identifies the transfer. See com.digitalasset.canton.protocol.TransferId.

    targetDomain

    The target domain of the transfer.

    createTransactionAccepted

    We used to create a TransactionAccepted for the transferIn. This param is used to keep the same behavior.

    workflowId

    The workflowId specified by the submitter in the transfer command.

    isTransferringParticipant

    True if the participant is transferring. Note: false if the data comes from an old serialized event

    transferCounter

    The com.digitalasset.canton.TransferCounter of the contract. For protocol version earlier than com.digitalasset.canton.version.ProtocolVersion.CNTestNet, its value is Long.MinValue

Type Members

  1. implicit class ShowAnyRefSyntax extends AnyRef
    Definition Classes
    ShowUtil
  2. implicit class ShowEitherSyntax[L, R] extends AnyRef

    Enables the syntax show"${myEither.showMerged}".

    Enables the syntax show"${myEither.showMerged}".

    Definition Classes
    ShowUtil
  3. implicit class ShowLengthLimitedStringSyntax extends StringOperators
    Definition Classes
    ShowUtil
  4. implicit class ShowLengthLimitedStringWrapperSyntax extends StringOperators
    Definition Classes
    ShowUtil
  5. implicit class ShowOptionSyntax[T] extends AnyRef
    Definition Classes
    ShowUtil
  6. implicit class ShowProductSyntax extends AnyRef
    Definition Classes
    ShowUtil
    Annotations
    @SuppressWarnings()
  7. implicit class ShowStringSyntax extends StringOperators
    Definition Classes
    ShowUtil
  8. implicit class ShowTraversableSyntax[T] extends AnyRef

    Enables syntax like show"Found several elements: ${myCollection.mkShow()}".

    Enables syntax like show"Found several elements: ${myCollection.mkShow()}".

    Definition Classes
    ShowUtil
  9. abstract class StringOperators extends AnyRef

    Enables syntax like show"This is a string: ${myString.doubleQuoted}" and show"This is a hash: ${myHash.readableHash}".

    Enables syntax like show"This is a string: ${myString.doubleQuoted}" and show"This is a hash: ${myHash.readableHash}".

    Definition Classes
    ShowUtil

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 adHocPrettyInstance[T <: Product](implicit c: ClassTag[T]): Pretty[T]

    Use this as a temporary solution, to make the code compile during an ongoing migration.

    Use this as a temporary solution, to make the code compile during an ongoing migration. Drawbacks:

    • Instances of Pretty[T] are ignored.
    • No parameter names
    Definition Classes
    PrettyUtil
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def asTransactionAccepted: Option[Update]

    Workaround to create an update for informing the ledger API server about a transferred-in contract.

    Workaround to create an update for informing the ledger API server about a transferred-in contract. Creates a TransactionAccepted event consisting of a single create action that creates the given contract.

    The transaction has the same ledger time and transaction id as the creation of the contract.

  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. def contractId: LfContractId
    Definition Classes
    TransferredInTransferEvent
  9. val contractMetadata: Bytes
  10. val createNode: LfNodeCreate
  11. val createTransactionAccepted: Boolean
  12. val creatingTransactionId: LedgerTransactionId
  13. def customParam[T](getValue: (T) => String, cond: (T) => Boolean = (_: T) => true): (T) => Option[Tree]

    Use this if you need a custom representation of a parameter.

    Use this if you need a custom representation of a parameter. Do not use this to create lengthy strings, as line wrapping is not supported.

    Definition Classes
    PrettyUtil
  14. def description: String
    Definition Classes
    TransferEventLedgerSyncEvent
  15. def domainId: Option[DomainId]
    Definition Classes
    TransferredInWithDomainId
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. val hostedStakeholders: List[LfPartyId]
  19. def indicateOmittedFields[T]: (T) => Option[Tree]

    Use this to indicate that you've omitted fields from pretty printing

    Use this to indicate that you've omitted fields from pretty printing

    Definition Classes
    PrettyUtil
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. val isTransferringParticipant: Boolean
    Definition Classes
    TransferredInTransferEvent
  22. def kind: String
    Definition Classes
    TransferredInTransferEvent
  23. val ledgerCreateTime: LfTimestamp
  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  27. val optCompletionInfo: Option[CompletionInfo]
  28. def param[T, V](name: String, getValue: (T) => V, cond: (T) => Boolean = (_: T) => true)(implicit arg0: Pretty[V]): (T) => Option[Tree]

    A tree representing both parameter name and value.

    A tree representing both parameter name and value.

    Definition Classes
    PrettyUtil
  29. def paramIfDefined[T, V](name: String, getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  30. def paramIfNonEmpty[T, V <: IterableOnce[_]](name: String, getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  31. def paramIfNotDefault[T, V](name: String, getValue: (T) => V, default: V)(implicit arg0: Pretty[V]): (T) => Option[Tree]

    A tree only written if not matching the default value

    A tree only written if not matching the default value

    Definition Classes
    PrettyUtil
  32. def paramIfTrue[T](label: String, getValue: (T) => Boolean): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  33. def paramWithoutValue[T](name: String, cond: (T) => Boolean = (_: T) => true): (T) => Option[Tree]

    A tree representing a parameter name without a parameter value.

    A tree representing a parameter name without a parameter value. Use this for parameters storing confidential or binary data.

    Definition Classes
    PrettyUtil
  34. def pretty: Pretty[TransferredIn]

    Indicates how to pretty print this instance.

    Indicates how to pretty print this instance. See PrettyPrintingTest for examples on how to implement this method.

    Definition Classes
    TransferredInPrettyPrinting
  35. def prettyInfix[T]: PrettyInfixPartiallyApplied[T]
    Definition Classes
    PrettyUtil
  36. def prettyNode[T](label: String, children: (T) => Option[Tree]*): Pretty[T]

    A tree consisting of a labelled node with the given children.

    A tree consisting of a labelled node with the given children.

    Definition Classes
    PrettyUtil
  37. def prettyOfClass[T](getParamTrees: (T) => Option[Tree]*): Pretty[T]

    A tree representing the type name and parameter trees.

    A tree representing the type name and parameter trees.

    Definition Classes
    PrettyUtil
  38. def prettyOfObject[T <: Product]: Pretty[T]

    A tree presenting the type name only.

    A tree presenting the type name only. (E.g., for case objects.)

    Definition Classes
    PrettyUtil
  39. def prettyOfParam[T, V](getValue: (T) => V)(implicit arg0: Pretty[V]): Pretty[T]

    Use this to give a class with a singleton parameter the same pretty representation as the parameter.

    Use this to give a class with a singleton parameter the same pretty representation as the parameter.

    Definition Classes
    PrettyUtil
  40. def prettyOfString[T](toString: (T) => String): Pretty[T]

    Creates a pretty instance from a string function.

    Creates a pretty instance from a string function. Do not use this with lengthy strings, as line wrapping is not supported.

    Definition Classes
    PrettyUtil
  41. def productElementNames: Iterator[String]
    Definition Classes
    Product
  42. val recordTime: LfTimestamp
    Definition Classes
    TransferredInLedgerSyncEvent
  43. def setTimestamp(timestamp: LfTimestamp): LedgerSyncEvent
    Definition Classes
    LedgerSyncEvent
  44. implicit final def showInterpolator(sc: StringContext): ShowInterpolator
    Definition Classes
    ShowSyntax
  45. implicit def showPretty[T](implicit arg0: Pretty[T]): Show[T]

    Enables the syntax show"This object is pretty: $myPrettyType".

    Enables the syntax show"This object is pretty: $myPrettyType".

    Definition Classes
    ShowUtil
  46. def sourceDomain: SourceDomainId
    Definition Classes
    TransferEvent
  47. val submitter: Option[LfPartyId]
  48. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  49. val targetDomain: TargetDomainId
    Definition Classes
    TransferredInTransferEvent
  50. def toDamlUpdate: Option[Update]
    Definition Classes
    TransferredInLedgerSyncEvent
  51. implicit def toShow[A](target: A)(implicit tc: Show[A]): Ops[A]
    Definition Classes
    ToShowOps
  52. final def toString(): String

    Yields a readable string representation based on com.digitalasset.canton.logging.pretty.Pretty.DefaultPprinter.

    Yields a readable string representation based on com.digitalasset.canton.logging.pretty.Pretty.DefaultPprinter. Final to avoid accidental overwriting.

    Definition Classes
    PrettyPrinting → AnyRef → Any
  53. val transferCounter: TransferCounter
  54. val transferId: TransferId
    Definition Classes
    TransferredInTransferEvent
  55. def unnamedParam[T, V](getValue: (T) => V, cond: (T) => Boolean = (_: T) => true)(implicit arg0: Pretty[V]): (T) => Option[Tree]

    A tree representing a parameter value without a parameter name.

    A tree representing a parameter value without a parameter name.

    Definition Classes
    PrettyUtil
  56. def unnamedParamIfDefined[T, V](getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  57. def unnamedParamIfNonEmpty[T, V <: IterableOnce[_]](getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  58. val updateId: LedgerTransactionId
  59. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  60. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  61. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  62. val workflowId: Option[LfWorkflowId]
    Definition Classes
    TransferredInTransferEvent

Deprecated Value Members

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

Inherited from TransferEvent

Inherited from WithDomainId

Inherited from LedgerSyncEvent

Inherited from PrettyPrinting

Inherited from PrettyUtil

Inherited from ShowUtil

Inherited from ShowSyntax

Inherited from ToShowOps

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped