org.apache.flink.connector.base.sink.writer.strategy

Class CongestionControlRateLimitingStrategy

java.lang.Object

org.apache.flink.connector.base.sink.writer.strategy.CongestionControlRateLimitingStrategy

All Implemented Interfaces:

RateLimitingStrategy

@PublicEvolving
public class CongestionControlRateLimitingStrategy
extends Object
implements RateLimitingStrategy

A RateLimitingStrategy implementation that does the following:

• Scales up when any request is successful.
• Scales down when any message in a request is unsuccessful.
• Uses a scaling strategy to scale up/down depending on whether the request is successful.

This strategy works well for throughput-limited record-based sinks (e.g. Kinesis, Kafka).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CongestionControlRateLimitingStrategy.CongestionControlRateLimitingStrategyBuilder Builder for CongestionControlRateLimitingStrategy.

Method Summary

Modifier and Type	Method and Description
static CongestionControlRateLimitingStrategy.CongestionControlRateLimitingStrategyBuilder	builder()
int	getMaxBatchSize() Returns the current max batch size that RateLimitingStrategy will allow through.
void	registerCompletedRequest(ResultInfo resultInfo) Registers the result of completed requests (e.g. to track the current inFlightMessages / requests).
void	registerInFlightRequest(RequestInfo requestInfo) Registers the information of requests being sent (e.g. to track the current inFlightMessages / requests).
boolean	shouldBlock(RequestInfo requestInfo) Decides whether the next request should be blocked.

Methods inherited from class java.lang.Object

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

Method Detail

registerInFlightRequest

public void registerInFlightRequest(RequestInfo requestInfo)

Description copied from interface: RateLimitingStrategy

Registers the information of requests being sent (e.g. to track the current inFlightMessages / requests).

Specified by:

registerInFlightRequest in interface RateLimitingStrategy

Parameters:

requestInfo - Data class containing information on request being sent

registerCompletedRequest

public void registerCompletedRequest(ResultInfo resultInfo)

Description copied from interface: RateLimitingStrategy

Registers the result of completed requests (e.g. to track the current inFlightMessages / requests). Any dynamic scaling on failed messages should be done here.

Specified by:

registerCompletedRequest in interface RateLimitingStrategy

Parameters:

resultInfo - Data class containing information on request completed

shouldBlock

public boolean shouldBlock(RequestInfo requestInfo)

Description copied from interface: RateLimitingStrategy

Decides whether the next request should be blocked.

Specified by:

shouldBlock in interface RateLimitingStrategy

Parameters:

requestInfo - Data class containing information on request being sent

getMaxBatchSize

public int getMaxBatchSize()

Description copied from interface: RateLimitingStrategy

Returns the current max batch size that RateLimitingStrategy will allow through. This is required so that the component that constructs the ResultInfo that is passed into RateLimitingStrategy.shouldBlock(RequestInfo) can construct a passable ResultInfo.

Specified by:

getMaxBatchSize in interface RateLimitingStrategy

builder

@PublicEvolving
public static CongestionControlRateLimitingStrategy.CongestionControlRateLimitingStrategyBuilder builder()