Record Class ReconfigureError

java.lang.Object
java.lang.Record
io.kroxylicious.proxy.reload.ReconfigureError
Record Components:
humanReadableIdentifier - a best-effort identifier of the failed component; non-null
cause - the underlying failure; non-null

public record ReconfigureError(String humanReadableIdentifier, Throwable cause) extends Record
One per-component failure encountered during a KafkaProxy.reconfigure(Configuration) call. Contains an identifier suitable for human consumption (logs, alerts, admin endpoints) and the underlying cause for programmatic typed handling.

Identifier semantics. humanReadableIdentifier is a best-effort string that identifies which component failed (a virtual cluster name, a referenced filter, etc.). The string's format is implementation-defined and intended for human consumption. Programmatic consumers (triggers deciding whether to roll back, retry, shut down, etc.) should inspect cause() for typed failure detection rather than parsing the identifier.

  • Constructor Details

    • ReconfigureError

      public ReconfigureError(String humanReadableIdentifier, Throwable cause)
      Creates an instance of a ReconfigureError record class.
      Parameters:
      humanReadableIdentifier - the value for the humanReadableIdentifier record component
      cause - the value for the cause record component
  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object
    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object
    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.
    • humanReadableIdentifier

      public String humanReadableIdentifier()
      Returns the value of the humanReadableIdentifier record component.
      Returns:
      the value of the humanReadableIdentifier record component
    • cause

      public Throwable cause()
      Returns the value of the cause record component.
      Returns:
      the value of the cause record component