ProtobufReader

Description

Parses a Protocol Buffers message from binary format.

Tags

parser, protobuf, reader, record

Properties

In the list below required Properties are shown with an asterisk (*). Other properties are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Display Name

API Name

Default Value

Allowable Values

Description

Message Type *

Message Type

Fully qualified name of the Protocol Buffers message type including its package (eg. mypackage.MyMessage). The .proto files configured in ‘Proto Directory’ must contain the definition of this message type.

Proto Directory *

Proto Directory

Directory containing Protocol Buffers message definition (.proto) file(s).

Schema Access Strategy *

schema-access-strategy

generate-from-proto-file

  • Use ‘Schema Name’ Property

  • Use ‘Schema Text’ Property

  • Schema Reference Reader

  • Generate from Proto file

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

Schema Branch

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.

Schema Name

schema-name

${schema.name}

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

Schema Reference Reader *

schema-reference-reader

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

Schema Registry

schema-registry

Specifies the Controller Service to use for the Schema Registry

Schema Text

schema-text

${avro.schema}

The text of an Avro-formatted Schema

Schema Version

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.

State management

This component does not store state.

Restricted

This component is not restricted.

System Resource Considerations

This component does not specify system resource considerations.