Package io.confluent.kafka.schemaregistry

Interface ParsedSchemaAndValue

public interface ParsedSchemaAndValue
A parsed schema with a value, produced by deserialization.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    ParsedSchemaAndValue.SchemaInfo
     

  • Method Summary

    Modifier and Type
    Method
    Description
    default List<RuleResult>
    getRuleResults()
    Results of the rules visited during deserialization, one entry per rule (including rules that were skipped because they were disabled, in the wrong execution environment, or whose mode did not match the current phase).
    ParsedSchema
    getSchema()
    The reader schema used to interpret the value.
    Object
    getValue()
    The deserialized value, projected into the reader schema.
    default ParsedSchema
    getWriterSchema()
    The writer's parsed schema, as it appeared on the wire payload.
    default ParsedSchemaAndValue.SchemaInfo
    getWriterSchemaInfo()
    Identifying info (subject / id / version / guid) for the writer schema, resolved from the wire payload.

  • Method Details

    • getSchema

      ParsedSchema getSchema()
      The reader schema used to interpret the value. When the consumer has registered a reader schema that differs from the writer schema on the wire, this returns the reader schema and getWriterSchema() returns the writer schema; otherwise the two may be equal.

    • getValue

      Object getValue()
      The deserialized value, projected into the reader schema. Validating this against getWriterSchema() may fail when the reader and writer schemas differ structurally.

    • getWriterSchema

      default ParsedSchema getWriterSchema()
      The writer's parsed schema, as it appeared on the wire payload. May differ from getSchema() when schema projection / migration is in play. Returns null when the deserializer did not resolve a writer schema (unusual).

    • getWriterSchemaInfo

      default ParsedSchemaAndValue.SchemaInfo getWriterSchemaInfo()
      Identifying info (subject / id / version / guid) for the writer schema, resolved from the wire payload. Returns null when nothing was resolved. Individual fields on a populated SchemaInfo may still be null (some deserializer paths know the id but not the guid, for example).

    • getRuleResults

      default List<RuleResult> getRuleResults()
      Results of the rules visited during deserialization, one entry per rule (including rules that were skipped because they were disabled, in the wrong execution environment, or whose mode did not match the current phase). Order matches rule execution order.

      Returns an empty, unmodifiable list when no rules ran.