Package org.apache.flink.api.common.io.ratelimiting

Class GuavaFlinkConnectorRateLimiter

java.lang.Object

org.apache.flink.api.common.io.ratelimiting.GuavaFlinkConnectorRateLimiter

All Implemented Interfaces:

Serializable, FlinkConnectorRateLimiter

public class GuavaFlinkConnectorRateLimiter
extends Object
implements FlinkConnectorRateLimiter

An implementation of FlinkConnectorRateLimiter that uses Guava's RateLimiter for rate limiting.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
GuavaFlinkConnectorRateLimiter()

Method Summary

Modifier and Type	Method	Description
void	acquire(int permits)	Acquires permits for the rate limiter.
void	close()
long	getRate()
void	open(RuntimeContext runtimeContext)	Creates a rate limiter with the runtime context provided.
void	setRate(long globalRate)	Set the global per consumer and per sub-task rates.

Methods inherited from class java.lang.Object

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

Constructor Detail

GuavaFlinkConnectorRateLimiter

public GuavaFlinkConnectorRateLimiter()

Method Detail

open

public void open(RuntimeContext runtimeContext)

Creates a rate limiter with the runtime context provided.

Specified by:

open in interface FlinkConnectorRateLimiter

Parameters:

runtimeContext -

setRate

public void setRate(long globalRate)

Set the global per consumer and per sub-task rates.

Specified by:

setRate in interface FlinkConnectorRateLimiter

Parameters:

globalRate - Value of rate in bytes per second.

acquire

public void acquire(int permits)

Description copied from interface: FlinkConnectorRateLimiter

Acquires permits for the rate limiter.

Specified by:

acquire in interface FlinkConnectorRateLimiter

getRate

public long getRate()

Specified by:

getRate in interface FlinkConnectorRateLimiter

close

public void close()

Specified by:

close in interface FlinkConnectorRateLimiter