| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>InvokeGRPC</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">InvokeGRPC</h1><h2>Description: </h2><p>Sends FlowFiles, optionally with content, to a configurable remote gRPC service endpoint. The remote gRPC service must abide by the service IDL defined in NiFi. gRPC isn't intended to carry large payloads, so this processor should be used only when FlowFile sizes are on the order of megabytes. The default maximum message size is 4MB.</p><h3>Tags: </h3><p>grpc, rpc, client</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values.</p><table id="properties"><tr><th>Display Name</th><th>API Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Remote gRPC service hostname</strong></td><td>Remote gRPC service hostname</td><td></td><td id="allowable-values"></td><td id="description">Remote host which will be connected to</td></tr><tr><td id="name"><strong>Remote gRPC service port</strong></td><td>Remote gRPC service port</td><td></td><td id="allowable-values"></td><td id="description">Remote port which will be connected to</td></tr><tr><td id="name">Max Message Size</td><td>Max Message Size</td><td id="default-value">4MB</td><td id="allowable-values"></td><td id="description">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.</td></tr><tr><td id="name">Use TLS</td><td>Use SSL/TLS</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Whether or not to use TLS to send the contents of the gRPC messages.</td></tr><tr><td id="name">SSL Context Service</td><td>SSL Context Service</td><td></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Implementations: </strong><a href="../../../nifi-ssl-context-service-nar/1.19.1/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</a><br/><a href="../../../nifi-ssl-context-service-nar/1.19.1/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td id="description">The SSL Context Service used to provide client certificate information for TLS (https) connections.<br/><br/><strong>This Property is only considered if </strong><strong>the [Use TLS] Property has a value of "true".</strong></td></tr><tr><td id="name">Send FlowFile Content</td><td>Send FlowFile Content</td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Whether or not to include the FlowFile content in the FlowFileRequest to the gRPC service.</td></tr><tr><td id="name">Always Output Response</td><td>Always Output Response</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Will force a response FlowFile to be generated and routed to the 'Response' relationship regardless of what the server status code received is or if the processor is configured to put the server response body in the request attribute. In the later configuration a request FlowFile with the response body in the attribute and a typical response FlowFile will be emitted to their respective relationships.</td></tr><tr><td id="name">Penalize on "No Retry"</td><td>Penalize on "No Retry"</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Enabling this property will penalize FlowFiles that are routed to the "No Retry" relationship.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>Original</td><td>The original FlowFile will be routed upon success. It will have new attributes detailing the success of the request.</td></tr><tr><td>Failure</td><td>The original FlowFile will be routed on any type of connection failure, timeout or general exception. It will have new attributes detailing the request.</td></tr><tr><td>Retry</td><td>The original FlowFile will be routed on any status code that can be retried. It will have new attributes detailing the request.</td></tr><tr><td>No Retry</td><td>The original FlowFile will be routed on any status code that should NOT be retried. It will have new attributes detailing the request.</td></tr><tr><td>Response</td><td>A Response FlowFile will be routed upon success. If the 'Output Response Regardless' property is true then the response will be sent to this relationship regardless of the status code received.</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>invokegrpc.response.code</td><td>The response code that is returned (0 = ERROR, 1 = SUCCESS, 2 = RETRY)</td></tr><tr><td>invokegrpc.response.body</td><td>The response message that is returned</td></tr><tr><td>invokegrpc.service.host</td><td>The remote gRPC service hostname</td></tr><tr><td>invokegrpc.service.port</td><td>The remote gRPC service port</td></tr><tr><td>invokegrpc.java.exception.class</td><td>The Java exception class raised when the processor fails</td></tr><tr><td>invokegrpc.java.exception.message</td><td>The Java exception message raised when the processor fails</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</h3>None specified.</body></html> |