Converts a Protocol Buffers message from binary format. The content of the output FlowFile can be the whole message converted to JSON or a field of the message. Individual message fields can also be converted to FlowFile attributes.
protobuf
In the list below, the names of required properties appear in bold. Any other properties (not in bold) 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 |
|---|---|---|---|---|
| Proto Directory | proto-directory | Directory containing Protocol Buffers message definition (.proto) file(s). Supports Expression Language: true (will be evaluated using variable registry only) | ||
| Message Type | message-type | Fully qualified name of the Protocol Buffers message type including its package (eg. mypackage.MyMessage). Please note it is the message type name from the .proto file, not the name of the generated Java class. The .proto files configured in 'Proto Directory' must contain the definition of this message type. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) | ||
| Output Field | output-field | Field of the message to output as the FlowFile content (e.g. customer.name). If not specified, the whole message will be converted to JSON and will be set in the FlowFile content. If empty string specified, no FlowFile content will be set. The latter can be used when message fields are extracted to FlowFile attributes instead of content (see dynamic properties). Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
Supports Sensitive Dynamic Properties: No
Dynamic Properties allow the user to specify both the name and value of a property.
| Name | Value | Description |
|---|---|---|
| message$<FIELD.PATH> | FlowFile attribute name | The property name specifies the field in the request message whose value will be added as a FlowFile attribute with the name specified in the property's value (e.g. message$customer.name => customerName). Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
| Name | Description |
|---|---|
| success | Protocol Buffers message converted successfully. |
| failure | Protocol Buffers message failed to be converted. |