org.apache.flink.api.connector.sink2

Interface Sink.InitContext

Enclosing interface:

Sink<InputT>

@PublicEvolving
public static interface Sink.InitContext

The interface exposes some runtime info for creating a SinkWriter.

Field Summary

Fields

Modifier and Type	Field and Description
static long	INITIAL_CHECKPOINT_ID The first checkpoint id when an application is started and not recovered from a previously taken checkpoint or savepoint.

Method Summary

Modifier and Type	Method and Description
SerializationSchema.InitializationContext	asSerializationSchemaInitializationContext() Provides a view on this context as a SerializationSchema.InitializationContext.
int	getAttemptNumber() Gets the attempt number of this parallel subtask.
MailboxExecutor	getMailboxExecutor() Returns the mailbox executor that allows to execute Runnables inside the task thread in between record processing.
int	getNumberOfParallelSubtasks()
ProcessingTimeService	getProcessingTimeService() Returns a ProcessingTimeService that can be used to get the current time and register timers.
OptionalLong	getRestoredCheckpointId() Returns id of the restored checkpoint, if state was restored from the snapshot of a previous execution.
int	getSubtaskId()
UserCodeClassLoader	getUserCodeClassLoader() Gets the UserCodeClassLoader to load classes that are not in system's classpath, but are part of the jar file of a user job.
default <MetaT> Optional<java.util.function.Consumer<MetaT>>	metadataConsumer() Returns a metadata consumer, the SinkWriter can publish metadata events of type MetaT to the consumer.
SinkWriterMetricGroup	metricGroup()

Field Detail

INITIAL_CHECKPOINT_ID

static final long INITIAL_CHECKPOINT_ID

The first checkpoint id when an application is started and not recovered from a previously taken checkpoint or savepoint.

See Also:

Constant Field Values

Method Detail

getUserCodeClassLoader

UserCodeClassLoader getUserCodeClassLoader()

Gets the UserCodeClassLoader to load classes that are not in system's classpath, but are part of the jar file of a user job.

See Also:

UserCodeClassLoader

getMailboxExecutor

MailboxExecutor getMailboxExecutor()

Returns the mailbox executor that allows to execute Runnables inside the task thread in between record processing.

Note that this method should not be used per-record for performance reasons in the same way as records should not be sent to the external system individually. Rather, implementers are expected to batch records and only enqueue a single Runnable per batch to handle the result.

getProcessingTimeService

ProcessingTimeService getProcessingTimeService()

Returns a ProcessingTimeService that can be used to get the current time and register timers.

getSubtaskId

int getSubtaskId()

Returns:

The id of task where the writer is.

getNumberOfParallelSubtasks

int getNumberOfParallelSubtasks()

Returns:

The number of parallel Sink tasks.

getAttemptNumber

int getAttemptNumber()

Gets the attempt number of this parallel subtask. First attempt is numbered 0.

Returns:

Attempt number of the subtask.

metricGroup

SinkWriterMetricGroup metricGroup()

Returns:

The metric group this writer belongs to.

getRestoredCheckpointId

OptionalLong getRestoredCheckpointId()

Returns id of the restored checkpoint, if state was restored from the snapshot of a previous execution.

asSerializationSchemaInitializationContext

SerializationSchema.InitializationContext asSerializationSchemaInitializationContext()

Provides a view on this context as a SerializationSchema.InitializationContext.

metadataConsumer

@Experimental
default <MetaT> Optional<java.util.function.Consumer<MetaT>> metadataConsumer()

Returns a metadata consumer, the SinkWriter can publish metadata events of type MetaT to the consumer.

It is recommended to use a separate thread pool to publish the metadata because enqueuing a lot of these messages in the mailbox may lead to a performance decrease. thread, and the Consumer.accept(T) method is executed very fast.