Package io.confluent.kafka.schemaregistry.rules

Class RuleResult

java.lang.Object

io.confluent.kafka.schemaregistry.rules.RuleResult

public final class RuleResult
extends Object

Outcome of a single rule's execution during deserialization, along with any metadata the rule executor produced. One RuleResult is appended per rule visited (including skipped rules) and surfaced via ParsedSchemaAndValue.getRuleResults().

Executor metadata is published in two parallel maps:

• messageMetadata() — message-level key/value attributes (one map for the whole rule execution).
• fieldMetadata() — per-field attributes, keyed by field path; each value is a key/value map specific to that field.

All values are String. Absent keys mean "not recorded" — null values are never stored. Specific key conventions are documented by the executor that produces them (for example, see EncryptionExecutor).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	RuleResult.Result	Outcome of a rule's execution.

Constructor Summary

Constructors

Constructor	Description
RuleResult(Rule rule, RuleResult.Result result, String errorMessage, Map<String,String> messageMetadata, Map<String,Map<String,String>> fieldMetadata)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	errorMessage()	The exception message when result() is RuleResult.Result.FAILURE; null otherwise.
Map<String,Map<String,String>>	fieldMetadata()	Per-field metadata produced by the executor, keyed by field path.
int	hashCode()
Map<String,String>	messageMetadata()	Message-level metadata produced by the executor.
RuleResult.Result	result()
Rule	rule()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

RuleResult

public RuleResult(Rule rule,
 RuleResult.Result result,
 String errorMessage,
 Map<String,String> messageMetadata,
 Map<String,Map<String,String>> fieldMetadata)

Method Details

rule

public Rule rule()

result

public RuleResult.Result result()

errorMessage

public String errorMessage()

The exception message when result() is RuleResult.Result.FAILURE; null otherwise.

messageMetadata

public Map<String,String> messageMetadata()

Message-level metadata produced by the executor. Always non-null; empty when the executor produced nothing at the message level.

fieldMetadata

public Map<String,Map<String,String>> fieldMetadata()

Per-field metadata produced by the executor, keyed by field path. Always non-null; empty when the executor produced no field-level metadata.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object