org.apache.beam.sdk.io.kinesis

Class RateLimitPolicyFactory.DefaultRateLimiter

java.lang.Object

org.apache.beam.sdk.io.kinesis.RateLimitPolicyFactory.DefaultRateLimiter

All Implemented Interfaces:

RateLimitPolicy

Enclosing interface:

RateLimitPolicyFactory

public static class RateLimitPolicyFactory.DefaultRateLimiter
extends java.lang.Object
implements RateLimitPolicy

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.

Constructor Summary

Constructors

Constructor and Description
DefaultRateLimiter(org.apache.beam.sdk.util.BackOff emptySuccess, org.apache.beam.sdk.util.BackOff throttled)
DefaultRateLimiter(Duration emptySuccessBaseDelay, Duration throttledBaseDelay, Duration maxDelay)

Method Summary

Modifier and Type	Method and Description
void	onSuccess(java.util.List<KinesisRecord> records) Called after Kinesis records are successfully retrieved.
void	onThrottle(KinesisClientThrottledException e) Called after the Kinesis client is throttled.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultRateLimiter

public DefaultRateLimiter(org.apache.beam.sdk.util.BackOff emptySuccess,
                          org.apache.beam.sdk.util.BackOff throttled)

DefaultRateLimiter

public DefaultRateLimiter(Duration emptySuccessBaseDelay,
                          Duration throttledBaseDelay,
                          Duration maxDelay)

Method Detail

onSuccess

public void onSuccess(java.util.List<KinesisRecord> records)
               throws java.lang.InterruptedException

Description copied from interface: RateLimitPolicy

Called after Kinesis records are successfully retrieved.

Specified by:

onSuccess in interface RateLimitPolicy

Parameters:

records - The list of retrieved records.

Throws:

java.lang.InterruptedException

onThrottle

public void onThrottle(KinesisClientThrottledException e)
                throws java.lang.InterruptedException

Description copied from interface: RateLimitPolicy

Called after the Kinesis client is throttled.

Specified by:

onThrottle in interface RateLimitPolicy

Parameters:

e - The KinesisClientThrottledException thrown by the client.

Throws:

java.lang.InterruptedException