ConsumerConfigConstants (Flink : 1.16-SNAPSHOT API)

java.lang.Object
- org.apache.flink.connector.aws.config.AWSConfigConstants
- - org.apache.flink.streaming.connectors.kinesis.config.AWSConfigConstants
  - - org.apache.flink.streaming.connectors.kinesis.config.ConsumerConfigConstants

```
@PublicEvolving
public class ConsumerConfigConstants
extends AWSConfigConstants
```
Optional consumer specific configuration keys and default values for FlinkKinesisConsumer.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ConsumerConfigConstants.EFORegistrationType` The EFO registration type represents how we are going to de-/register efo consumer.
`static class`	`ConsumerConfigConstants.InitialPosition` The initial position to start reading shards from.
`static class`	`ConsumerConfigConstants.RecordPublisherType` The record publisher type represents the record-consume style.

Nested classes/interfaces inherited from class org.apache.flink.connector.aws.config.AWSConfigConstants
AWSConfigConstants.CredentialProvider

Field Summary

Fields
Modifier and Type	Field and Description
`static long`	`DEFAULT_DEREGISTER_STREAM_BACKOFF_BASE`
`static double`	`DEFAULT_DEREGISTER_STREAM_BACKOFF_EXPONENTIAL_CONSTANT`
`static long`	`DEFAULT_DEREGISTER_STREAM_BACKOFF_MAX`
`static int`	`DEFAULT_DEREGISTER_STREAM_RETRIES`
`static java.time.Duration`	`DEFAULT_DEREGISTER_STREAM_TIMEOUT`
`static long`	`DEFAULT_DESCRIBE_STREAM_CONSUMER_BACKOFF_BASE`
`static double`	`DEFAULT_DESCRIBE_STREAM_CONSUMER_BACKOFF_EXPONENTIAL_CONSTANT`
`static long`	`DEFAULT_DESCRIBE_STREAM_CONSUMER_BACKOFF_MAX`
`static int`	`DEFAULT_DESCRIBE_STREAM_CONSUMER_RETRIES`
`static int`	`DEFAULT_EFO_HTTP_CLIENT_MAX_CONCURRENCY`
`static java.time.Duration`	`DEFAULT_EFO_HTTP_CLIENT_READ_TIMEOUT`
`static long`	`DEFAULT_LIST_SHARDS_BACKOFF_BASE`
`static double`	`DEFAULT_LIST_SHARDS_BACKOFF_EXPONENTIAL_CONSTANT`
`static long`	`DEFAULT_LIST_SHARDS_BACKOFF_MAX`
`static int`	`DEFAULT_LIST_SHARDS_RETRIES`
`static long`	`DEFAULT_REGISTER_STREAM_BACKOFF_BASE`
`static double`	`DEFAULT_REGISTER_STREAM_BACKOFF_EXPONENTIAL_CONSTANT`
`static long`	`DEFAULT_REGISTER_STREAM_BACKOFF_MAX`
`static int`	`DEFAULT_REGISTER_STREAM_RETRIES`
`static java.time.Duration`	`DEFAULT_REGISTER_STREAM_TIMEOUT`
`static long`	`DEFAULT_SHARD_DISCOVERY_INTERVAL_MILLIS`
`static long`	`DEFAULT_SHARD_GETITERATOR_BACKOFF_BASE`
`static double`	`DEFAULT_SHARD_GETITERATOR_BACKOFF_EXPONENTIAL_CONSTANT`
`static long`	`DEFAULT_SHARD_GETITERATOR_BACKOFF_MAX`
`static int`	`DEFAULT_SHARD_GETITERATOR_RETRIES`
`static long`	`DEFAULT_SHARD_GETRECORDS_BACKOFF_BASE`
`static double`	`DEFAULT_SHARD_GETRECORDS_BACKOFF_EXPONENTIAL_CONSTANT`
`static long`	`DEFAULT_SHARD_GETRECORDS_BACKOFF_MAX`
`static long`	`DEFAULT_SHARD_GETRECORDS_INTERVAL_MILLIS`
`static int`	`DEFAULT_SHARD_GETRECORDS_MAX`
`static int`	`DEFAULT_SHARD_GETRECORDS_RETRIES`
`static long`	`DEFAULT_SHARD_IDLE_INTERVAL_MILLIS`
`static boolean`	`DEFAULT_SHARD_USE_ADAPTIVE_READS`
`static long`	`DEFAULT_STREAM_DESCRIBE_BACKOFF_BASE`
`static double`	`DEFAULT_STREAM_DESCRIBE_BACKOFF_EXPONENTIAL_CONSTANT`
`static long`	`DEFAULT_STREAM_DESCRIBE_BACKOFF_MAX`
`static int`	`DEFAULT_STREAM_DESCRIBE_RETRIES`
`static String`	`DEFAULT_STREAM_INITIAL_POSITION`
`static String`	`DEFAULT_STREAM_TIMESTAMP_DATE_FORMAT`
`static long`	`DEFAULT_SUBSCRIBE_TO_SHARD_BACKOFF_BASE`
`static double`	`DEFAULT_SUBSCRIBE_TO_SHARD_BACKOFF_EXPONENTIAL_CONSTANT`
`static long`	`DEFAULT_SUBSCRIBE_TO_SHARD_BACKOFF_MAX`
`static int`	`DEFAULT_SUBSCRIBE_TO_SHARD_RETRIES`
`static java.time.Duration`	`DEFAULT_SUBSCRIBE_TO_SHARD_TIMEOUT`
`static long`	`DEFAULT_WATERMARK_SYNC_MILLIS`
`static String`	`DEREGISTER_STREAM_BACKOFF_BASE` The base backoff time between each deregisterStream attempt.
`static String`	`DEREGISTER_STREAM_BACKOFF_EXPONENTIAL_CONSTANT` The power constant for exponential backoff between each deregisterStream attempt.
`static String`	`DEREGISTER_STREAM_BACKOFF_MAX` The maximum backoff time between each deregisterStream attempt.
`static String`	`DEREGISTER_STREAM_RETRIES` The maximum number of deregisterStream attempts if we get a recoverable exception.
`static String`	`DEREGISTER_STREAM_TIMEOUT_SECONDS` The maximum time in seconds to wait for a stream consumer to deregister before giving up.
`static String`	`DESCRIBE_STREAM_CONSUMER_BACKOFF_BASE` The base backoff time between each describeStreamConsumer attempt.
`static String`	`DESCRIBE_STREAM_CONSUMER_BACKOFF_EXPONENTIAL_CONSTANT` The power constant for exponential backoff between each describeStreamConsumer attempt.
`static String`	`DESCRIBE_STREAM_CONSUMER_BACKOFF_MAX` The maximum backoff time between each describeStreamConsumer attempt.
`static String`	`DESCRIBE_STREAM_CONSUMER_RETRIES` The maximum number of describeStreamConsumer attempts if we get a recoverable exception.
`static String`	`EFO_CONSUMER_ARN_PREFIX` The prefix of consumer ARN for a given stream.
`static String`	`EFO_CONSUMER_NAME` The name of the EFO consumer to register with KDS.
`static String`	`EFO_HTTP_CLIENT_MAX_CONCURRENCY`
`static String`	`EFO_HTTP_CLIENT_READ_TIMEOUT_MILLIS`
`static String`	`EFO_REGISTRATION_TYPE` Determine how and when consumer de-/registration is performed (LAZY\|EAGER\|NONE, default is LAZY).
`static String`	`LIST_SHARDS_BACKOFF_BASE` The base backoff time between each listShards attempt.
`static String`	`LIST_SHARDS_BACKOFF_EXPONENTIAL_CONSTANT` The power constant for exponential backoff between each listShards attempt.
`static String`	`LIST_SHARDS_BACKOFF_MAX` The maximum backoff time between each listShards attempt.
`static String`	`LIST_SHARDS_RETRIES` The maximum number of listShards attempts if we get a recoverable exception.
`static long`	`MAX_SHARD_GETRECORDS_INTERVAL_MILLIS` To avoid shard iterator expires in `ShardConsumer`s, the value for the configured getRecords interval can not exceed 5 minutes, which is the expire time for retrieved iterators.
`static String`	`RECORD_PUBLISHER_TYPE` The RecordPublisher type (EFO\|POLLING, default is POLLING).
`static String`	`REGISTER_STREAM_BACKOFF_BASE` The base backoff time between each registerStream attempt.
`static String`	`REGISTER_STREAM_BACKOFF_EXPONENTIAL_CONSTANT` The power constant for exponential backoff between each registerStream attempt.
`static String`	`REGISTER_STREAM_BACKOFF_MAX` The maximum backoff time between each registerStream attempt.
`static String`	`REGISTER_STREAM_RETRIES` The maximum number of registerStream attempts if we get a recoverable exception.
`static String`	`REGISTER_STREAM_TIMEOUT_SECONDS` The maximum time in seconds to wait for a stream consumer to become active before giving up.
`static String`	`SHARD_DISCOVERY_INTERVAL_MILLIS` The interval between each attempt to discover new shards.
`static String`	`SHARD_GETITERATOR_BACKOFF_BASE` The base backoff time between getShardIterator attempts if we get a ProvisionedThroughputExceededException.
`static String`	`SHARD_GETITERATOR_BACKOFF_EXPONENTIAL_CONSTANT` The power constant for exponential backoff between each getShardIterator attempt.
`static String`	`SHARD_GETITERATOR_BACKOFF_MAX` The maximum backoff time between getShardIterator attempts if we get a ProvisionedThroughputExceededException.
`static String`	`SHARD_GETITERATOR_RETRIES` The maximum number of getShardIterator attempts if we get ProvisionedThroughputExceededException.
`static String`	`SHARD_GETRECORDS_BACKOFF_BASE` The base backoff time between getRecords attempts if we get a ProvisionedThroughputExceededException.
`static String`	`SHARD_GETRECORDS_BACKOFF_EXPONENTIAL_CONSTANT` The power constant for exponential backoff between each getRecords attempt.
`static String`	`SHARD_GETRECORDS_BACKOFF_MAX` The maximum backoff time between getRecords attempts if we get a ProvisionedThroughputExceededException.
`static String`	`SHARD_GETRECORDS_INTERVAL_MILLIS` The interval between each getRecords request to a AWS Kinesis shard in milliseconds.
`static String`	`SHARD_GETRECORDS_MAX` The maximum number of records to try to get each time we fetch records from a AWS Kinesis shard.
`static String`	`SHARD_GETRECORDS_RETRIES` The maximum number of getRecords attempts if we get a recoverable exception.
`static String`	`SHARD_IDLE_INTERVAL_MILLIS` The interval after which to consider a shard idle for purposes of watermark generation.
`static String`	`SHARD_USE_ADAPTIVE_READS` The config to turn on adaptive reads from a shard.
`static String`	`STREAM_DESCRIBE_BACKOFF_BASE` The base backoff time between each describeStream attempt (for consuming from DynamoDB streams).
`static String`	`STREAM_DESCRIBE_BACKOFF_EXPONENTIAL_CONSTANT` The power constant for exponential backoff between each describeStream attempt (for consuming from DynamoDB streams).
`static String`	`STREAM_DESCRIBE_BACKOFF_MAX` The maximum backoff time between each describeStream attempt (for consuming from DynamoDB streams).
`static String`	`STREAM_DESCRIBE_RETRIES` The maximum number of describeStream attempts if we get a recoverable exception.
`static String`	`STREAM_INITIAL_POSITION` The initial position to start reading Kinesis streams from (LATEST is used if not set).
`static String`	`STREAM_INITIAL_TIMESTAMP` The initial timestamp to start reading Kinesis stream from (when AT_TIMESTAMP is set for STREAM_INITIAL_POSITION).
`static String`	`STREAM_TIMESTAMP_DATE_FORMAT` The date format of initial timestamp to start reading Kinesis stream from (when AT_TIMESTAMP is set for STREAM_INITIAL_POSITION).
`static String`	`SUBSCRIBE_TO_SHARD_BACKOFF_BASE` The base backoff time between each subscribeToShard attempt.
`static String`	`SUBSCRIBE_TO_SHARD_BACKOFF_EXPONENTIAL_CONSTANT` The power constant for exponential backoff between each subscribeToShard attempt.
`static String`	`SUBSCRIBE_TO_SHARD_BACKOFF_MAX` The maximum backoff time between each subscribeToShard attempt.
`static String`	`SUBSCRIBE_TO_SHARD_RETRIES` The maximum number of subscribeToShard attempts if we get a recoverable exception.
`static String`	`SUBSCRIBE_TO_SHARD_TIMEOUT_SECONDS` A timeout when waiting for a shard subscription to be established.
`static String`	`WATERMARK_LOOKAHEAD_MILLIS` The maximum delta allowed for the reader to advance ahead of the shared global watermark.
`static String`	`WATERMARK_SYNC_MILLIS` The interval for periodically synchronizing the shared watermark state.
`static String`	`WATERMARK_SYNC_QUEUE_CAPACITY` The maximum number of records that will be buffered before suspending consumption of a shard.

Fields inherited from class org.apache.flink.connector.aws.config.AWSConfigConstants
AWS_ACCESS_KEY_ID, AWS_CREDENTIALS_PROVIDER, AWS_ENDPOINT, AWS_PROFILE_NAME, AWS_PROFILE_PATH, AWS_REGION, AWS_ROLE_ARN, AWS_ROLE_CREDENTIALS_PROVIDER, AWS_ROLE_EXTERNAL_ID, AWS_ROLE_SESSION_NAME, AWS_SECRET_ACCESS_KEY, AWS_WEB_IDENTITY_TOKEN_FILE, HTTP_CLIENT_MAX_CONCURRENCY, HTTP_CLIENT_READ_TIMEOUT_MILLIS, HTTP_PROTOCOL_VERSION, TRUST_ALL_CERTIFICATES

Constructor Summary

Constructors
Constructor and Description

ConsumerConfigConstants()

Constructors
Constructor and Description
`ConsumerConfigConstants()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`efoConsumerArn(String streamName)` Build the key of an EFO consumer ARN according to a stream name.

