org.apache.nifi.serialization.record

Interface RecordSchema

All Known Implementing Classes:

SimpleRecordSchema

public interface RecordSchema

Method Summary

Modifier and Type	Method and Description
Optional<DataType>	getDataType(String fieldName)
List<DataType>	getDataTypes()
RecordField	getField(int index)
Optional<RecordField>	getField(String fieldName)
int	getFieldCount()
List<String>	getFieldNames()
List<RecordField>	getFields()
SchemaIdentifier	getIdentifier()
Optional<String>	getSchemaFormat()
Optional<String>	getSchemaName()
Optional<String>	getSchemaNamespace()
Optional<String>	getSchemaText()

Method Detail

getFields

List<RecordField> getFields()

Returns:

the list of fields that are present in the schema

getFieldCount

int getFieldCount()

Returns:

the number of fields in the schema

getField

RecordField getField(int index)

Parameters:

index - the 0-based index of which field to return

Returns:

the index'th field

Throws:

IndexOutOfBoundsException - if the index is < 0 or >= the number of fields (determined by getFieldCount()).

getDataTypes

List<DataType> getDataTypes()

Returns:

the data types of the fields

getFieldNames

List<String> getFieldNames()

Returns:

the names of the fields

getDataType

Optional<DataType> getDataType(String fieldName)

Parameters:

fieldName - the name of the field whose type is desired

Returns:

the RecordFieldType associated with the field that has the given name, or null if the schema does not contain a field with the given name

getSchemaText

Optional<String> getSchemaText()

Returns:

the textual representation of the schema, if one is available

getSchemaFormat

Optional<String> getSchemaFormat()

Returns:

the format of the schema text, if schema text is present

getField

Optional<RecordField> getField(String fieldName)

Parameters:

fieldName - the name of the field

Returns:

an Optional RecordField for the field with the given name

getIdentifier

SchemaIdentifier getIdentifier()

Returns:

the SchemaIdentifier, which provides various attributes for identifying a schema

getSchemaName

Optional<String> getSchemaName()

Returns:

the name of the schema's root record.

getSchemaNamespace

Optional<String> getSchemaNamespace()

Returns:

the namespace of the schema.