YamlTreeReader

YamlTreeReader 2.0.0

Bundle: org.apache.nifi | nifi-record-serialization-services-nar
Description: Parses YAML into individual Record objects. While the reader expects each record to be well-formed YAML, the content of a FlowFile may consist of many records, each as a well-formed YAML array or YAML object. If an array is encountered, each element in that array will be treated as a separate record. If the schema that is configured contains a field that is not present in the YAML, a null value will be used. If the YAML contains a field that is not present in the schema, that field will be skipped. Please note this controller service does not support resolving the use of YAML aliases. Any alias present will be treated as a string. See the Usage of the Controller Service for more information and examples.
Tags: parser, reader, record, tree, yaml
Input Requirement
Supports Sensitive Dynamic Properties: false

Properties

Allow Comments
Whether to allow comments when parsing the JSON document
Display Name

Allow Comments

Description

Whether to allow comments when parsing the JSON document

API Name

Allow Comments

Default Value

false

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Date Format
Specifies the format to use when reading/writing Date fields. If not specified, Date fields will be assumed to be number of milliseconds since epoch (Midnight, Jan 1, 1970 GMT). If specified, the value must match the Java java.time.format.DateTimeFormatter format (for example, MM/dd/yyyy for a two-digit month, followed by a two-digit day, followed by a four-digit year, all separated by '/' characters, as in 01/01/2017).

Display Name

Date Format

Description

Specifies the format to use when reading/writing Date fields. If not specified, Date fields will be assumed to be number of milliseconds since epoch (Midnight, Jan 1, 1970 GMT). If specified, the value must match the Java java.time.format.DateTimeFormatter format (for example, MM/dd/yyyy for a two-digit month, followed by a two-digit day, followed by a four-digit year, all separated by '/' characters, as in 01/01/2017).

API Name

Date Format

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Max String Length
The maximum allowed length of a string value when parsing the JSON document

Display Name

Max String Length

Description

The maximum allowed length of a string value when parsing the JSON document

API Name

Max String Length

Default Value

20 MB

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Schema Access Strategy
Specifies how to obtain the schema that is to be used for interpreting the data.
Display Name

Schema Access Strategy

Description

Specifies how to obtain the schema that is to be used for interpreting the data.

API Name

schema-access-strategy

Default Value

infer-schema

Allowable Values
- Infer Schema
- Use 'Schema Name' Property
- Use 'Schema Text' Property
- Schema Reference Reader
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Schema Application Strategy
Specifies whether the schema is defined for the whole JSON or for the selected part starting from "Starting Field Name".
Display Name

Schema Application Strategy

Description

Specifies whether the schema is defined for the whole JSON or for the selected part starting from "Starting Field Name".

API Name

schema-application-strategy

Default Value

SELECTED_PART

Allowable Values
- Whole JSON
- Selected Part
Expression Language Scope

Not Supported

Sensitive

false

Required

true

Dependencies
- Starting Field Strategy is set to any of [NESTED_FIELD]
- Schema Access Strategy is set to any of [schema-reference-reader, schema-name, schema-text-property]
Schema Branch
Specifies the name of the branch to use when looking up the schema in the Schema Registry property. If the chosen Schema Registry does not support branching, this value will be ignored.
Display Name

Schema Branch

Description

Specifies the name of the branch to use when looking up the schema in the Schema Registry property. If the chosen Schema Registry does not support branching, this value will be ignored.

API Name

schema-branch

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false

Dependencies
- Schema Access Strategy is set to any of [schema-name]
Schema Inference Cache
Specifies a Schema Cache to use when inferring the schema. If not populated, the schema will be inferred each time. However, if a cache is specified, the cache will first be consulted and if the applicable schema can be found, it will be used instead of inferring the schema.
Display Name

Schema Inference Cache

Description

Specifies a Schema Cache to use when inferring the schema. If not populated, the schema will be inferred each time. However, if a cache is specified, the cache will first be consulted and if the applicable schema can be found, it will be used instead of inferring the schema.

API Name

schema-inference-cache

Service Interface

org.apache.nifi.serialization.RecordSchemaCacheService

Service Implementations

org.apache.nifi.schema.inference.VolatileSchemaCache

Expression Language Scope

Not Supported

Sensitive

false

Required

false

Dependencies
- Schema Access Strategy is set to any of [infer-schema]
Schema Name
Specifies the name of the schema to lookup in the Schema Registry property
Display Name

Schema Name

Description

Specifies the name of the schema to lookup in the Schema Registry property

API Name

schema-name

Default Value

${schema.name}

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false

Dependencies
- Schema Access Strategy is set to any of [schema-name]
Schema Reference Reader
Service implementation responsible for reading FlowFile attributes or content to determine the Schema Reference Identifier
Display Name

Schema Reference Reader

Description