Methods inherited from class org.apache.flink.connector.aws.config.AWSConfigConstants
accessKeyId, externalId, profileName, profilePath, roleArn, roleCredentialsProvider, roleSessionName, secretKey, webIdentityTokenFile

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - RECORD_PUBLISHER_TYPE
```
public static final String RECORD_PUBLISHER_TYPE
```
    The RecordPublisher type (EFO|POLLING, default is POLLING).
    
    See Also:
    
    Constant Field Values
  - EFO_CONSUMER_NAME
```
public static final String EFO_CONSUMER_NAME
```
    The name of the EFO consumer to register with KDS.
    
    See Also:
    
    Constant Field Values
  - EFO_REGISTRATION_TYPE
```
public static final String EFO_REGISTRATION_TYPE
```
    Determine how and when consumer de-/registration is performed (LAZY|EAGER|NONE, default is LAZY).
    
    See Also:
    
    Constant Field Values
  - EFO_CONSUMER_ARN_PREFIX
```
public static final String EFO_CONSUMER_ARN_PREFIX
```
    The prefix of consumer ARN for a given stream.
    
    See Also:
    
    Constant Field Values
  - STREAM_INITIAL_POSITION
```
public static final String STREAM_INITIAL_POSITION
```
    The initial position to start reading Kinesis streams from (LATEST is used if not set).
    
    See Also:
    
    Constant Field Values
  - STREAM_INITIAL_TIMESTAMP
