org.apache.flink.streaming.connectors.kinesis.proxy

Class KinesisProxyV2

java.lang.Object

org.apache.flink.streaming.connectors.kinesis.proxy.KinesisProxyV2

All Implemented Interfaces:

KinesisProxyV2Interface

@Internal
public class KinesisProxyV2
extends Object
implements KinesisProxyV2Interface

Kinesis proxy implementation using AWS SDK v2.x - a utility class that is used as a proxy to make calls to AWS Kinesis for several EFO (Enhanced Fan Out) functions, such as de-/registering stream consumers, subscribing to a shard and receiving records from a shard.

Constructor Summary

Constructors

Constructor and Description
KinesisProxyV2(software.amazon.awssdk.services.kinesis.KinesisAsyncClient kinesisAsyncClient, software.amazon.awssdk.http.async.SdkAsyncHttpClient httpClient, FanOutRecordPublisherConfiguration fanOutRecordPublisherConfiguration, FullJitterBackoff backoff) Create a new KinesisProxyV2.

Method Summary

Modifier and Type	Method and Description
void	close() Destroy any open resources used by the factory.
software.amazon.awssdk.services.kinesis.model.DeregisterStreamConsumerResponse	deregisterStreamConsumer(String consumerArn)
software.amazon.awssdk.services.kinesis.model.DescribeStreamConsumerResponse	describeStreamConsumer(String streamConsumerArn)
software.amazon.awssdk.services.kinesis.model.DescribeStreamConsumerResponse	describeStreamConsumer(String streamArn, String consumerName)
software.amazon.awssdk.services.kinesis.model.DescribeStreamSummaryResponse	describeStreamSummary(String stream)
software.amazon.awssdk.services.kinesis.model.RegisterStreamConsumerResponse	registerStreamConsumer(String streamArn, String consumerName)
CompletableFuture<Void>	subscribeToShard(software.amazon.awssdk.services.kinesis.model.SubscribeToShardRequest request, software.amazon.awssdk.services.kinesis.model.SubscribeToShardResponseHandler responseHandler)

Methods inherited from class java.lang.Object

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

Constructor Detail

KinesisProxyV2

public KinesisProxyV2(software.amazon.awssdk.services.kinesis.KinesisAsyncClient kinesisAsyncClient,
                      software.amazon.awssdk.http.async.SdkAsyncHttpClient httpClient,
                      FanOutRecordPublisherConfiguration fanOutRecordPublisherConfiguration,
                      FullJitterBackoff backoff)

Create a new KinesisProxyV2.

Parameters:

kinesisAsyncClient - AWS SDK v2 Kinesis client used to communicate with AWS services

httpClient - the underlying HTTP client, reference required for close only

fanOutRecordPublisherConfiguration - the configuration for Fan Out features

backoff - the backoff utility used to introduce Full Jitter delays

Method Detail

subscribeToShard

public CompletableFuture<Void> subscribeToShard(software.amazon.awssdk.services.kinesis.model.SubscribeToShardRequest request,
                                                software.amazon.awssdk.services.kinesis.model.SubscribeToShardResponseHandler responseHandler)

Specified by:

subscribeToShard in interface KinesisProxyV2Interface

close

public void close()

Description copied from interface: KinesisProxyV2Interface

Destroy any open resources used by the factory.

Specified by:

close in interface KinesisProxyV2Interface

describeStreamSummary

public software.amazon.awssdk.services.kinesis.model.DescribeStreamSummaryResponse describeStreamSummary(String stream)
                                                                                                  throws InterruptedException,
                                                                                                         ExecutionException

Specified by:

describeStreamSummary in interface KinesisProxyV2Interface

Throws:

InterruptedException

ExecutionException

describeStreamConsumer

public software.amazon.awssdk.services.kinesis.model.DescribeStreamConsumerResponse describeStreamConsumer(String streamArn,
                                                                                                           String consumerName)
                                                                                                    throws InterruptedException,
                                                                                                           ExecutionException

Specified by:

describeStreamConsumer in interface KinesisProxyV2Interface

Throws:

InterruptedException

ExecutionException

describeStreamConsumer

public software.amazon.awssdk.services.kinesis.model.DescribeStreamConsumerResponse describeStreamConsumer(String streamConsumerArn)
                                                                                                    throws InterruptedException,
                                                                                                           ExecutionException

Specified by:

describeStreamConsumer in interface KinesisProxyV2Interface

Throws:

InterruptedException

ExecutionException

registerStreamConsumer

public software.amazon.awssdk.services.kinesis.model.RegisterStreamConsumerResponse registerStreamConsumer(String streamArn,
                                                                                                           String consumerName)
                                                                                                    throws InterruptedException,
                                                                                                           ExecutionException

Specified by:

registerStreamConsumer in interface KinesisProxyV2Interface

Throws:

InterruptedException

ExecutionException

deregisterStreamConsumer

public software.amazon.awssdk.services.kinesis.model.DeregisterStreamConsumerResponse deregisterStreamConsumer(String consumerArn)
                                                                                                        throws InterruptedException,
                                                                                                               ExecutionException

Specified by:

deregisterStreamConsumer in interface KinesisProxyV2Interface

Throws:

InterruptedException

ExecutionException