c

com.spotify.scio.transforms

ScalaAsyncLookupDoFn

abstract class ScalaAsyncLookupDoFn[A, B, C] extends BaseAsyncLookupDoFn[A, B, C, Future[B], Try[B]] with ScalaFutureHandlers[B]

A DoFn that performs asynchronous lookup using the provided client for Scala Future.

A

input element type.

B

client lookup value type.

C

client type.

Source
ScalaAsyncLookupDoFn.scala
Linear Supertypes
ScalaFutureHandlers[B], BaseAsyncLookupDoFn[A, B, C, Future[B], Try[B]], Base[Future[B], B], DoFnWithResource[A, KV[A, Try[B]], Pair[C, Cache[A, B]]], DoFn[A, KV[A, Try[B]]], HasDisplayData, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ScalaAsyncLookupDoFn
  2. ScalaFutureHandlers
  3. BaseAsyncLookupDoFn
  4. Base
  5. DoFnWithResource
  6. DoFn
  7. HasDisplayData
  8. Serializable
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ScalaAsyncLookupDoFn(maxPendingRequests: Int, cacheSupplier: CacheSupplier[A, B])

    maxPendingRequests

    maximum number of pending requests on every cloned DoFn. This prevents runner from timing out and retrying bundles.

    cacheSupplier

    supplier for lookup cache.

  2. new ScalaAsyncLookupDoFn(maxPendingRequests: Int)

    maxPendingRequests

    maximum number of pending requests on every cloned DoFn. This prevents runner from timing out and retrying bundles.

  3. new ScalaAsyncLookupDoFn()
  4. new ScalaAsyncLookupDoFn(maxPendingRequests: Int, deduplicate: Boolean, cacheSupplier: CacheSupplier[A, B])

Type Members

  1. abstract class FinishBundleContext extends AnyRef
    Definition Classes
    DoFn
  2. abstract class OnTimerContext extends WindowedContext
    Definition Classes
    DoFn
  3. abstract class OnWindowExpirationContext extends WindowedContext
    Definition Classes
    DoFn
  4. abstract class ProcessContext extends WindowedContext
    Definition Classes
    DoFn
  5. abstract class StartBundleContext extends AnyRef
    Definition Classes
    DoFn
  6. abstract class WindowedContext extends AnyRef
    Definition Classes
    DoFn

Abstract Value Members

  1. abstract def asyncLookup(client: C, input: A): Future[B]

    Perform asynchronous lookup.

    Perform asynchronous lookup.

    Definition Classes
    BaseAsyncLookupDoFn
  2. abstract def getResourceType(): ResourceType

    Get resource type.

    Get resource type.

    Definition Classes
    DoFnWithResource
  3. abstract def newClient(): C

    Creates the client.

    Creates the client.

    Attributes
    protected[transforms]
    Definition Classes
    BaseAsyncLookupDoFn
  4. abstract object FinishBundleContext
    Definition Classes
    DoFn
  5. abstract object ProcessContext
    Definition Classes
    DoFn
  6. abstract object StartBundleContext
    Definition Classes
    DoFn
  7. abstract object WindowedContext
    Definition Classes
    DoFn

Concrete 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 addCallback(future: Future[B], onSuccess: Function[B, Void], onFailure: Function[Throwable, Void]): Future[B]
    Definition Classes
    ScalaFutureHandlers → Base
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. def closeResource(resource: Pair[C, Cache[A, B]]): Unit

    Close resource.

    Close resource.

    Default implementation closes AutoCloseable resource.

    Definition Classes
    BaseAsyncLookupDoFn → DoFnWithResource
    Annotations
    @Override()
  8. def createResource(): Pair[C, Cache[A, B]]

    Create resource.

    Create resource.

    DoFnWithResource#getResourceType() determines how many times this is called.

    Definition Classes
    BaseAsyncLookupDoFn → DoFnWithResource
    Annotations
    @Override()
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  11. def failure(throwable: Throwable): Try[B]

    Wrap output in a failed Try.

    Wrap output in a failed Try.

    Definition Classes
    ScalaAsyncLookupDoFn → BaseAsyncLookupDoFn
  12. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  13. def finishBundle(context: FinishBundleContext): Unit
    Definition Classes
    BaseAsyncLookupDoFn
    Annotations
    @FinishBundle()
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. def getInputTypeDescriptor(): TypeDescriptor[A]
    Definition Classes
    DoFn
  16. def getOutputTypeDescriptor(): TypeDescriptor[KV[A, Try[B]]]
    Definition Classes
    DoFn
  17. def getResource(): Pair[C, Cache[A, B]]

    Get managed resource.

    Get managed resource.

    Definition Classes
    DoFnWithResource
    Annotations
    @SuppressWarnings()
  18. def getResourceCache(): Cache[A, B]
    Definition Classes
    BaseAsyncLookupDoFn
  19. def getResourceClient(): C
    Definition Classes
    BaseAsyncLookupDoFn
  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. def populateDisplayData(builder: Builder): Unit
    Definition Classes
    DoFnWithResource → DoFn → HasDisplayData
    Annotations
    @Override()
  26. def processElement(input: A, timestamp: Instant, out: OutputReceiver[KV[A, Try[B]]], window: BoundedWindow): Unit
    Definition Classes
    BaseAsyncLookupDoFn
    Annotations
    @SuppressWarnings() @ProcessElement()
  27. def setup(): Unit
    Definition Classes
    DoFnWithResource
    Annotations
    @Setup()
  28. def startBundle(context: StartBundleContext): Unit
    Definition Classes
    BaseAsyncLookupDoFn
    Annotations
    @StartBundle()
  29. def success(output: B): Try[B]

    Wrap output in a successful Try.

    Wrap output in a successful Try.

    Definition Classes
    ScalaAsyncLookupDoFn → BaseAsyncLookupDoFn
  30. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  31. def teardown(): Unit
    Definition Classes
    DoFnWithResource
    Annotations
    @Teardown()
  32. def toString(): String
    Definition Classes
    AnyRef → Any
  33. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  34. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  35. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  36. def waitForFutures(futures: Iterable[Future[B]]): Unit
    Definition Classes
    ScalaFutureHandlers → Base

Deprecated Value Members

  1. def getAllowedTimestampSkew(): Duration
    Definition Classes
    DoFn
    Annotations
    @Deprecated
    Deprecated
  2. final def prepareForProcessing(): Unit
    Definition Classes
    DoFn
    Annotations
    @Deprecated
    Deprecated

Inherited from ScalaFutureHandlers[B]

Inherited from BaseAsyncLookupDoFn[A, B, C, Future[B], Try[B]]

Inherited from Base[Future[B], B]

Inherited from DoFnWithResource[A, KV[A, Try[B]], Pair[C, Cache[A, B]]]

Inherited from DoFn[A, KV[A, Try[B]]]

Inherited from HasDisplayData

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped