Packages

object updates extends Helpful

Annotations
@Summary(s = "Read from update stream", flag = FeatureFlag.Testing) @Group(name = "Updates")
Linear Supertypes
Helpful, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. updates
  2. Helpful
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def by_id(parties: Set[PartyId], id: String): Option[TransactionTree]
    Annotations
    @Summary(s = "Get a (tree) transaction by its ID", flag = FeatureFlag.Testing) @Description(s = """Get a transaction tree from the update stream by its ID. Returns None if the transaction is not (yet)
    |known at the participant or if the transaction has been pruned via `pruning.prune`."""    )
  6. def by_offset(parties: Set[PartyId], offset: Long): Option[TransactionTree]
    Annotations
    @Summary(s = "Get a transaction tree by its offset", flag = FeatureFlag.Testing) @Description(s = """Get a transaction tree from the update stream by its offset. Returns None if the transaction is not (yet)
    |known at the participant or if the transaction has been pruned via `pruning.prune`."""    )
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. def flat(partyIds: Set[PartyId], completeAfter: PositiveInt, beginOffsetExclusive: Long = 0L, endOffsetInclusive: Option[Long] = None, verbose: Boolean = true, timeout: NonNegativeDuration = timeouts.ledgerCommand, resultFilter: (UpdateWrapper) => Boolean = _ => true, synchronizerFilter: Option[SynchronizerId] = None): Seq[UpdateWrapper]
    Annotations
    @Summary(s = "Get flat updates", flag = FeatureFlag.Testing) @Description(s = """This function connects to the flat update stream for the given parties and collects updates
    |until either `completeAfter` flat updates have been received or `timeout` has elapsed.
    |The returned updates can be filtered to be between the given offsets (default: no filtering).
    |If the participant has been pruned via `pruning.prune` and if `beginOffset` is lower than the pruning offset,
    |this command fails with a `NOT_FOUND` error. If you need to specify filtering conditions for template IDs and
    |including create event blobs for explicit disclosure, consider using `flat_with_tx_filter`.
    |If the beginOffset is zero then the participant begin is taken as beginning offset.
    |If the endOffset is None then a continuous stream is returned."""    )
  11. def flat_with_tx_filter(filter: TransactionFilter, completeAfter: PositiveInt, beginOffsetExclusive: Long = 0L, endOffsetInclusive: Option[Long] = None, verbose: Boolean = true, timeout: NonNegativeDuration = timeouts.ledgerCommand, resultFilter: (UpdateWrapper) => Boolean = _ => true): Seq[UpdateWrapper]
    Annotations
    @Summary(s = "Get flat updates", flag = FeatureFlag.Testing) @Description(s = """This function connects to the flat update stream for the given transaction filter and collects updates
    |until either `completeAfter` transactions have been received or `timeout` has elapsed.
    |The returned transactions can be filtered to be between the given offsets (default: no filtering).
    |If the participant has been pruned via `pruning.prune` and if `beginOffset` is lower than the pruning offset,
    |this command fails with a `NOT_FOUND` error. If you only need to filter by a set of parties, consider using
    |`flat` instead.
    |If the beginOffset is zero then the participant begin is taken as beginning offset.
    |If the endOffset is None then a continuous stream is returned."""    )
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  14. def help(methodName: String)(implicit consoleEnvironment: ConsoleEnvironment): Unit
    Definition Classes
    Helpful
    Annotations
    @Summary(s = "Help for specific commands (use help() or help(\"method\") for more information)", flag = console.this.Help.Summary.<init>$default$2) @Topic(t = Seq("Top-level Commands"))
  15. def help()(implicit consoleEnvironment: ConsoleEnvironment): Unit
    Definition Classes
    Helpful
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  20. def reassignments(partyIds: Set[PartyId], filterTemplates: Seq[TemplateId], completeAfter: PositiveInt, beginOffsetExclusive: Long = 0L, endOffsetInclusive: Option[Long] = None, timeout: NonNegativeDuration = timeouts.ledgerCommand, resultFilter: (UpdateWrapper) => Boolean = _ => true, synchronizerFilter: Option[SynchronizerId] = None): Seq[ReassignmentWrapper]
    Annotations
    @Summary(s = "Get reassignments", flag = FeatureFlag.Testing) @Description(s = """This function connects to the update stream for the given parties and template ids and collects reassignment
    |events (assigned and unassigned) until either `completeAfter` updates have been received or `timeout` has
    |elapsed.
    |If the party ids set is empty then the reassignments for all the parties will be fetched.
    |If the template ids collection is empty then the reassignments for all the template ids will be fetched.
    |The returned updates can be filtered to be between the given offsets (default: no filtering).
    |If the participant has been pruned via `pruning.prune` and if `beginOffset` is lower than the pruning offset,
    |this command fails with a `NOT_FOUND` error.
    |If the beginOffset is zero then the participant begin is taken as beginning offset.
    |If the endOffset is None then a continuous stream is returned."""    )
  21. def start_measuring(parties: Set[PartyId], metricName: String, onUpdate: (UpdateTreeWrapper) => Unit = _ => ())(implicit consoleEnvironment: ConsoleEnvironment): AutoCloseable
    Annotations
    @Summary(s = "Starts measuring throughput at the update service", flag = FeatureFlag.Testing) @Description(s = """This function will subscribe on behalf of `parties` to the update tree stream and
    |notify various metrics:
    |The metric `<name>.<metricSuffix>` counts the number of update trees emitted.
    |The metric `<name>.<metricSuffix>-tx-node-count` tracks the number of events emitted as part of update trees.
    |The metric `<name>.<metricSuffix>-tx-size` tracks the number of bytes emitted as part of update trees.
    |
    |To stop measuring, you need to close the returned `AutoCloseable`.
    |Use the `onUpdate` parameter to register a callback that is called on every update tree."""    )
  22. def subscribe_flat(observer: StreamObserver[UpdateWrapper], filter: TransactionFilter, beginOffsetExclusive: Long = 0L, endOffsetInclusive: Option[Long] = None, verbose: Boolean = true): AutoCloseable
    Annotations
    @Summary(s = "Subscribe to the flat update stream", flag = FeatureFlag.Testing) @Description(s = """This function connects to the flat update stream and passes updates to `observer` until
    |the stream is completed.
    |Only updates for parties in `filter.filterByParty.keys` will be returned.
    |Use `filter = TransactionFilter(Map(myParty.toLf -> Filters()))` to return all updates for `myParty: PartyId`.
    |The returned updates can be filtered to be between the given offsets (default: no filtering).
    |If the participant has been pruned via `pruning.prune` and if `beginOffset` is lower than the pruning offset,
    |this command fails with a `NOT_FOUND` error.
    |If the beginOffset is zero then the participant begin is taken as beginning offset.
    |If the endOffset is None then a continuous stream is returned."""    )
  23. def subscribe_trees(observer: StreamObserver[UpdateTreeWrapper], filter: TransactionFilter, beginOffsetExclusive: Long = 0L, endOffsetInclusive: Option[Long] = None, verbose: Boolean = true): AutoCloseable
    Annotations
    @Summary(s = "Subscribe to the update tree stream", flag = FeatureFlag.Testing) @Description(s = """This function connects to the update tree stream and passes update trees to `observer` until
    |the stream is completed.
    |Only update trees for parties in `filter.filterByParty.keys` will be returned.
    |Use `filter = TransactionFilter(Map(myParty.toLf -> Filters()))` to return all trees for `myParty: PartyId`.
    |The returned updates can be filtered to be between the given offsets (default: no filtering).
    |If the participant has been pruned via `pruning.prune` and if `beginOffset` is lower than the pruning offset,
    |this command fails with a `NOT_FOUND` error.
    |If the beginOffset is zero then the participant begin is taken as beginning offset.
    |If the endOffset is None then a continuous stream is returned."""    )
  24. def subscribe_updates(observer: StreamObserver[UpdateWrapper], updateFormat: UpdateFormat, beginOffsetExclusive: Long = 0L, endOffsetInclusive: Option[Long] = None): AutoCloseable
    Annotations
    @Summary(s = "Subscribe to the update stream", flag = FeatureFlag.Testing) @Description(s = """This function connects to the update stream and passes updates to `observer` until the stream
    |is completed.
    |The updates as described in the update format will be returned.
    |Use `EventFormat(Map(myParty.toLf -> Filters()))` to return transactions or reassignments for
    |`myParty: PartyId`.
    |The returned updates can be filtered to be between the given offsets (default: no filtering).
    |If the participant has been pruned via `pruning.prune` and if `beginOffset` is lower than the pruning offset,
    |this command fails with a `NOT_FOUND` error.
    |If the beginOffset is zero then the participant begin is taken as beginning offset.
    |If the endOffset is None then a continuous stream is returned."""    )
  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. def toString(): String
    Definition Classes
    AnyRef → Any
  27. def topology_transactions(completeAfter: PositiveInt, partyIds: Seq[PartyId] = Seq.empty, beginOffsetExclusive: Long = 0L, endOffsetInclusive: Option[Long] = None, timeout: NonNegativeDuration = timeouts.ledgerCommand, resultFilter: (UpdateWrapper) => Boolean = _ => true, synchronizerFilter: Option[SynchronizerId] = None): Seq[TopologyTransactionWrapper]
    Annotations
    @Summary(s = "Get topology transactions", flag = FeatureFlag.Testing) @Description(s = """This function connects to the update stream for the given parties and collects topology transaction
    |events until either `completeAfter` updates have been received or `timeout` has elapsed.
    |If the party ids seq is empty then the topology transactions for all the parties will be fetched.
    |The returned updates can be filtered to be between the given offsets (default: no filtering).
    |If the participant has been pruned via `pruning.prune` and if `beginOffset` is lower than the pruning offset,
    |this command fails with a `NOT_FOUND` error.
    |If the beginOffset is zero then the participant begin is taken as beginning offset.
    |If the endOffset is None then a continuous stream is returned."""    )
  28. def trees(partyIds: Set[PartyId], completeAfter: PositiveInt, beginOffsetExclusive: Long = 0L, endOffsetInclusive: Option[Long] = None, verbose: Boolean = true, timeout: NonNegativeDuration = timeouts.ledgerCommand, resultFilter: (UpdateTreeWrapper) => Boolean = _ => true): Seq[UpdateTreeWrapper]
    Annotations
    @Summary(s = "Get update trees", flag = FeatureFlag.Testing) @Description(s = """This function connects to the update tree stream for the given parties and collects update trees
    |until either `completeAfter` update trees have been received or `timeout` has elapsed.
    |The returned update trees can be filtered to be between the given offsets (default: no filtering).
    |If the participant has been pruned via `pruning.prune` and if `beginOffset` is lower than the pruning offset,
    |this command fails with a `NOT_FOUND` error.
    |If the beginOffset is zero then the participant begin is taken as beginning offset.
    |If the endOffset is None then a continuous stream is returned."""    )
  29. def trees_with_tx_filter(filter: TransactionFilter, completeAfter: PositiveInt, beginOffsetExclusive: Long = 0L, endOffsetInclusive: Option[Long] = None, verbose: Boolean = true, timeout: NonNegativeDuration = timeouts.ledgerCommand, resultFilter: (UpdateTreeWrapper) => Boolean = _ => true): Seq[UpdateTreeWrapper]
    Annotations
    @Summary(s = "Get update trees", flag = FeatureFlag.Testing) @Description(s = """This function connects to the update tree stream for the transaction filter and collects update trees
    |until either `completeAfter` update trees have been received or `timeout` has elapsed.
    |The returned update trees can be filtered to be between the given offsets (default: no filtering).
    |If the participant has been pruned via `pruning.prune` and if `beginOffset` is lower than the pruning offset,
    |this command fails with a `NOT_FOUND` error.
    |NOTE: As opposed to the flat transaction streams, the transaction filter provided for transaction trees DO NOT
    | filter the events in the tree, but decide instead the event payloads projection rules.
    | (e.g. whether to include in the CreatedEvent the created event blob).
    |If the beginOffset is zero then the participant begin is taken as beginning offset.
    |If the endOffset is None then a continuous stream is returned."""    )
  30. def update_by_id(id: String, updateFormat: UpdateFormat): Option[UpdateWrapper]
    Annotations
    @Summary(s = "Get an update by its ID", flag = FeatureFlag.Testing) @Description(s = """Get an update by its ID. Returns None if the update is not (yet) known at the participant or all the events
    |of the update are filtered due to the update format or if the update has been pruned via `pruning.prune`."""    )
  31. def update_by_offset(offset: Long, updateFormat: UpdateFormat): Option[UpdateWrapper]
    Annotations
    @Summary(s = "Get an update by its offset", flag = FeatureFlag.Testing) @Description(s = """Get an update by its offset. Returns None if the update is not (yet) known at the participant or all the
    |events of the update are filtered due to the update format or if the update has been pruned via
    |`pruning.prune`."""    )
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  34. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

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 Helpful

Inherited from AnyRef

Inherited from Any

Ungrouped