```
public static final String STREAM_INITIAL_TIMESTAMP
```
    The initial timestamp to start reading Kinesis stream from (when AT_TIMESTAMP is set for STREAM_INITIAL_POSITION).
    
    See Also:
    
    Constant Field Values
  - STREAM_TIMESTAMP_DATE_FORMAT
```
public static final String STREAM_TIMESTAMP_DATE_FORMAT
```
    The date format of initial timestamp to start reading Kinesis stream from (when AT_TIMESTAMP is set for STREAM_INITIAL_POSITION).
    
    See Also:
    
    Constant Field Values
  - STREAM_DESCRIBE_RETRIES
```
public static final String STREAM_DESCRIBE_RETRIES
```
    The maximum number of describeStream attempts if we get a recoverable exception.
    
    See Also:
    
    Constant Field Values
  - STREAM_DESCRIBE_BACKOFF_BASE
```
public static final String STREAM_DESCRIBE_BACKOFF_BASE
```
    The base backoff time between each describeStream attempt (for consuming from DynamoDB streams).
    
    See Also:
    
    Constant Field Values
  - STREAM_DESCRIBE_BACKOFF_MAX
```
public static final String STREAM_DESCRIBE_BACKOFF_MAX
```
    The maximum backoff time between each describeStream attempt (for consuming from DynamoDB streams).
    
    See Also:
    
    Constant Field Values
  - STREAM_DESCRIBE_BACKOFF_EXPONENTIAL_CONSTANT
