| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutWebSocket</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;">PutWebSocket</h1><h2>Description: </h2><p>Sends messages to a WebSocket remote endpoint using a WebSocket session that is established by either ListenWebSocket or ConnectWebSocket.</p><h3>Tags: </h3><p>WebSocket, publish, send</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, and whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>.</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>WebSocket Session Id</strong></td><td>websocket-session-id</td><td id="default-value">${websocket.session.id}</td><td id="allowable-values"></td><td id="description">A NiFi Expression to retrieve the session id. If not specified, a message will be sent to all connected WebSocket peers for the WebSocket controller service endpoint.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>WebSocket ControllerService Id</strong></td><td>websocket-controller-service-id</td><td id="default-value">${websocket.controller.service.id}</td><td id="allowable-values"></td><td id="description">A NiFi Expression to retrieve the id of a WebSocket ControllerService.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>WebSocket Endpoint Id</strong></td><td>websocket-endpoint-id</td><td id="default-value">${websocket.endpoint.id}</td><td id="allowable-values"></td><td id="description">A NiFi Expression to retrieve the endpoint id of a WebSocket ControllerService.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>WebSocket Message Type</strong></td><td>websocket-message-type</td><td id="default-value">TEXT</td><td id="allowable-values"></td><td id="description">The type of message content: TEXT or BINARY<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>FlowFiles that are sent successfully to the destination are transferred to this relationship.</td></tr><tr><td>failure</td><td>FlowFiles that failed to send to the destination are transferred to this relationship.</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>websocket.controller.service.id</td><td>WebSocket Controller Service id.</td></tr><tr><td>websocket.session.id</td><td>Established WebSocket session id.</td></tr><tr><td>websocket.endpoint.id</td><td>WebSocket endpoint id.</td></tr><tr><td>websocket.message.type</td><td>TEXT or BINARY.</td></tr><tr><td>websocket.local.address</td><td>WebSocket server address.</td></tr><tr><td>websocket.remote.address</td><td>WebSocket client address.</td></tr><tr><td>websocket.failure.detail</td><td>Detail of the failure.</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><table id="system-resource-considerations"><tr><th>Resource</th><th>Description</th></tr><tr><td>MEMORY</td><td>An instance of this component can cause high usage of this system resource. Multiple instances or high concurrency settings may result a degradation of performance.</td></tr></table></body></html> |