org.apache.flink.statefun.sdk.kinesis.ingress

Class KinesisIngressBuilder<T>

java.lang.Object

org.apache.flink.statefun.sdk.kinesis.ingress.KinesisIngressBuilder<T>

Type Parameters:

T - The type consumed from AWS Kinesis.

public final class KinesisIngressBuilder<T>
extends java.lang.Object

A builder for creating an IngressSpec for consuming data from AWS Kinesis.

Method Summary

Modifier and Type	Method and Description
KinesisIngressSpec<T>	build()
static <T> KinesisIngressBuilder<T>	forIdentifier(IngressIdentifier<T> id)
KinesisIngressBuilder<T>	withAwsCredentials(AwsCredentials awsCredentials) The AWS credentials to use.
KinesisIngressBuilder<T>	withAwsRegion(AwsRegion awsRegion) The AWS region to connect to.
KinesisIngressBuilder<T>	withAwsRegion(java.lang.String regionName) The AWS region to connect to, specified by the AWS region's unique id.
KinesisIngressBuilder<T>	withClientConfigurationProperty(java.lang.String key, java.lang.String value) Deprecated. Please use withProperty(String, String) instead.
KinesisIngressBuilder<T>	withDeserializer(java.lang.Class<? extends KinesisIngressDeserializer<T>> deserializerClass)
KinesisIngressBuilder<T>	withProperties(java.util.Properties properties)
KinesisIngressBuilder<T>	withProperty(java.lang.String key, java.lang.String value)
KinesisIngressBuilder<T>	withStartupPosition(KinesisIngressStartupPosition startupPosition) Configures the position that the ingress should start consuming from.
KinesisIngressBuilder<T>	withStream(java.lang.String stream)
KinesisIngressBuilder<T>	withStreams(java.util.List<java.lang.String> streams)

Methods inherited from class java.lang.Object

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

Method Detail

forIdentifier

public static <T> KinesisIngressBuilder<T> forIdentifier(IngressIdentifier<T> id)

Type Parameters:

T - The type consumed from Kinesis.

Parameters:

id - A unique ingress identifier.

Returns:

A new KinesisIngressBuilder.

withStream

public KinesisIngressBuilder<T> withStream(java.lang.String stream)

Parameters:

stream - The name of a stream that should be consumed.

withStreams

public KinesisIngressBuilder<T> withStreams(java.util.List<java.lang.String> streams)

Parameters:

streams - A list of streams that should be consumed.

withDeserializer

public KinesisIngressBuilder<T> withDeserializer(java.lang.Class<? extends KinesisIngressDeserializer<T>> deserializerClass)

Parameters:

deserializerClass - The deserializer used to convert between Kinesis's byte messages and Java objects.

withStartupPosition

public KinesisIngressBuilder<T> withStartupPosition(KinesisIngressStartupPosition startupPosition)

Configures the position that the ingress should start consuming from. By default, the startup position is KinesisIngressStartupPosition.fromLatest().

Note that this configuration only affects the position when starting the application from a fresh start. When restoring the application from a savepoint, the ingress will always start consuming from the position persisted in the savepoint.

Parameters:

startupPosition - the position that the Kafka ingress should start consuming from.

See Also:

KinesisIngressStartupPosition

withAwsRegion

public KinesisIngressBuilder<T> withAwsRegion(AwsRegion awsRegion)

The AWS region to connect to. By default, AWS's default provider chain is consulted.

Parameters:

awsRegion - The AWS region to connect to.

See Also:

Automatically Determine the AWS Region from the Environment., AwsRegion

withAwsRegion

public KinesisIngressBuilder<T> withAwsRegion(java.lang.String regionName)

The AWS region to connect to, specified by the AWS region's unique id. By default, AWS's default provider chain is consulted.

Parameters:

regionName - The unique id of the AWS region to connect to.

withAwsCredentials

public KinesisIngressBuilder<T> withAwsCredentials(AwsCredentials awsCredentials)

The AWS credentials to use. By default, AWS's default provider chain is consulted.

Parameters:

awsCredentials - The AWS credentials to use.

See Also:

Using the Default Credential Provider Chain., AwsCredentials

withClientConfigurationProperty

@Deprecated
public KinesisIngressBuilder<T> withClientConfigurationProperty(java.lang.String key,
                                                                            java.lang.String value)

Deprecated. Please use withProperty(String, String) instead.

Sets a AWS client configuration to be used by the ingress.

Supported values are properties of AWS's com.aws.ClientConfiguration. For example, to set a value for SOCKET_TIMEOUT, the property key would be SocketTimeout.

Parameters:

key - the property to set.

value - the value for the property.

See Also:

com.aws.ClientConfiguration.

withProperty

public KinesisIngressBuilder<T> withProperty(java.lang.String key,
                                             java.lang.String value)

withProperties

public KinesisIngressBuilder<T> withProperties(java.util.Properties properties)

build

public KinesisIngressSpec<T> build()

Returns:

A new KinesisIngressSpec.