org.apache.flink.api.connector.sink2

Interface InitContext

All Known Subinterfaces:

CommitterInitContext, Sink.InitContext, WriterInitContext

All Known Implementing Classes:

Sink.InitContextWrapper

@Internal
public interface InitContext

Common interface which exposes runtime info for creating SinkWriter and Committer objects.

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
default int	getAttemptNumber() Deprecated. This method is deprecated since Flink 1.19. All metadata about the task should be provided uniformly by getTaskInfo().
default JobID	getJobId() Deprecated. This method is deprecated since Flink 1.19. All metadata about the job should be provided uniformly by getJobInfo().
JobInfo	getJobInfo() Get the meta information of current job.
default int	getNumberOfParallelSubtasks() Deprecated. This method is deprecated since Flink 1.19. All metadata about the task should be provided uniformly by getTaskInfo().
OptionalLong	getRestoredCheckpointId() Returns id of the restored checkpoint, if state was restored from the snapshot of a previous execution.
default int	getSubtaskId() Deprecated. This method is deprecated since Flink 1.19. All metadata about the task should be provided uniformly by getTaskInfo().
TaskInfo	getTaskInfo() Get the meta information of current task.

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

getSubtaskId

@Deprecated
default int getSubtaskId()

Deprecated. This method is deprecated since Flink 1.19. All metadata about the task should be provided uniformly by getTaskInfo().

Get the id of task where the committer is running.

See Also:

FLIP-382: Unify the Provision of Diverse Metadata for Context-like APIs

getNumberOfParallelSubtasks

@Deprecated
default int getNumberOfParallelSubtasks()

Deprecated. This method is deprecated since Flink 1.19. All metadata about the task should be provided uniformly by getTaskInfo().

Get the number of parallel committer tasks.

See Also:

FLIP-382: Unify the Provision of Diverse Metadata for Context-like APIs

getAttemptNumber

@Deprecated
default int getAttemptNumber()

Deprecated. This method is deprecated since Flink 1.19. All metadata about the task should be provided uniformly by getTaskInfo().

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

Returns:

Attempt number of the subtask.

See Also:

FLIP-382: Unify the Provision of Diverse Metadata for Context-like APIs

getRestoredCheckpointId

OptionalLong getRestoredCheckpointId()

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

getJobId

@Deprecated
default JobID getJobId()

Deprecated. This method is deprecated since Flink 1.19. All metadata about the job should be provided uniformly by getJobInfo().

The ID of the current job. Note that Job ID can change in particular upon manual restart. The returned ID should NOT be used for any job management tasks.

See Also:

FLIP-382: Unify the Provision of Diverse Metadata for Context-like APIs

getJobInfo

@PublicEvolving
JobInfo getJobInfo()

Get the meta information of current job.

Returns:

the job meta information.

getTaskInfo

@PublicEvolving
TaskInfo getTaskInfo()

Get the meta information of current task.

Returns:

the task meta information.