```
public static final String STREAM_DESCRIBE_BACKOFF_EXPONENTIAL_CONSTANT
```
    The power constant for exponential backoff between each describeStream attempt (for consuming from DynamoDB streams).
    
    See Also:
    
    Constant Field Values
  - LIST_SHARDS_RETRIES
```
public static final String LIST_SHARDS_RETRIES
```
    The maximum number of listShards attempts if we get a recoverable exception.
    
    See Also:
    
    Constant Field Values
  - LIST_SHARDS_BACKOFF_BASE
```
public static final String LIST_SHARDS_BACKOFF_BASE
```
    The base backoff time between each listShards attempt.
    
    See Also:
    
    Constant Field Values
  - LIST_SHARDS_BACKOFF_MAX
```
public static final String LIST_SHARDS_BACKOFF_MAX
```
    The maximum backoff time between each listShards attempt.
    
    See Also:
    
    Constant Field Values
  - LIST_SHARDS_BACKOFF_EXPONENTIAL_CONSTANT
```
public static final String LIST_SHARDS_BACKOFF_EXPONENTIAL_CONSTANT
```
    The power constant for exponential backoff between each listShards attempt.
    
    See Also:
    
    Constant Field Values
  - DESCRIBE_STREAM_CONSUMER_RETRIES
```
public static final String DESCRIBE_STREAM_CONSUMER_RETRIES
```
    The maximum number of describeStreamConsumer attempts if we get a recoverable exception.
    
    See Also:
    
    Constant Field Values
  - DESCRIBE_STREAM_CONSUMER_BACKOFF_BASE
```
public static final String DESCRIBE_STREAM_CONSUMER_BACKOFF_BASE
```
    The base backoff time between each describeStreamConsumer attempt.
    
    See Also:
    
    Constant Field Values
  - DESCRIBE_STREAM_CONSUMER_BACKOFF_MAX
```
public static final String DESCRIBE_STREAM_CONSUMER_BACKOFF_MAX
```
    The maximum backoff time between each describeStreamConsumer attempt.
    
    See Also:
    
    Constant Field Values
  - DESCRIBE_STREAM_CONSUMER_BACKOFF_EXPONENTIAL_CONSTANT
```
public static final String DESCRIBE_STREAM_CONSUMER_BACKOFF_EXPONENTIAL_CONSTANT
```
    The power constant for exponential backoff between each describeStreamConsumer attempt.
    
    See Also:
    
    Constant Field Values
  - REGISTER_STREAM_RETRIES
```
public static final String REGISTER_STREAM_RETRIES
```
    The maximum number of registerStream attempts if we get a recoverable exception.
    
    See Also:
    
    Constant Field Values
  - REGISTER_STREAM_TIMEOUT_SECONDS
```
public static final String REGISTER_STREAM_TIMEOUT_SECONDS
```
    The maximum time in seconds to wait for a stream consumer to become active before giving up.
    
    See Also:
    
    Constant Field Values
  - REGISTER_STREAM_BACKOFF_BASE
```
public static final String REGISTER_STREAM_BACKOFF_BASE
```
    The base backoff time between each registerStream attempt.
    
    See Also:
    
    Constant Field Values
  - REGISTER_STREAM_BACKOFF_MAX
```
public static final String REGISTER_STREAM_BACKOFF_MAX
```
    The maximum backoff time between each registerStream attempt.
    
    See Also:
    
    Constant Field Values
  - REGISTER_STREAM_BACKOFF_EXPONENTIAL_CONSTANT
```
public static final String REGISTER_STREAM_BACKOFF_EXPONENTIAL_CONSTANT
```
    The power constant for exponential backoff between each registerStream attempt.
    
    See Also:
    
    Constant Field Values
  - DEREGISTER_STREAM_RETRIES
```
public static final String DEREGISTER_STREAM_RETRIES
```
    The maximum number of deregisterStream attempts if we get a recoverable exception.
    
    See Also:
    
    Constant Field Values
  - DEREGISTER_STREAM_TIMEOUT_SECONDS
```
public static final String DEREGISTER_STREAM_TIMEOUT_SECONDS
```
    The maximum time in seconds to wait for a stream consumer to deregister before giving up.
    
    See Also:
    
    Constant Field Values
  - DEREGISTER_STREAM_BACKOFF_BASE
```
public static final String DEREGISTER_STREAM_BACKOFF_BASE
```
    The base backoff time between each deregisterStream attempt.
    
    See Also:
    
    Constant Field Values
  - DEREGISTER_STREAM_BACKOFF_MAX
```
public static final String DEREGISTER_STREAM_BACKOFF_MAX
```
    The maximum backoff time between each deregisterStream attempt.
    
    See Also:
    
    Constant Field Values
  - DEREGISTER_STREAM_BACKOFF_EXPONENTIAL_CONSTANT
```
public static final String DEREGISTER_STREAM_BACKOFF_EXPONENTIAL_CONSTANT
```
    The power constant for exponential backoff between each deregisterStream attempt.
    
    See Also:
    
    Constant Field Values
  - SUBSCRIBE_TO_SHARD_RETRIES
```
public static final String SUBSCRIBE_TO_SHARD_RETRIES
```
    The maximum number of subscribeToShard attempts if we get a recoverable exception.
    
    See Also:
    
    Constant Field Values
  - SUBSCRIBE_TO_SHARD_TIMEOUT_SECONDS
```
public static final String SUBSCRIBE_TO_SHARD_TIMEOUT_SECONDS
```
    A timeout when waiting for a shard subscription to be established.
    
    See Also:
    
    Constant Field Values
  - SUBSCRIBE_TO_SHARD_BACKOFF_BASE
```
public static final String SUBSCRIBE_TO_SHARD_BACKOFF_BASE
```
    The base backoff time between each subscribeToShard attempt.
    
    See Also:
    
    Constant Field Values
  - SUBSCRIBE_TO_SHARD_BACKOFF_MAX
```
public static final String SUBSCRIBE_TO_SHARD_BACKOFF_MAX
```
    The maximum backoff time between each subscribeToShard attempt.
    
    See Also:
    
    Constant Field Values
  - SUBSCRIBE_TO_SHARD_BACKOFF_EXPONENTIAL_CONSTANT
```
public static final String SUBSCRIBE_TO_SHARD_BACKOFF_EXPONENTIAL_CONSTANT
```
    The power constant for exponential backoff between each subscribeToShard attempt.
    
    See Also:
    
    Constant Field Values
  - SHARD_GETRECORDS_MAX
```
public static final String SHARD_GETRECORDS_MAX
```
    The maximum number of records to try to get each time we fetch records from a AWS Kinesis shard.
    
    See Also:
    
    Constant Field Values
  - SHARD_GETRECORDS_RETRIES
```
public static final String SHARD_GETRECORDS_RETRIES
```
    The maximum number of getRecords attempts if we get a recoverable exception.
    
    See Also:
    
    Constant Field Values
  - SHARD_GETRECORDS_BACKOFF_BASE
```
public static final String SHARD_GETRECORDS_BACKOFF_BASE
```
    The base backoff time between getRecords attempts if we get a ProvisionedThroughputExceededException.
    
    See Also:
    
    Constant Field Values
  - SHARD_GETRECORDS_BACKOFF_MAX
```
public static final String SHARD_GETRECORDS_BACKOFF_MAX
```
    The maximum backoff time between getRecords attempts if we get a ProvisionedThroughputExceededException.
    
    See Also:
    
    Constant Field Values
  - SHARD_GETRECORDS_BACKOFF_EXPONENTIAL_CONSTANT
```
public static final String SHARD_GETRECORDS_BACKOFF_EXPONENTIAL_CONSTANT
```
    The power constant for exponential backoff between each getRecords attempt.
    
    See Also:
    
    Constant Field Values
  - SHARD_GETRECORDS_INTERVAL_MILLIS
```
public static final String SHARD_GETRECORDS_INTERVAL_MILLIS
```
    The interval between each getRecords request to a AWS Kinesis shard in milliseconds.
    
    See Also:
    
    Constant Field Values
  - SHARD_GETITERATOR_RETRIES
```
public static final String SHARD_GETITERATOR_RETRIES
```
    The maximum number of getShardIterator attempts if we get ProvisionedThroughputExceededException.
    
    See Also:
    
    Constant Field Values
  - SHARD_GETITERATOR_BACKOFF_BASE
```
public static final String SHARD_GETITERATOR_BACKOFF_BASE
```
    The base backoff time between getShardIterator attempts if we get a ProvisionedThroughputExceededException.
    
    See Also:
    
    Constant Field Values
  - SHARD_GETITERATOR_BACKOFF_MAX
```
public static final String SHARD_GETITERATOR_BACKOFF_MAX
```
    The maximum backoff time between getShardIterator attempts if we get a ProvisionedThroughputExceededException.
    
    See Also:
    
    Constant Field Values
  - SHARD_GETITERATOR_BACKOFF_EXPONENTIAL_CONSTANT
```
public static final String SHARD_GETITERATOR_BACKOFF_EXPONENTIAL_CONSTANT
```
    The power constant for exponential backoff between each getShardIterator attempt.
    
    See Also:
    
    Constant Field Values
  - SHARD_DISCOVERY_INTERVAL_MILLIS
```
public static final String SHARD_DISCOVERY_INTERVAL_MILLIS
```
    The interval between each attempt to discover new shards.
    
    See Also:
    
    Constant Field Values
  - SHARD_USE_ADAPTIVE_READS
```
public static final String SHARD_USE_ADAPTIVE_READS
```
    The config to turn on adaptive reads from a shard.
    
    See Also:
    
    Constant Field Values
  - SHARD_IDLE_INTERVAL_MILLIS
```
public static final String SHARD_IDLE_INTERVAL_MILLIS
```
    The interval after which to consider a shard idle for purposes of watermark generation.
    
    See Also:
    
    Constant Field Values
  - WATERMARK_SYNC_MILLIS
```
public static final String WATERMARK_SYNC_MILLIS
```
    The interval for periodically synchronizing the shared watermark state.
    
    See Also:
    
    Constant Field Values
  - WATERMARK_LOOKAHEAD_MILLIS
```
public static final String WATERMARK_LOOKAHEAD_MILLIS
```
    The maximum delta allowed for the reader to advance ahead of the shared global watermark.
    
    See Also:
    
    Constant Field Values
  - WATERMARK_SYNC_QUEUE_CAPACITY
```
public static final String WATERMARK_SYNC_QUEUE_CAPACITY
```
    The maximum number of records that will be buffered before suspending consumption of a shard.
    
    See Also:
    
    Constant Field Values
  - EFO_HTTP_CLIENT_MAX_CONCURRENCY
```
public static final String EFO_HTTP_CLIENT_MAX_CONCURRENCY
```
    See Also:
    
    Constant Field Values
  - EFO_HTTP_CLIENT_READ_TIMEOUT_MILLIS
```
public static final String EFO_HTTP_CLIENT_READ_TIMEOUT_MILLIS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_STREAM_INITIAL_POSITION
```
public static final String DEFAULT_STREAM_INITIAL_POSITION
```
  - DEFAULT_STREAM_TIMESTAMP_DATE_FORMAT
```
public static final String DEFAULT_STREAM_TIMESTAMP_DATE_FORMAT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_STREAM_DESCRIBE_RETRIES
```
public static final int DEFAULT_STREAM_DESCRIBE_RETRIES
```
    See Also:
    
    Constant Field Values
  - DEFAULT_STREAM_DESCRIBE_BACKOFF_BASE
```
public static final long DEFAULT_STREAM_DESCRIBE_BACKOFF_BASE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_STREAM_DESCRIBE_BACKOFF_MAX
```
public static final long DEFAULT_STREAM_DESCRIBE_BACKOFF_MAX
```
    See Also:
    
    Constant Field Values
  - DEFAULT_STREAM_DESCRIBE_BACKOFF_EXPONENTIAL_CONSTANT
```
public static final double DEFAULT_STREAM_DESCRIBE_BACKOFF_EXPONENTIAL_CONSTANT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_LIST_SHARDS_BACKOFF_BASE
```
public static final long DEFAULT_LIST_SHARDS_BACKOFF_BASE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_LIST_SHARDS_BACKOFF_MAX
```
public static final long DEFAULT_LIST_SHARDS_BACKOFF_MAX
```
    See Also:
    
    Constant Field Values
  - DEFAULT_LIST_SHARDS_BACKOFF_EXPONENTIAL_CONSTANT
```
public static final double DEFAULT_LIST_SHARDS_BACKOFF_EXPONENTIAL_CONSTANT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_LIST_SHARDS_RETRIES
```
public static final int DEFAULT_LIST_SHARDS_RETRIES
```
    See Also:
    
    Constant Field Values
  - DEFAULT_DESCRIBE_STREAM_CONSUMER_RETRIES
```
public static final int DEFAULT_DESCRIBE_STREAM_CONSUMER_RETRIES
```
    See Also:
    
    Constant Field Values
  - DEFAULT_DESCRIBE_STREAM_CONSUMER_BACKOFF_BASE
```
public static final long DEFAULT_DESCRIBE_STREAM_CONSUMER_BACKOFF_BASE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_DESCRIBE_STREAM_CONSUMER_BACKOFF_MAX
```
public static final long DEFAULT_DESCRIBE_STREAM_CONSUMER_BACKOFF_MAX
```
    See Also:
    
    Constant Field Values
  - DEFAULT_DESCRIBE_STREAM_CONSUMER_BACKOFF_EXPONENTIAL_CONSTANT
```
public static final double DEFAULT_DESCRIBE_STREAM_CONSUMER_BACKOFF_EXPONENTIAL_CONSTANT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_REGISTER_STREAM_RETRIES
```
public static final int DEFAULT_REGISTER_STREAM_RETRIES
```
    See Also:
    
    Constant Field Values
  - DEFAULT_REGISTER_STREAM_TIMEOUT
```
public static final java.time.Duration DEFAULT_REGISTER_STREAM_TIMEOUT
```
  - DEFAULT_REGISTER_STREAM_BACKOFF_BASE
