c

com.spotify.scio.transforms

RateLimiterDoFn

class RateLimiterDoFn[InputT] extends DoFnWithResource[InputT, InputT, RateLimiter]

DoFn which will rate limit the number of elements processed per second.

Used to rate limit throughput for a job writing to a database or making calls to external services. The limit is applied per worker and should be used with a fixed/max num workers. Having RateLimiterDoFn(1000) and 20 workers means your total rate will be 20000.

Source
RateLimiterDoFn.java
Linear Supertypes
DoFnWithResource[InputT, InputT, RateLimiter], DoFn[InputT, InputT], HasDisplayData, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RateLimiterDoFn
  2. DoFnWithResource
  3. DoFn
  4. HasDisplayData
  5. Serializable
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new RateLimiterDoFn(recordsPerSecond: Double)

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 object FinishBundleContext
    Definition Classes
    DoFn
  2. abstract object ProcessContext
    Definition Classes
    DoFn
  3. abstract object StartBundleContext
    Definition Classes
    DoFn
  4. 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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. def closeResource(resource: RateLimiter): Unit

    Close resource.

    Close resource.

    Default implementation closes AutoCloseable resource.

    Definition Classes
    DoFnWithResource
  7. def createResource(): RateLimiter

    Create resource.

    Create resource.

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

    Definition Classes
    RateLimiterDoFn → DoFnWithResource
    Annotations
    @Override()
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def getInputTypeDescriptor(): TypeDescriptor[InputT]
    Definition Classes
    DoFn
  13. def getOutputTypeDescriptor(): TypeDescriptor[InputT]
    Definition Classes
    DoFn
  14. def getResource(): RateLimiter

    Get managed resource.

    Get managed resource.

    Definition Classes
    DoFnWithResource
    Annotations
    @SuppressWarnings()
  15. def getResourceType(): ResourceType

    Get resource type.

    Get resource type.

    Definition Classes
    RateLimiterDoFn → DoFnWithResource
    Annotations
    @Override()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. def populateDisplayData(builder: Builder): Unit
    Definition Classes
    DoFnWithResource → DoFn → HasDisplayData
    Annotations
    @Override()
  22. def processElement(element: InputT, out: OutputReceiver[InputT]): Unit
    Annotations
    @ProcessElement()
  23. def setup(): Unit
    Definition Classes
    DoFnWithResource
    Annotations
    @Setup()
  24. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  25. def teardown(): Unit
    Definition Classes
    DoFnWithResource
    Annotations
    @Teardown()
  26. def toString(): String
    Definition Classes
    AnyRef → Any
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

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 DoFnWithResource[InputT, InputT, RateLimiter]

Inherited from DoFn[InputT, InputT]

Inherited from HasDisplayData

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped