Package org.apache.flink.core.failure

Interface FailureEnricher.Context

Enclosing interface:

FailureEnricher

@Experimental
public static interface FailureEnricher.Context

An interface used by the FailureEnricher. Context includes an executor pool for the enrichers to run heavy operations, the Classloader used for code gen, and other metadata.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	FailureEnricher.Context.FailureType	Type of failure.

Method Summary

Modifier and Type	Method	Description
FailureEnricher.Context.FailureType	getFailureType()	Return the type of the failure e.g., global failure that happened in the scheduler context.
Executor	getIOExecutor()	Get an Executor pool for the Enrichers to run async operations that can potentially be IO-heavy.
default JobID	getJobId()	Deprecated. This method is deprecated since Flink 1.19.
JobInfo	getJobInfo()	Get the meta information of current job.
default String	getJobName()	Deprecated. This method is deprecated since Flink 1.19.
org.apache.flink.metrics.MetricGroup	getMetricGroup()	Get the metric group of the JobMaster.
ClassLoader	getUserClassLoader()	Get the user ClassLoader used for code generation, UDF loading and other operations requiring reflections on user code.

Method Detail

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().

Get the ID of the job.

Returns:

the ID of the job

See Also:

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

getJobName

@Deprecated
default String getJobName()

Deprecated.

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

Get the name of the job.

Returns:

the name of the job

See Also:

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

getMetricGroup

org.apache.flink.metrics.MetricGroup getMetricGroup()

Get the metric group of the JobMaster.

Returns:

the metric group of the JobMaster

getFailureType

FailureEnricher.Context.FailureType getFailureType()

Return the type of the failure e.g., global failure that happened in the scheduler context.

Returns:

FailureType

getUserClassLoader

ClassLoader getUserClassLoader()

Get the user ClassLoader used for code generation, UDF loading and other operations requiring reflections on user code.

Returns:

the user ClassLoader

getIOExecutor

Executor getIOExecutor()

Get an Executor pool for the Enrichers to run async operations that can potentially be IO-heavy.

Returns:

the Executor pool

getJobInfo

@PublicEvolving
JobInfo getJobInfo()

Get the meta information of current job.

Returns:

the job meta information.