Package org.apache.beam.sdk.io.aws2.kinesis

Interface RateLimitPolicyFactory

All Superinterfaces:

Serializable

public interface RateLimitPolicyFactory
extends Serializable

Implement this interface to create a RateLimitPolicy. Used to create a rate limiter for each shard. The factory will be called from multiple threads, so if it returns a singleton instance of RateLimitPolicy then that instance should be thread-safe, otherwise it should return separate RateLimitPolicy instances.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	RateLimitPolicyFactory.DefaultRateLimiter	Default rate limiter that throttles reading from a shard using an exponential backoff if the response is empty or if the consumer is throttled by AWS.
static class	RateLimitPolicyFactory.DelayIntervalRateLimiter

Method Summary

Modifier and Type	Method	Description
RateLimitPolicy	getRateLimitPolicy()
static RateLimitPolicyFactory	withDefaultRateLimiter()
static RateLimitPolicyFactory	withDefaultRateLimiter(Duration emptySuccessBaseDelay, Duration throttledBaseDelay, Duration maxDelay)
static RateLimitPolicyFactory	withDelay(Supplier<Duration> delay)
static RateLimitPolicyFactory	withFixedDelay()
static RateLimitPolicyFactory	withFixedDelay(Duration delay)
static RateLimitPolicyFactory	withoutLimiter()

Method Details

getRateLimitPolicy

RateLimitPolicy getRateLimitPolicy()

withoutLimiter

static RateLimitPolicyFactory withoutLimiter()

withDefaultRateLimiter

static RateLimitPolicyFactory withDefaultRateLimiter()

withDefaultRateLimiter

static RateLimitPolicyFactory withDefaultRateLimiter(Duration emptySuccessBaseDelay,
 Duration throttledBaseDelay,
 Duration maxDelay)

withFixedDelay

static RateLimitPolicyFactory withFixedDelay()

withFixedDelay

static RateLimitPolicyFactory withFixedDelay(Duration delay)

withDelay

static RateLimitPolicyFactory withDelay(Supplier<Duration> delay)