Class/Object

com.snowplowanalytics.manifest.core

ProcessingManifest

Related Docs: object ProcessingManifest | package core

Permalink

abstract class ProcessingManifest[F[_]] extends AnyRef

Base trait for processing manifest functionality

F

effect producing by interaction with manifest

Linear Supertypes
AnyRef, Any
Known Subclasses
DynamoDbManifest, PureManifest
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ProcessingManifest
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ProcessingManifest(resolver: Resolver)(implicit F: ManifestAction[F])

    Permalink

Abstract Value Members

  1. abstract def fetch(processedBy: Option[Application], state: Option[State])(implicit F: ManifestAction[F], S: Sync[F]): Stream[F, ItemId]

    Permalink

  2. abstract def getItem(id: ItemId): F[Option[Item]]

    Permalink

    Get state of single item, with validating state of Item

  3. abstract def put(itemId: ItemId, app: Application, previousRecordId: Option[UUID], state: State, author: Option[Agent], payload: Option[Payload]): F[(UUID, Instant)]

    Permalink

    Add an atomic record to manifest

  4. abstract def stream(implicit S: Sync[F]): Stream[F, Record]

    Permalink

    Get full manifest

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  10. def getUnprocessed(itemIds: Stream[F, ItemId], predicate: (Item) ⇒ Boolean)(implicit S: Sync[F]): F[List[Item]]

    Permalink

    Get items from collection of ids that: + were processed by preprocessor application + were NOT yet processed by specified application + match predicate function + not in "blocked" or "failed" state

    Get items from collection of ids that: + were processed by preprocessor application + were NOT yet processed by specified application + match predicate function + not in "blocked" or "failed" state

    predicate

    filter function to get only valid Items, e.g. containing particular payload

  11. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  13. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  14. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  15. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  16. def processAll(app: Application, predicate: (Item) ⇒ Boolean, acquirePayload: Option[Payload], process: Process)(implicit S: Sync[F]): F[Unit]

    Permalink

    Apply Process function to all items unprocessed by app For each item, lock will be held.

    Apply Process function to all items unprocessed by app For each item, lock will be held. If any of items already holding a lock, function breaks immediately

  17. def processItem(app: Application, acquirePayload: Option[Payload], process: Process)(item: Item): F[(UUID, Instant)]

    Permalink

    Acquire lock, apply processing function and write its result back to manifest

  18. def processNewItem(id: ItemId, app: Application, acquirePayload: Option[Payload], process: ProcessNew): F[Unit]

    Permalink

    Similar to processItem, but works without existing Item, instead it creates new one itself or queries it by known id Should be used when app is both adding item to manifest and processes it straight afterwards

    Similar to processItem, but works without existing Item, instead it creates new one itself or queries it by known id Should be used when app is both adding item to manifest and processes it straight afterwards

    id

    new item id, which should be either fetched or created

    app

    application doing discovering and processing

    acquirePayload

    optional payload that will be added as part of Processing, can be e.g. notification that app started to process it with some special configuration (cross-batch dedupe enabled)

    process

    Process that does not expect existing item

  19. def query(preparedBy: Option[Application], requester: Option[Application])(implicit S: Sync[F]): Stream[F, ItemId]

    Permalink

    Get ids of items that were processed by processedBy and NOT processed by application Most common kind of query for Processing Manifest.

  20. val resolver: Resolver

    Permalink

  21. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  22. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  23. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  24. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  25. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped