hlteoh37 commented on code in PR #49: URL: https://github.com/apache/flink-connector-aws/pull/49#discussion_r1182224015
########## flink-connector-aws-kinesis-streams/src/main/java/org/apache/flink/connector/kinesis/source/config/SourceConfigConstants.java: ########## @@ -0,0 +1,369 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.flink.connector.kinesis.source.config; + +import org.apache.flink.annotation.PublicEvolving; +import org.apache.flink.connector.aws.config.AWSConfigConstants; +import org.apache.flink.connector.kinesis.source.reader.PollingKinesisShardSplitReader; + +import java.time.Duration; + +@PublicEvolving +public class SourceConfigConstants extends AWSConfigConstants { + public enum InitialPosition { + LATEST, + TRIM_HORIZON, + AT_TIMESTAMP + } + + /** The record publisher type represents the record-consume style. */ + public enum RecordPublisherType { + + /** Consume the Kinesis records using AWS SDK v2 with the enhanced fan-out consumer. */ + EFO, + /** Consume the Kinesis records using AWS SDK v1 with the get-records method. */ + POLLING + } + + /** The EFO registration type represents how we are going to de-/register efo consumer. */ + public enum EFORegistrationType { + + /** + * Delay the registration of efo consumer for taskmanager to execute. De-register the efo + * consumer for taskmanager to execute when task is shut down. + */ + LAZY, + /** + * Register the efo consumer eagerly for jobmanager to execute. De-register the efo consumer + * the same way as lazy does. + */ + EAGER, + /** Do not register efo consumer programmatically. Do not de-register either. */ + NONE + } + + /** The RecordPublisher type (EFO|POLLING). */ + public static final String RECORD_PUBLISHER_TYPE = "flink.stream.recordpublisher"; + + public static final String DEFAULT_RECORD_PUBLISHER_TYPE = + RecordPublisherType.POLLING.toString(); + + /** Determine how and when consumer de-/registration is performed (LAZY|EAGER|NONE). */ + public static final String EFO_REGISTRATION_TYPE = "flink.stream.efo.registration"; + + public static final String DEFAULT_EFO_REGISTRATION_TYPE = EFORegistrationType.EAGER.toString(); + + /** The name of the EFO consumer to register with KDS. */ + public static final String EFO_CONSUMER_NAME = "flink.stream.efo.consumername"; + + /** The prefix of consumer ARN for a given stream. */ + public static final String EFO_CONSUMER_ARN_PREFIX = "flink.stream.efo.consumerarn"; + + /** The initial position to start reading Kinesis streams from. */ + public static final String STREAM_INITIAL_POSITION = "flink.stream.initpos"; + + public static final String DEFAULT_STREAM_INITIAL_POSITION = InitialPosition.LATEST.toString(); + + /** + * The initial timestamp to start reading Kinesis stream from (when AT_TIMESTAMP is set for + * STREAM_INITIAL_POSITION). + */ + public static final String STREAM_INITIAL_TIMESTAMP = "flink.stream.initpos.timestamp"; + + /** + * The date format of initial timestamp to start reading Kinesis stream from (when AT_TIMESTAMP + * is set for STREAM_INITIAL_POSITION). + */ + public static final String STREAM_TIMESTAMP_DATE_FORMAT = + "flink.stream.initpos.timestamp.format"; + + public static final String DEFAULT_STREAM_TIMESTAMP_DATE_FORMAT = + "yyyy-MM-dd'T'HH:mm:ss.SSSXXX"; + + /** The maximum number of describeStream attempts if we get a recoverable exception. */ + public static final String STREAM_DESCRIBE_RETRIES = "flink.stream.describe.maxretries"; + + public static final int DEFAULT_STREAM_DESCRIBE_RETRIES = 50; + + /** The base backoff time between each describeStream attempt. */ + public static final String STREAM_DESCRIBE_BACKOFF_BASE = "flink.stream.describe.backoff.base"; + + public static final long DEFAULT_STREAM_DESCRIBE_BACKOFF_BASE = 2000L; + + /** The maximum backoff time between each describeStream attempt. */ + public static final String STREAM_DESCRIBE_BACKOFF_MAX = "flink.stream.describe.backoff.max"; + + public static final long DEFAULT_STREAM_DESCRIBE_BACKOFF_MAX = 5000L; + + /** The power constant for exponential backoff between each describeStream attempt. */ + public static final String STREAM_DESCRIBE_BACKOFF_EXPONENTIAL_CONSTANT = + "flink.stream.describe.backoff.expconst"; + + public static final double DEFAULT_STREAM_DESCRIBE_BACKOFF_EXPONENTIAL_CONSTANT = 1.5; + + /** The maximum number of listShards attempts if we get a recoverable exception. */ + public static final String LIST_SHARDS_RETRIES = "flink.list.shards.maxretries"; + + public static final int DEFAULT_LIST_SHARDS_RETRIES = 10; + + /** The base backoff time between each listShards attempt. */ + public static final String LIST_SHARDS_BACKOFF_BASE = "flink.list.shards.backoff.base"; + + public static final long DEFAULT_LIST_SHARDS_BACKOFF_BASE = 1000L; + + /** The maximum backoff time between each listShards attempt. */ + public static final String LIST_SHARDS_BACKOFF_MAX = "flink.list.shards.backoff.max"; + + public static final long DEFAULT_LIST_SHARDS_BACKOFF_MAX = 5000L; + + /** The power constant for exponential backoff between each listShards attempt. */ + public static final String LIST_SHARDS_BACKOFF_EXPONENTIAL_CONSTANT = + "flink.list.shards.backoff.expconst"; + + public static final double DEFAULT_LIST_SHARDS_BACKOFF_EXPONENTIAL_CONSTANT = 1.5; + + /** The maximum number of describeStreamConsumer attempts if we get a recoverable exception. */ + public static final String DESCRIBE_STREAM_CONSUMER_RETRIES = + "flink.stream.describestreamconsumer.maxretries"; + + public static final int DEFAULT_DESCRIBE_STREAM_CONSUMER_RETRIES = 50; + + /** The base backoff time between each describeStreamConsumer attempt. */ + public static final String DESCRIBE_STREAM_CONSUMER_BACKOFF_BASE = + "flink.stream.describestreamconsumer.backoff.base"; + + public static final long DEFAULT_DESCRIBE_STREAM_CONSUMER_BACKOFF_BASE = 2000L; + + /** The maximum backoff time between each describeStreamConsumer attempt. */ + public static final String DESCRIBE_STREAM_CONSUMER_BACKOFF_MAX = + "flink.stream.describestreamconsumer.backoff.max"; + + public static final long DEFAULT_DESCRIBE_STREAM_CONSUMER_BACKOFF_MAX = 5000L; + + /** The power constant for exponential backoff between each describeStreamConsumer attempt. */ + public static final String DESCRIBE_STREAM_CONSUMER_BACKOFF_EXPONENTIAL_CONSTANT = + "flink.stream.describestreamconsumer.backoff.expconst"; + + public static final double DEFAULT_DESCRIBE_STREAM_CONSUMER_BACKOFF_EXPONENTIAL_CONSTANT = 1.5; + + /** The maximum number of registerStreamConsumer attempts if we get a recoverable exception. */ + public static final String REGISTER_STREAM_CONSUMER_RETRIES = + "flink.stream.registerstreamconsumer.maxretries"; + + public static final int DEFAULT_REGISTER_STREAM_CONSUMER_RETRIES = 10; + + /** + * The maximum time in seconds to wait for a stream consumer to become active before giving up. + */ + public static final String REGISTER_STREAM_CONSUMER_TIMEOUT_SECONDS = + "flink.stream.registerstreamconsumer.timeout"; + + public static final Duration DEFAULT_REGISTER_STREAM_CONSUMER_TIMEOUT = Duration.ofSeconds(60); + + /** The base backoff time between each registerStreamConsumer attempt. */ + public static final String REGISTER_STREAM_CONSUMER_BACKOFF_BASE = + "flink.stream.registerstreamconsumer.backoff.base"; + + public static final long DEFAULT_REGISTER_STREAM_CONSUMER_BACKOFF_BASE = 500L; + + /** The maximum backoff time between each registerStreamConsumer attempt. */ + public static final String REGISTER_STREAM_CONSUMER_BACKOFF_MAX = + "flink.stream.registerstreamconsumer.backoff.max"; + + public static final long DEFAULT_REGISTER_STREAM_CONSUMER_BACKOFF_MAX = 2000L; + + /** The power constant for exponential backoff between each registerStreamConsumer attempt. */ + public static final String REGISTER_STREAM_BACKOFF_EXPONENTIAL_CONSTANT = + "flink.stream.registerstreamconsumer.backoff.expconst"; + + public static final double DEFAULT_REGISTER_STREAM_BACKOFF_EXPONENTIAL_CONSTANT = 1.5; + + /** + * The maximum number of deregisterStreamConsumer attempts if we get a recoverable exception. + */ + public static final String DEREGISTER_STREAM_CONSUMER_RETRIES = + "flink.stream.deregisterstreamconsumer.maxretries"; + + public static final int DEFAULT_DEREGISTER_STREAM_CONSUMER_RETRIES = 10; + + /** The maximum time in seconds to wait for a stream consumer to deregister before giving up. */ + public static final String DEREGISTER_STREAM_CONSUMER_TIMEOUT_SECONDS = + "flink.stream.deregisterstreamconsumer.timeout"; + + public static final Duration DEFAULT_DEREGISTER_STREAM_CONSUMER_TIMEOUT = + Duration.ofSeconds(60); + + /** The base backoff time between each deregisterStreamConsumer attempt. */ + public static final String DEREGISTER_STREAM_BACKOFF_BASE = Review Comment: Hmm, actually this is our chance to break backwards compatibility! Will make the naming fix and add to list of "compatibility breaks" we can list down when we announce this source -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@flink.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org