org.apache.flink.connector.firehose.table

Class KinesisFirehoseDynamicSink

java.lang.Object

org.apache.flink.connector.base.table.sink.AsyncDynamicTableSink<software.amazon.awssdk.services.firehose.model.Record>

org.apache.flink.connector.firehose.table.KinesisFirehoseDynamicSink

All Implemented Interfaces:

DynamicTableSink

@Internal
public class KinesisFirehoseDynamicSink
extends AsyncDynamicTableSink<software.amazon.awssdk.services.firehose.model.Record>

Kinesis firehose backed AsyncDynamicTableSink.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KinesisFirehoseDynamicSink.KinesisFirehoseDynamicSinkBuilder Builder class for KinesisFirehoseDynamicSink.

Nested classes/interfaces inherited from interface org.apache.flink.table.connector.sink.DynamicTableSink

DynamicTableSink.Context, DynamicTableSink.DataStructureConverter, DynamicTableSink.SinkRuntimeProvider

Field Summary

Fields inherited from class org.apache.flink.connector.base.table.sink.AsyncDynamicTableSink

maxBatchSize, maxBufferedRequests, maxBufferSizeInBytes, maxInFlightRequests, maxTimeInBufferMS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	KinesisFirehoseDynamicSink(Integer maxBatchSize, Integer maxInFlightRequests, Integer maxBufferedRequests, Long maxBufferSizeInBytes, Long maxTimeInBufferMS, Boolean failOnError, DataType consumedDataType, String deliveryStream, Properties firehoseClientProperties, EncodingFormat<SerializationSchema<RowData>> encodingFormat)

Method Summary

Modifier and Type	Method and Description
String	asSummaryString() Returns a string that summarizes this sink for printing to a console or log.
DynamicTableSink	copy() Creates a copy of this instance during planning.
ChangelogMode	getChangelogMode(ChangelogMode requestedMode) Returns the set of changes that the sink accepts during runtime.
DynamicTableSink.SinkRuntimeProvider	getSinkRuntimeProvider(DynamicTableSink.Context context) Returns a provider of runtime implementation for writing the data.

Methods inherited from class org.apache.flink.connector.base.table.sink.AsyncDynamicTableSink

addAsyncOptionsToSinkBuilder, equals, hashCode

Methods inherited from class java.lang.Object

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

Constructor Detail

KinesisFirehoseDynamicSink

protected KinesisFirehoseDynamicSink(@Nullable
                                     Integer maxBatchSize,
                                     @Nullable
                                     Integer maxInFlightRequests,
                                     @Nullable
                                     Integer maxBufferedRequests,
                                     @Nullable
                                     Long maxBufferSizeInBytes,
                                     @Nullable
                                     Long maxTimeInBufferMS,
                                     @Nullable
                                     Boolean failOnError,
                                     @Nullable
                                     DataType consumedDataType,
                                     String deliveryStream,
                                     @Nullable
                                     Properties firehoseClientProperties,
                                     EncodingFormat<SerializationSchema<RowData>> encodingFormat)

Method Detail

getChangelogMode

public ChangelogMode getChangelogMode(ChangelogMode requestedMode)

Description copied from interface: DynamicTableSink

Returns the set of changes that the sink accepts during runtime.

The planner can make suggestions but the sink has the final decision what it requires. If the planner does not support this mode, it will throw an error. For example, the sink can return that it only supports ChangelogMode.insertOnly().

Parameters:

requestedMode - expected set of changes by the current plan

getSinkRuntimeProvider

public DynamicTableSink.SinkRuntimeProvider getSinkRuntimeProvider(DynamicTableSink.Context context)

Description copied from interface: DynamicTableSink

Returns a provider of runtime implementation for writing the data.

There might exist different interfaces for runtime implementation which is why DynamicTableSink.SinkRuntimeProvider serves as the base interface. Concrete DynamicTableSink.SinkRuntimeProvider interfaces might be located in other Flink modules.

Independent of the provider interface, the table runtime expects that a sink implementation accepts internal data structures (see RowData for more information).

The given DynamicTableSink.Context offers utilities by the planner for creating runtime implementation with minimal dependencies to internal data structures.

SinkProvider is the recommended core interface. SinkFunctionProvider in flink-table-api-java-bridge and OutputFormatProvider are available for backwards compatibility.

See Also:

SinkProvider

copy

public DynamicTableSink copy()

Description copied from interface: DynamicTableSink

Creates a copy of this instance during planning. The copy should be a deep copy of all mutable members.

asSummaryString

public String asSummaryString()

Description copied from interface: DynamicTableSink

Returns a string that summarizes this sink for printing to a console or log.