```
public static final long DEFAULT_REGISTER_STREAM_BACKOFF_BASE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_REGISTER_STREAM_BACKOFF_MAX
```
public static final long DEFAULT_REGISTER_STREAM_BACKOFF_MAX
```
    See Also:
    
    Constant Field Values
  - DEFAULT_REGISTER_STREAM_BACKOFF_EXPONENTIAL_CONSTANT
```
public static final double DEFAULT_REGISTER_STREAM_BACKOFF_EXPONENTIAL_CONSTANT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_DEREGISTER_STREAM_RETRIES
```
public static final int DEFAULT_DEREGISTER_STREAM_RETRIES
```
    See Also:
    
    Constant Field Values
  - DEFAULT_DEREGISTER_STREAM_TIMEOUT
```
public static final java.time.Duration DEFAULT_DEREGISTER_STREAM_TIMEOUT
```
  - DEFAULT_DEREGISTER_STREAM_BACKOFF_BASE
```
public static final long DEFAULT_DEREGISTER_STREAM_BACKOFF_BASE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_DEREGISTER_STREAM_BACKOFF_MAX
```
public static final long DEFAULT_DEREGISTER_STREAM_BACKOFF_MAX
```
    See Also:
    
    Constant Field Values
  - DEFAULT_DEREGISTER_STREAM_BACKOFF_EXPONENTIAL_CONSTANT
```
public static final double DEFAULT_DEREGISTER_STREAM_BACKOFF_EXPONENTIAL_CONSTANT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SUBSCRIBE_TO_SHARD_RETRIES
```
public static final int DEFAULT_SUBSCRIBE_TO_SHARD_RETRIES
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SUBSCRIBE_TO_SHARD_TIMEOUT
```
public static final java.time.Duration DEFAULT_SUBSCRIBE_TO_SHARD_TIMEOUT
```
  - DEFAULT_SUBSCRIBE_TO_SHARD_BACKOFF_BASE
```
public static final long DEFAULT_SUBSCRIBE_TO_SHARD_BACKOFF_BASE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SUBSCRIBE_TO_SHARD_BACKOFF_MAX
```
public static final long DEFAULT_SUBSCRIBE_TO_SHARD_BACKOFF_MAX
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SUBSCRIBE_TO_SHARD_BACKOFF_EXPONENTIAL_CONSTANT
```
public static final double DEFAULT_SUBSCRIBE_TO_SHARD_BACKOFF_EXPONENTIAL_CONSTANT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SHARD_GETRECORDS_MAX
```
public static final int DEFAULT_SHARD_GETRECORDS_MAX
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SHARD_GETRECORDS_RETRIES
```
public static final int DEFAULT_SHARD_GETRECORDS_RETRIES
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SHARD_GETRECORDS_BACKOFF_BASE
```
public static final long DEFAULT_SHARD_GETRECORDS_BACKOFF_BASE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SHARD_GETRECORDS_BACKOFF_MAX
```
public static final long DEFAULT_SHARD_GETRECORDS_BACKOFF_MAX
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SHARD_GETRECORDS_BACKOFF_EXPONENTIAL_CONSTANT
```
public static final double DEFAULT_SHARD_GETRECORDS_BACKOFF_EXPONENTIAL_CONSTANT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SHARD_GETRECORDS_INTERVAL_MILLIS
```
public static final long DEFAULT_SHARD_GETRECORDS_INTERVAL_MILLIS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SHARD_GETITERATOR_RETRIES
```
public static final int DEFAULT_SHARD_GETITERATOR_RETRIES
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SHARD_GETITERATOR_BACKOFF_BASE
```
public static final long DEFAULT_SHARD_GETITERATOR_BACKOFF_BASE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SHARD_GETITERATOR_BACKOFF_MAX
```
public static final long DEFAULT_SHARD_GETITERATOR_BACKOFF_MAX
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SHARD_GETITERATOR_BACKOFF_EXPONENTIAL_CONSTANT
```
public static final double DEFAULT_SHARD_GETITERATOR_BACKOFF_EXPONENTIAL_CONSTANT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SHARD_DISCOVERY_INTERVAL_MILLIS
```
public static final long DEFAULT_SHARD_DISCOVERY_INTERVAL_MILLIS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SHARD_USE_ADAPTIVE_READS
```
public static final boolean DEFAULT_SHARD_USE_ADAPTIVE_READS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SHARD_IDLE_INTERVAL_MILLIS
```
public static final long DEFAULT_SHARD_IDLE_INTERVAL_MILLIS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_WATERMARK_SYNC_MILLIS
```
public static final long DEFAULT_WATERMARK_SYNC_MILLIS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_EFO_HTTP_CLIENT_MAX_CONCURRENCY
```
public static final int DEFAULT_EFO_HTTP_CLIENT_MAX_CONCURRENCY
```
    See Also:
    
    Constant Field Values
  - DEFAULT_EFO_HTTP_CLIENT_READ_TIMEOUT
```
public static final java.time.Duration DEFAULT_EFO_HTTP_CLIENT_READ_TIMEOUT
```
  - MAX_SHARD_GETRECORDS_INTERVAL_MILLIS
```
public static final long MAX_SHARD_GETRECORDS_INTERVAL_MILLIS
```
    To avoid shard iterator expires in ShardConsumers, the value for the configured getRecords interval can not exceed 5 minutes, which is the expire time for retrieved iterators.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ConsumerConfigConstants
```
public ConsumerConfigConstants()
```
- Method Detail
  - efoConsumerArn
