public interface SchemaRegistry extends ControllerService
ControllerService strategy to expose internal and/or
integrate with external Schema Registry| Modifier and Type | Method and Description |
|---|---|
Set<SchemaField> |
getSuppliedSchemaFields() |
default RecordSchema |
retrieveSchema(long schemaId,
int version)
Deprecated.
Use
retrieveSchema(SchemaIdentifier) instead
Retrieves the schema with the given ID and version. The RecordSchema that is returned must have the Schema's identifier and version
populated in its SchemaIdentifier. I.e., a call to
RecordSchema.getIdentifier().getIdentifier()
will always return an Optional that is not empty, as will a call to
RecordSchema.getIdentifier().getVersion(). |
RecordSchema |
retrieveSchema(SchemaIdentifier schemaIdentifier)
Retrieves the schema based on the provided descriptor.
|
default RecordSchema |
retrieveSchema(String schemaName)
Deprecated.
Use
retrieveSchema(SchemaIdentifier) instead
Retrieves and returns the RecordSchema based on the provided name of the schema available in Schema Registry. The RecordSchema
that is returned must have the Schema's name populated in its SchemaIdentifier. I.e., a call to
RecordSchema.getIdentifier().getName()
will always return an Optional that is not empty. |
default String |
retrieveSchemaText(long schemaId,
int version)
Deprecated.
Use
retrieveSchema(SchemaIdentifier) instead
Retrieves the textual representation of the schema with the given ID and version |
default String |
retrieveSchemaText(String schemaName)
Deprecated.
Use
retrieveSchema(SchemaIdentifier) instead
Retrieves and returns the textual representation of the schema based on
the provided name of the schema available in Schema Registry. |
initialize, isStatefulgetIdentifier, getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validatedefault String retrieveSchemaText(String schemaName) throws IOException, SchemaNotFoundException
retrieveSchema(SchemaIdentifier) instead
Retrieves and returns the textual representation of the schema based on
the provided name of the schema available in Schema Registry.IOException - if unable to communicate with the backing storeSchemaNotFoundException - if unable to find the schema with the given namedefault String retrieveSchemaText(long schemaId, int version) throws IOException, SchemaNotFoundException
retrieveSchema(SchemaIdentifier) instead
Retrieves the textual representation of the schema with the given ID and versionschemaId - the unique identifier for the desired schemaversion - the version of the desired schemaIOException - if unable to communicate with the backing storeSchemaNotFoundException - if unable to find the schema with the given id and versiondefault RecordSchema retrieveSchema(String schemaName) throws IOException, SchemaNotFoundException
retrieveSchema(SchemaIdentifier) instead
Retrieves and returns the RecordSchema based on the provided name of the schema available in Schema Registry. The RecordSchema
that is returned must have the Schema's name populated in its SchemaIdentifier. I.e., a call to
RecordSchema.getIdentifier().getName()
will always return an Optional that is not empty.null if no schema can be found with the given name.SchemaNotFoundException - if unable to find the schema with the given nameIOExceptiondefault RecordSchema retrieveSchema(long schemaId, int version) throws IOException, SchemaNotFoundException
retrieveSchema(SchemaIdentifier) instead
Retrieves the schema with the given ID and version. The RecordSchema that is returned must have the Schema's identifier and version
populated in its SchemaIdentifier. I.e., a call to
RecordSchema.getIdentifier().getIdentifier()
will always return an Optional that is not empty, as will a call to
RecordSchema.getIdentifier().getVersion().schemaId - the unique identifier for the desired schemaversion - the version of the desired schemanull if no schema
can be found with the given ID and versionIOException - if unable to communicate with the backing storeSchemaNotFoundException - if unable to find the schema with the given id and versionRecordSchema retrieveSchema(SchemaIdentifier schemaIdentifier) throws IOException, SchemaNotFoundException
schemaIdentifier - a schema schemaIdentifierIOException - if unable to communicate with the backing storeSchemaNotFoundException - if unable to find the schema based on the given descriptorSet<SchemaField> getSuppliedSchemaFields()
retrieveSchema(SchemaIdentifier)Copyright © 2023 Apache NiFi Project. All rights reserved.