Package io.confluent.kafka.schemaregistry.rules

Enum Class RuleResult.Result

java.lang.Object

java.lang.Enum<RuleResult.Result>

io.confluent.kafka.schemaregistry.rules.RuleResult.Result

All Implemented Interfaces:

Serializable, Comparable<RuleResult.Result>, Constable

Enclosing class:

RuleResult

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

Outcome of a rule's execution.

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
FAILURE	The rule failed.
SKIPPED	The rule was skipped — disabled, environment mismatch, or its mode did not match the current phase.
SUCCESS	The rule's transform ran, did not throw, and (for TRANSFORM rules) returned a non-null value.

Method Summary

Modifier and Type	Method	Description
static RuleResult.Result	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RuleResult.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

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

SUCCESS

public static final RuleResult.Result SUCCESS

The rule's transform ran, did not throw, and (for TRANSFORM rules) returned a non-null value.

FAILURE

public static final RuleResult.Result FAILURE

The rule failed. Any of:

• the transform threw,
• a CONDITION rule returned false,
• a TRANSFORM rule returned null, or
• no executor was registered for the rule's type.

In all cases the rule's onFailure action runs; if RuleResult.errorMessage() is set it reflects the underlying cause.

SKIPPED

public static final RuleResult.Result SKIPPED

The rule was skipped — disabled, environment mismatch, or its mode did not match the current phase. The transform did not run.

Method Details

values

public static RuleResult.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 RuleResult.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