Package org.apache.druid.segment.incremental

Enum Class InputRowFilterResult

java.lang.Object

java.lang.Enum<InputRowFilterResult>

org.apache.druid.segment.incremental.InputRowFilterResult

All Implemented Interfaces:

Serializable, Comparable<InputRowFilterResult>, Constable

public enum InputRowFilterResult
extends Enum<InputRowFilterResult>

Result of filtering an input row during ingestion.

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
ACCEPTED	The row passed the filter and should be processed.
AFTER_MAX_MESSAGE_TIME	The row's timestamp is after the maximum message time (early message rejection).
BEFORE_MIN_MESSAGE_TIME	The row's timestamp is before the minimum message time (late message rejection).
CUSTOM_FILTER	The row was filtered out by a transformSpec filter or other row filter.
NULL_OR_EMPTY_RECORD	The row was null or the input record was empty.
UNKNOWN	A backwards-compatible value for tracking filter reasons for ingestion tasks using older Druid versions without filter reason tracking.

Method Summary

Modifier and Type	Method	Description
String	getReason()	Returns string value representation of this InputRowFilterResult for metric emission.
boolean	isRejected()	Returns true if this result indicates the row was rejected (thrown away).
static int	numValues()	Returns total number of InputRowFilterResult values.
static InputRowFilterResult[]	rejectedValues()	Returns InputRowFilterResult that are rejection states.
static InputRowFilterResult	valueOf(String name)	Returns the enum constant of this class with the specified name.
static InputRowFilterResult[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ACCEPTED

public static final InputRowFilterResult ACCEPTED

The row passed the filter and should be processed.

NULL_OR_EMPTY_RECORD

public static final InputRowFilterResult NULL_OR_EMPTY_RECORD

The row was null or the input record was empty.

BEFORE_MIN_MESSAGE_TIME

public static final InputRowFilterResult BEFORE_MIN_MESSAGE_TIME

The row's timestamp is before the minimum message time (late message rejection).

AFTER_MAX_MESSAGE_TIME

public static final InputRowFilterResult AFTER_MAX_MESSAGE_TIME

The row's timestamp is after the maximum message time (early message rejection).

CUSTOM_FILTER

public static final InputRowFilterResult CUSTOM_FILTER

The row was filtered out by a transformSpec filter or other row filter.

UNKNOWN

public static final InputRowFilterResult UNKNOWN

A backwards-compatible value for tracking filter reasons for ingestion tasks using older Druid versions without filter reason tracking.

Method Details

values

public static InputRowFilterResult[] 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 InputRowFilterResult 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

getReason

public String getReason()

Returns string value representation of this InputRowFilterResult for metric emission.

isRejected

public boolean isRejected()

Returns true if this result indicates the row was rejected (thrown away). Returns false for ACCEPTED.

rejectedValues

public static InputRowFilterResult[] rejectedValues()

Returns InputRowFilterResult that are rejection states.

numValues

public static int numValues()

Returns total number of InputRowFilterResult values.