```
public static String efoConsumerArn(String streamName)
```
    Build the key of an EFO consumer ARN according to a stream name.
    
    Parameters:
    
    streamName - the stream name the key is built upon.
    
    Returns:
    
    a key of EFO consumer ARN.

Back to Flink Website

Class ConsumerConfigConstants

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.flink.connector.aws.config.AWSConfigConstants

Field Summary

Fields inherited from class org.apache.flink.connector.aws.config.AWSConfigConstants

Constructor Summary

Method Summary

Methods inherited from class org.apache.flink.connector.aws.config.AWSConfigConstants

Methods inherited from class java.lang.Object

Field Detail

RECORD_PUBLISHER_TYPE

EFO_CONSUMER_NAME

EFO_REGISTRATION_TYPE

EFO_CONSUMER_ARN_PREFIX

STREAM_INITIAL_POSITION

STREAM_INITIAL_TIMESTAMP

STREAM_TIMESTAMP_DATE_FORMAT

STREAM_DESCRIBE_RETRIES

STREAM_DESCRIBE_BACKOFF_BASE

STREAM_DESCRIBE_BACKOFF_MAX

STREAM_DESCRIBE_BACKOFF_EXPONENTIAL_CONSTANT

LIST_SHARDS_RETRIES

LIST_SHARDS_BACKOFF_BASE

LIST_SHARDS_BACKOFF_MAX

LIST_SHARDS_BACKOFF_EXPONENTIAL_CONSTANT

DESCRIBE_STREAM_CONSUMER_RETRIES

DESCRIBE_STREAM_CONSUMER_BACKOFF_BASE

DESCRIBE_STREAM_CONSUMER_BACKOFF_MAX

DESCRIBE_STREAM_CONSUMER_BACKOFF_EXPONENTIAL_CONSTANT

REGISTER_STREAM_RETRIES

REGISTER_STREAM_TIMEOUT_SECONDS

REGISTER_STREAM_BACKOFF_BASE

REGISTER_STREAM_BACKOFF_MAX

REGISTER_STREAM_BACKOFF_EXPONENTIAL_CONSTANT

DEREGISTER_STREAM_RETRIES

DEREGISTER_STREAM_TIMEOUT_SECONDS

DEREGISTER_STREAM_BACKOFF_BASE

DEREGISTER_STREAM_BACKOFF_MAX

DEREGISTER_STREAM_BACKOFF_EXPONENTIAL_CONSTANT

SUBSCRIBE_TO_SHARD_RETRIES

SUBSCRIBE_TO_SHARD_TIMEOUT_SECONDS

SUBSCRIBE_TO_SHARD_BACKOFF_BASE

SUBSCRIBE_TO_SHARD_BACKOFF_MAX

SUBSCRIBE_TO_SHARD_BACKOFF_EXPONENTIAL_CONSTANT

SHARD_GETRECORDS_MAX

SHARD_GETRECORDS_RETRIES

SHARD_GETRECORDS_BACKOFF_BASE

SHARD_GETRECORDS_BACKOFF_MAX

SHARD_GETRECORDS_BACKOFF_EXPONENTIAL_CONSTANT

SHARD_GETRECORDS_INTERVAL_MILLIS

SHARD_GETITERATOR_RETRIES

SHARD_GETITERATOR_BACKOFF_BASE

SHARD_GETITERATOR_BACKOFF_MAX

SHARD_GETITERATOR_BACKOFF_EXPONENTIAL_CONSTANT

SHARD_DISCOVERY_INTERVAL_MILLIS

SHARD_USE_ADAPTIVE_READS

SHARD_IDLE_INTERVAL_MILLIS

WATERMARK_SYNC_MILLIS

WATERMARK_LOOKAHEAD_MILLIS

WATERMARK_SYNC_QUEUE_CAPACITY

EFO_HTTP_CLIENT_MAX_CONCURRENCY

EFO_HTTP_CLIENT_READ_TIMEOUT_MILLIS

DEFAULT_STREAM_INITIAL_POSITION

DEFAULT_STREAM_TIMESTAMP_DATE_FORMAT

DEFAULT_STREAM_DESCRIBE_RETRIES

DEFAULT_STREAM_DESCRIBE_BACKOFF_BASE

DEFAULT_STREAM_DESCRIBE_BACKOFF_MAX

DEFAULT_STREAM_DESCRIBE_BACKOFF_EXPONENTIAL_CONSTANT

DEFAULT_LIST_SHARDS_BACKOFF_BASE

DEFAULT_LIST_SHARDS_BACKOFF_MAX

DEFAULT_LIST_SHARDS_BACKOFF_EXPONENTIAL_CONSTANT

DEFAULT_LIST_SHARDS_RETRIES

DEFAULT_DESCRIBE_STREAM_CONSUMER_RETRIES

DEFAULT_DESCRIBE_STREAM_CONSUMER_BACKOFF_BASE

DEFAULT_DESCRIBE_STREAM_CONSUMER_BACKOFF_MAX

DEFAULT_DESCRIBE_STREAM_CONSUMER_BACKOFF_EXPONENTIAL_CONSTANT

DEFAULT_REGISTER_STREAM_RETRIES

DEFAULT_REGISTER_STREAM_TIMEOUT

DEFAULT_REGISTER_STREAM_BACKOFF_BASE