<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GetTwitter</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;">GetTwitter</h1><h2>Deprecation notice: </h2><p>GetTwitter relies on the Twitter Hosebird client, which is not maintained. This processor will be removed in future releases.</p><p>Please consider using one the following alternatives: <a href="../org.apache.nifi.processors.twitter.ConsumeTwitter/index.html">ConsumeTwitter</a></p><h2>Description: </h2><p>Pulls status changes from Twitter's streaming API. In versions starting with 1.9.0, the Consumer Key and Access Token are marked as sensitive according to https://developer.twitter.com/en/docs/basics/authentication/guides/securing-keys-and-tokens</p><h3>Tags: </h3><p>twitter, tweets, social media, status, json</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>Twitter Endpoint</strong></td><td>Twitter Endpoint</td><td id="default-value">Sample Endpoint</td><td id="allowable-values"><ul><li>Sample Endpoint <img src="../../../../../html/images/iconInfo.png" alt="The endpoint that provides public data, aka a 'garden hose'" title="The endpoint that provides public data, aka a 'garden hose'"></img></li><li>Firehose Endpoint <img src="../../../../../html/images/iconInfo.png" alt="The endpoint that provides access to all tweets" title="The endpoint that provides access to all tweets"></img></li><li>Filter Endpoint <img src="../../../../../html/images/iconInfo.png" alt="Endpoint that allows the stream to be filtered by specific terms or User IDs" title="Endpoint that allows the stream to be filtered by specific terms or User IDs"></img></li></ul></td><td id="description">Specifies which endpoint data should be pulled from</td></tr><tr><td id="name"><strong>Max Client Error Retries</strong></td><td>max-client-error-retries</td><td id="default-value">5</td><td id="allowable-values"></td><td id="description">The maximum number of retries to attempt when client experience retryable connection errors. Client continues attempting to reconnect using an exponential back-off pattern until it successfully reconnects or until it reaches the retry limit.  It is recommended to raise this value when client is getting rate limited by Twitter API. Default value is 5.</td></tr><tr><td id="name"><strong>Consumer Key</strong></td><td>Consumer Key</td><td></td><td id="allowable-values"></td><td id="description">The Consumer Key provided by Twitter<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>Consumer Secret</strong></td><td>Consumer Secret</td><td></td><td id="allowable-values"></td><td id="description">The Consumer Secret provided by Twitter<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>Access Token</strong></td><td>Access Token</td><td></td><td id="allowable-values"></td><td id="description">The Access Token provided by Twitter<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>Access Token Secret</strong></td><td>Access Token Secret</td><td></td><td id="allowable-values"></td><td id="description">The Access Token Secret provided by Twitter<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name">Languages</td><td>Languages</td><td></td><td id="allowable-values"></td><td id="description">A comma-separated list of languages for which tweets should be fetched</td></tr><tr><td id="name">Terms to Filter On</td><td>Terms to Filter On</td><td></td><td id="allowable-values"></td><td id="description">A comma-separated list of terms to filter on. Ignored unless Endpoint is set to 'Filter Endpoint'. The filter works such that if any term matches, the status update will be retrieved; multiple terms separated by a space function as an 'AND'. I.e., 'it was, hello' will retrieve status updates that have either 'hello' or both 'it' AND 'was'</td></tr><tr><td id="name">IDs to Follow</td><td>IDs to Follow</td><td></td><td id="allowable-values"></td><td id="description">A comma-separated list of Twitter User ID's to follow. Ignored unless Endpoint is set to 'Filter Endpoint'.</td></tr><tr><td id="name">Locations to Filter On</td><td>Locations to Filter On</td><td></td><td id="allowable-values"></td><td id="description">A comma-separated list of coordinates specifying one or more bounding boxes to filter on.Each bounding box is specified by a pair of coordinates in the format: swLon,swLat,neLon,neLat. Multiple bounding boxes can be specified as such: swLon1,swLat1,neLon1,neLat1,swLon2,swLat2,neLon2,neLat2.Ignored unless Endpoint is set to 'Filter Endpoint'.</td></tr></table><h3>Dynamic Properties: </h3><p>Supports Sensitive Dynamic Properties: <strong>No</strong></p><p>Dynamic Properties allow the user to specify both the name and value of a property.<table id="dynamic-properties"><tr><th>Name</th><th>Value</th><th>Description</th></tr><tr><td id="name">The name of a query parameter to add to the Twitter query</td><td id="value">The value of a query parameter to add to the Twitter query</td><td>Allows users to specify the name/value of a query parameter to add to the Twitter query<br/><strong>Supports Expression Language: false</strong></td></tr></table></p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All status updates will be routed 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>mime.type</td><td>Sets mime type to application/json</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 does not allow an incoming relationship.<h3>System Resource Considerations:</h3>None specified.</body></html>