Package org.apache.nifi.schemaregistry.services

Interface SchemaRegistry

All Superinterfaces:
org.apache.nifi.components.ConfigurableComponent, org.apache.nifi.controller.ControllerService
public interface SchemaRegistry extends org.apache.nifi.controller.ControllerService
Represents ControllerService strategy to expose internal and/or integrate with external Schema Registry

  • Method Summary

    Modifier and Type
    Method
    Description
    Set<org.apache.nifi.schema.access.SchemaField>
    getSuppliedSchemaFields()
     
    org.apache.nifi.serialization.record.RecordSchema
    retrieveSchema(org.apache.nifi.serialization.record.SchemaIdentifier schemaIdentifier)
    Retrieves the schema based on the provided descriptor.

    Methods inherited from interface org.apache.nifi.components.ConfigurableComponent

    getIdentifier, getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

    Methods inherited from interface org.apache.nifi.controller.ControllerService

    initialize, isStateful, migrateProperties

  • Method Details

    • retrieveSchema

      org.apache.nifi.serialization.record.RecordSchema retrieveSchema(org.apache.nifi.serialization.record.SchemaIdentifier schemaIdentifier) throws IOException, org.apache.nifi.schema.access.SchemaNotFoundException
      Retrieves the schema based on the provided descriptor. The descriptor must contain and schemaIdentifier or name, but not both, along with a version, and an optional branch name. For implementations that do not support branching, the branch name will be ignored.
      Parameters:
      schemaIdentifier - a schema schemaIdentifier
      Returns:
      the schema for the given descriptor
      Throws:
      IOException - if unable to communicate with the backing store
      org.apache.nifi.schema.access.SchemaNotFoundException - if unable to find the schema based on the given descriptor

    • getSuppliedSchemaFields

      Set<org.apache.nifi.schema.access.SchemaField> getSuppliedSchemaFields()
      Returns:
      the set of all Schema Fields that are supplied by the RecordSchema that is returned from retrieveSchema(SchemaIdentifier)