io.micronaut.configuration.kafka.annotation

Enum ErrorStrategyValue

java.lang.Object

java.lang.Enum<ErrorStrategyValue>

io.micronaut.configuration.kafka.annotation.ErrorStrategyValue

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ErrorStrategyValue>

public enum ErrorStrategyValue
extends java.lang.Enum<ErrorStrategyValue>

Defines the type of error handling strategy that micronaut-kafka will perform in case of error. The default exception handler or any custom exception handler will be performed after the error handling strategy has been run.

Since:

4.1

Author:

Christopher Webb, Vishal Sulibhavi

Enum Constant Summary

Enum Constants

Enum Constant and Description
NONE Deprecated. maintain broken, but consistent behaviour with previous versions of micronaut-kafka that do not support error strategy. See https://github.com/micronaut-projects/micronaut-kafka/issues/372
RESUME_AT_NEXT_RECORD This strategy will ignore the current error and will resume at the next offset.
RETRY_EXPONENTIALLY_ON_ERROR This strategy will stop consuming subsequent records in the case of an error and will attempt to re-consume the current record with exponentially growing time breaks between consumption attempts.
RETRY_ON_ERROR This strategy will stop consuming subsequent records in the case of an error and will attempt to re-consume the current record indefinitely.

Method Summary

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

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

RETRY_ON_ERROR

public static final ErrorStrategyValue RETRY_ON_ERROR

This strategy will stop consuming subsequent records in the case of an error and will attempt to re-consume the current record indefinitely.

RETRY_EXPONENTIALLY_ON_ERROR

public static final ErrorStrategyValue RETRY_EXPONENTIALLY_ON_ERROR

This strategy will stop consuming subsequent records in the case of an error and will attempt to re-consume the current record with exponentially growing time breaks between consumption attempts. Breaks' duration is computed based on the n * 2^(k - 1) formula, where n is the initial delay, and k is the number of retries.

RESUME_AT_NEXT_RECORD

public static final ErrorStrategyValue RESUME_AT_NEXT_RECORD

This strategy will ignore the current error and will resume at the next offset.

NONE

@Deprecated
public static final ErrorStrategyValue NONE

Deprecated. maintain broken, but consistent behaviour with previous versions of micronaut-kafka that do not support error strategy. See https://github.com/micronaut-projects/micronaut-kafka/issues/372

This error strategy will skip over all records from the current offset in the current poll when the consumer encounters an error.

Method Detail

values

public static ErrorStrategyValue[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ErrorStrategyValue c : ErrorStrategyValue.values())
    System.out.println(c);

Returns:

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

valueOf

public static ErrorStrategyValue valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null