org.apache.flink.statefun.sdk.kinesis.egress

Class KinesisEgressBuilder<T>

java.lang.Object

org.apache.flink.statefun.sdk.kinesis.egress.KinesisEgressBuilder<T>

Type Parameters:

T - The type written to AWS Kinesis.

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

A builder for creating an EgressSpec for writing data to AWS Kinesis.

Method Summary

Modifier and Type	Method and Description
KinesisEgressSpec<T>	build()
static <T> KinesisEgressBuilder<T>	forIdentifier(EgressIdentifier<T> id)
KinesisEgressBuilder<T>	withAwsCredentials(AwsCredentials awsCredentials) The AWS credentials to use.
KinesisEgressBuilder<T>	withAwsRegion(AwsRegion awsRegion) The AWS region to connect to.
KinesisEgressBuilder<T>	withAwsRegion(java.lang.String regionName) The AWS region to connect to, specified by the AWS region's unique id.
KinesisEgressBuilder<T>	withClientConfigurationProperty(java.lang.String key, java.lang.String value) Deprecated. Please use withProperty(String, String) instead.
KinesisEgressBuilder<T>	withMaxOutstandingRecords(int maxOutstandingRecords) The maximum number of buffered outstanding records, before backpressure is applied by the egress.
KinesisEgressBuilder<T>	withProperties(java.util.Properties properties)
KinesisEgressBuilder<T>	withProperty(java.lang.String key, java.lang.String value)
KinesisEgressBuilder<T>	withSerializer(java.lang.Class<? extends KinesisEgressSerializer<T>> serializerClass)

Methods inherited from class java.lang.Object

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

Method Detail

forIdentifier

public static <T> KinesisEgressBuilder<T> forIdentifier(EgressIdentifier<T> id)

Type Parameters:

T - The type consumed from Kinesis.

Parameters:

id - A unique egress identifier.

Returns:

A new KinesisEgressBuilder.

withSerializer

public KinesisEgressBuilder<T> withSerializer(java.lang.Class<? extends KinesisEgressSerializer<T>> serializerClass)

Parameters:

serializerClass - The serializer used to convert from Java objects to Kinesis's byte messages.

withAwsRegion

public KinesisEgressBuilder<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 KinesisEgressBuilder<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 KinesisEgressBuilder<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

withMaxOutstandingRecords

public KinesisEgressBuilder<T> withMaxOutstandingRecords(int maxOutstandingRecords)

The maximum number of buffered outstanding records, before backpressure is applied by the egress.

Parameters:

maxOutstandingRecords - the maximum number of buffered outstanding records

withClientConfigurationProperty

public KinesisEgressBuilder<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 egress.

Supported values are properties of AWS's ccom.amazonaws.services.kinesis.producer.KinesisProducerConfiguration. Please see Default Configuration Properties for a full list of the keys.

Parameters:

key - the property to set.

value - the value for the property.

See Also:

com.aws.ClientConfiguration.

withProperty

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

withProperties

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

build

public KinesisEgressSpec<T> build()

Returns:

A new KinesisEgressSpec.