o

akka.stream.contrib

PagedSource

object PagedSource

Defines a factory for PagedSource.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PagedSource
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. case class Page[T, K](items: Iterable[T], nextKey: Option[K]) extends Product with Serializable
  2. type PagedSource[T] = Source[T, NotUsed]

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 apply[T, K](firstKey: K)(f: (K) ⇒ Future[Page[T, K]])(implicit executor: ExecutionContext): PagedSource[T]

    PagedSource factory.

    PagedSource factory.

    PagesSource is a Source streaming items from a paged API. The paged API is accessed with a page key and returns data. This data contain a list of items and optional information about the key of the next page.

    T

    type of page items

    K

    type of page keys

    firstKey

    key of first page

    f

    map page key to Future of page data

    executor

    execution context for futures

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  7. def create[T, K](firstKey: K, f: Function[K, Future[Page[T, K]]], executor: ExecutionContext): PagedSource[T]

    Java API: PagedSource factory.

    Java API: PagedSource factory.

    PagesSource is a Source streaming items from a paged API. The paged API is accessed with a page key and returns data. This data contain a list of items and optional information about the key of the next page.

    T

    type of page items

    K

    type of page keys

    firstKey

    key of first page

    f

    map page key to Future of page data

    executor

    execution context for futures

    returns

    PagedSource instance

  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped