Starts a gRPC server and listens on the given port to transform the incoming messages into FlowFiles. The message format can be a pre-defined standard FlowFile data structure (attributes and content) provided by NiFi or user defined message types and services can also be used. gRPC isn't intended to carry large payloads, so this processor should be used only when the message sizes are on the order of megabytes. The default maximum message size is 4MB.
| Display Name | API Name | Default Value | Allowable Values | Description |
|---|
| Local gRPC Service Port | Local gRPC service port | | | The local port that the gRPC service will listen on. |
| Use TLS | Use TLS | false | | Whether or not to use TLS to receive the contents of the gRPC messages. |
| SSL Context Service | SSL Context Service | | Controller Service API:
RestrictedSSLContextService
Implementation: StandardRestrictedSSLContextService | The SSL Context Service used to provide server certificate information for TLS (https) connections. Keystore must be configured on the service. If truststore is also configured, it will turn on and require client certificate authentication (Mutual TLS).
This Property is only considered if the [Use TLS] Property has a value of "true". |
| Authorized DN Pattern | Authorized DN Pattern | .* | | A Regular Expression to apply against the Distinguished Name of incoming connections. If the Pattern does not match the DN, the connection will be refused. The property will only be used if client certificate authentication (Mutual TLS) has been configured on SSL Context Service, otherwise it will be ignored.
This Property is only considered if the [Use TLS] Property has a value of "true". |
| Flow Control Window | Flow Control Window | 1MB | | The initial HTTP/2 flow control window for both new streams and overall connection. Flow-control schemes ensure that streams on the same connection do not destructively interfere with each other. The default is 1MB. |
| Maximum Message Size | Max Message Size | 4MB | | The maximum size of FlowFiles that this processor will allow to be received. The default is 4MB. If FlowFiles exceed this size, you should consider using another transport mechanism as gRPC isn't designed for heavy payloads. |
| Service Type | service-type | FlowFile Ingest Service | - FlowFile Ingest Service
 - Custom Ingest Service
| Pre-defined FlowFile ingest service or user defined custom services. In case of 'Custom Ingest Service', multiple services with multiple methods can be used. Each method will be handled as a data ingestion procedure and the request object will be converted to FlowFile content and/or FlowFile attributes. The response object will be null. |
| Proto Directory | proto-directory | | | Directory containing Protocol Buffers message and service definition (.proto) file(s).
Supports Expression Language: true (will be evaluated using variable registry only)
This Property is only considered if the [Service Type] Property has a value of "Custom Ingest Service". |
| Output Field | output-field | | | Field of the request message to output as the FlowFile content (e.g. customer.name). If not specified, the whole request 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 variable registry only)
This Property is only considered if the [Service Type] Property has a value of "Custom Ingest Service". |
Dynamic Properties allow the user to specify both the name and value of a property.