Service implementation responsible for reading FlowFile attributes or content to determine the Schema Reference Identifier

API Name

schema-reference-reader

Service Interface

org.apache.nifi.schemaregistry.services.SchemaReferenceReader

Service Implementations

org.apache.nifi.confluent.schemaregistry.ConfluentEncodedSchemaReferenceReader

Expression Language Scope

Not Supported

Sensitive

false

Required

true

Dependencies
- Schema Access Strategy is set to any of [schema-reference-reader]
Schema Registry
Specifies the Controller Service to use for the Schema Registry
Display Name

Schema Registry

Description

Specifies the Controller Service to use for the Schema Registry

API Name

schema-registry

Service Interface

org.apache.nifi.schemaregistry.services.SchemaRegistry

Service Implementations

org.apache.nifi.aws.schemaregistry.AmazonGlueSchemaRegistry

org.apache.nifi.apicurio.schemaregistry.ApicurioSchemaRegistry

org.apache.nifi.schemaregistry.services.AvroSchemaRegistry

org.apache.nifi.confluent.schemaregistry.ConfluentSchemaRegistry

org.apache.nifi.db.schemaregistry.DatabaseTableSchemaRegistry

Expression Language Scope

Not Supported

Sensitive

false

Required

false

Dependencies
- Schema Access Strategy is set to any of [schema-reference-reader, schema-name]
Schema Text
The text of an Avro-formatted Schema
Display Name

Schema Text

Description

The text of an Avro-formatted Schema

API Name

schema-text

Default Value

${avro.schema}

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false

Dependencies
- Schema Access Strategy is set to any of [schema-text-property]
Schema Version
Specifies the version of the schema to lookup in the Schema Registry. If not specified then the latest version of the schema will be retrieved.
Display Name

Schema Version

Description

Specifies the version of the schema to lookup in the Schema Registry. If not specified then the latest version of the schema will be retrieved.

API Name

schema-version

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false

Dependencies
- Schema Access Strategy is set to any of [schema-name]
Starting Field Name
Skips forward to the given nested JSON field (array or object) to begin processing.
Display Name

Starting Field Name

Description

Skips forward to the given nested JSON field (array or object) to begin processing.

API Name

starting-field-name

Expression Language Scope

Not Supported

Sensitive

false

Required

false

Dependencies
- Starting Field Strategy is set to any of [NESTED_FIELD]
Starting Field Strategy
Start processing from the root node or from a specified nested node.
Display Name

Starting Field Strategy

Description

Start processing from the root node or from a specified nested node.

API Name

starting-field-strategy

Default Value

ROOT_NODE

Allowable Values
- Root Node
- Nested Field
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Time Format
Specifies the format to use when reading/writing Time fields. If not specified, Time fields will be assumed to be number of milliseconds since epoch (Midnight, Jan 1, 1970 GMT). If specified, the value must match the Java java.time.format.DateTimeFormatter format (for example, HH:mm:ss for a two-digit hour in 24-hour format, followed by a two-digit minute, followed by a two-digit second, all separated by ':' characters, as in 18:04:15).

Display Name

Time Format

Description

Specifies the format to use when reading/writing Time fields. If not specified, Time fields will be assumed to be number of milliseconds since epoch (Midnight, Jan 1, 1970 GMT). If specified, the value must match the Java java.time.format.DateTimeFormatter format (for example, HH:mm:ss for a two-digit hour in 24-hour format, followed by a two-digit minute, followed by a two-digit second, all separated by ':' characters, as in 18:04:15).

API Name

Time Format

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Timestamp Format
Specifies the format to use when reading/writing Timestamp fields. If not specified, Timestamp fields will be assumed to be number of milliseconds since epoch (Midnight, Jan 1, 1970 GMT). If specified, the value must match the Java java.time.format.DateTimeFormatter format (for example, MM/dd/yyyy HH:mm:ss for a two-digit month, followed by a two-digit day, followed by a four-digit year, all separated by '/' characters; and then followed by a two-digit hour in 24-hour format, followed by a two-digit minute, followed by a two-digit second, all separated by ':' characters, as in 01/01/2017 18:04:15).

Display Name

Timestamp Format

Description

Specifies the format to use when reading/writing Timestamp fields. If not specified, Timestamp fields will be assumed to be number of milliseconds since epoch (Midnight, Jan 1, 1970 GMT). If specified, the value must match the Java java.time.format.DateTimeFormatter format (for example, MM/dd/yyyy HH:mm:ss for a two-digit month, followed by a two-digit day, followed by a four-digit year, all separated by '/' characters; and then followed by a two-digit hour in 24-hour format, followed by a two-digit minute, followed by a two-digit second, all separated by ':' characters, as in 01/01/2017 18:04:15).

API Name

Timestamp Format

Expression Language Scope

Not Supported

Sensitive

false

Required

false