Package org.apache.beam.sdk.io.aws2.kinesis

Class KinesisWriteSchemaTransformProvider.KinesisWriteSchemaTransformConfiguration

java.lang.Object

org.apache.beam.sdk.io.aws2.kinesis.KinesisWriteSchemaTransformProvider.KinesisWriteSchemaTransformConfiguration

All Implemented Interfaces:

Serializable

Enclosing class:

KinesisWriteSchemaTransformProvider

@DefaultSchema(AutoValueSchema.class)
public abstract static class KinesisWriteSchemaTransformProvider.KinesisWriteSchemaTransformConfiguration
extends Object
implements Serializable

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	KinesisWriteSchemaTransformProvider.KinesisWriteSchemaTransformConfiguration.Builder

Constructor Summary

Constructors

Constructor	Description
KinesisWriteSchemaTransformConfiguration()

Method Summary

Modifier and Type	Method	Description
static KinesisWriteSchemaTransformProvider.KinesisWriteSchemaTransformConfiguration.Builder	builder()
abstract @Nullable Boolean	getAggregationEnabled()
abstract @Nullable Long	getAggregationMaxBufferedTime()
abstract @Nullable Long	getAggregationMaxBytes()
abstract @Nullable Long	getAggregationShardRefreshInterval()
abstract String	getAwsAccessKey()
abstract String	getAwsSecretKey()
abstract String	getPartitionKey()
abstract String	getRegion()
abstract @Nullable String	getServiceEndpoint()
abstract String	getStreamName()
abstract @Nullable Boolean	getVerifyCertificate()

Methods inherited from class java.lang.Object

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

Constructor Details

KinesisWriteSchemaTransformConfiguration

public KinesisWriteSchemaTransformConfiguration()

Method Details

builder

public static KinesisWriteSchemaTransformProvider.KinesisWriteSchemaTransformConfiguration.Builder builder()

getStreamName

@SchemaFieldDescription("Kinesis stream name to write to.")
public abstract String getStreamName()

getAwsAccessKey

@SchemaFieldDescription("AWS access key id.")
public abstract String getAwsAccessKey()

getAwsSecretKey

@SchemaFieldDescription("AWS secret access key.")
public abstract String getAwsSecretKey()

getRegion

@SchemaFieldDescription("AWS region, for example us-east-1.")
public abstract String getRegion()

getPartitionKey

@SchemaFieldDescription("Default partition key used when the input row does not contain a partition_key field.")
public abstract String getPartitionKey()

getServiceEndpoint

@SchemaFieldDescription("Optional custom Kinesis service endpoint URI.")
public abstract @Nullable String getServiceEndpoint()

getVerifyCertificate

@SchemaFieldDescription("Whether to verify TLS certificates. Defaults to true. Never disable in production.")
public abstract @Nullable Boolean getVerifyCertificate()

getAggregationEnabled

@SchemaFieldDescription("Enable KPL-compatible record aggregation.")
public abstract @Nullable Boolean getAggregationEnabled()

getAggregationMaxBytes

@SchemaFieldDescription("Max aggregated record size in bytes when aggregation is enabled.")
public abstract @Nullable Long getAggregationMaxBytes()

getAggregationMaxBufferedTime

@SchemaFieldDescription("Max time in milliseconds to buffer records when aggregation is enabled.")
public abstract @Nullable Long getAggregationMaxBufferedTime()

getAggregationShardRefreshInterval

@SchemaFieldDescription("Shard map refresh interval in minutes when aggregation is enabled.")
public abstract @Nullable Long getAggregationShardRefreshInterval()