Enum Class ProductionExceptionHandler.Result

java.lang.Object

java.lang.Enum<ProductionExceptionHandler.Result>

org.apache.kafka.streams.errors.ProductionExceptionHandler.Result

All Implemented Interfaces:

Serializable, Comparable<ProductionExceptionHandler.Result>, Constable

Enclosing interface:

ProductionExceptionHandler

public static enum ProductionExceptionHandler.Result
extends Enum<ProductionExceptionHandler.Result>

Enumeration that describes the response from the exception handler.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FAIL	Fail processing.
RESUME	Resume processing.
RETRY	Retry the failed operation.

Field Summary

Fields

Modifier and Type	Field	Description
final int	id	The permanent and immutable id for the used option.
final String	name	An english description for the used option.

Method Summary

Modifier and Type	Method	Description
static ProductionExceptionHandler.Result	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ProductionExceptionHandler.Result[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

RESUME

public static final ProductionExceptionHandler.Result RESUME

Resume processing.

For this case, output records which could not be written successfully are lost. Use this option only if you can tolerate data loss.

FAIL

public static final ProductionExceptionHandler.Result FAIL

Fail processing.

Kafka Streams will raise an exception and the StreamsThread will fail. No offsets (for at-least-once) or transactions (for exactly-once) will be committed.

RETRY

public static final ProductionExceptionHandler.Result RETRY

Retry the failed operation.

Retrying might imply that a TaskCorruptedException exception is thrown, and that the retry is started from the last committed offset.

NOTE: RETRY is only a valid return value for retriable exceptions. If RETRY is returned for a non-retriable exception it will be interpreted as FAIL.

Field Details

name

public final String name

An english description for the used option. This is for debugging only and may change.

id

public final int id

The permanent and immutable id for the used option. This can't change ever.

Method Details

values

public static ProductionExceptionHandler.Result[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ProductionExceptionHandler.Result valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null