Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.sqs.GetSQS/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.sqs.GetSQS/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.sqs.GetSQS/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.sqs.GetSQS/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GetSQS</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Fetches messages from an Amazon Simple Queuing Service Queue</p><h3>Tags: </h3><p>Amazon, AWS, SQS, Queue, Get, Fetch, Poll</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, whether a property supports the <a href="../../html/expression-language-guide.html">NiFi Expression Language</a>, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th>< th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Queue URL</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The URL of the queue to act upon<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Auto Delete Messages</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specifies whether the messages should be automatically deleted by the processors once they have been received.</td></tr><tr><td id="name">Access Key</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">No Description Provided.<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Secret Key</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">No Description Provided.<br/><strong>Sensitive Property: tr ue</strong><br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Credentials File</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Path to a file containing AWS access key and secret key in properties file format.</td></tr><tr><td id="name">AWS Credentials Provider service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>AWSCredentialsProviderService<br/><strong>Implementation:</strong><br/><a href="../org.apache.nifi.processors.aws.credentials.provider.service.AWSCredentialsProviderControllerService/index.html">AWSCredentialsProviderControllerService</a></td><td id="description">The Controller Service that is used to obtain aws credentials provider</td></tr><tr><td id="name"><strong>Region</strong></td><td id="default-value">us-west-2</td><td id="allowable-values"><ul><li>us-gov-west-1 <img src="../../html/images/iconInfo.png" alt="us-gov-west-1" title="us-gov-wes t-1"></img></li><li>us-east-1 <img src="../../html/images/iconInfo.png" alt="us-east-1" title="us-east-1"></img></li><li>us-west-1 <img src="../../html/images/iconInfo.png" alt="us-west-1" title="us-west-1"></img></li><li>us-west-2 <img src="../../html/images/iconInfo.png" alt="us-west-2" title="us-west-2"></img></li><li>eu-west-1 <img src="../../html/images/iconInfo.png" alt="eu-west-1" title="eu-west-1"></img></li><li>eu-central-1 <img src="../../html/images/iconInfo.png" alt="eu-central-1" title="eu-central-1"></img></li><li>ap-southeast-1 <img src="../../html/images/iconInfo.png" alt="ap-southeast-1" title="ap-southeast-1"></img></li><li>ap-southeast-2 <img src="../../html/images/iconInfo.png" alt="ap-southeast-2" title="ap-southeast-2"></img></li><li>ap-northeast-1 <img src="../../html/images/iconInfo.png" alt="ap-northeast-1" title="ap-northeast-1"></img></li><li>ap-northeast-2 <img src="../../html/images/iconInfo.png" alt="ap-northeast-2" title="ap-northeast-2"></img></li><li >sa-east-1 <img src="../../html/images/iconInfo.png" alt="sa-east-1" >title="sa-east-1"></img></li><li>cn-north-1 <img >src="../../html/images/iconInfo.png" alt="cn-north-1" >title="cn-north-1"></img></li></ul></td><td id="description">No Description >Provided.</td></tr><tr><td id="name"><strong>Batch Size</strong></td><td >id="default-value">10</td><td id="allowable-values"></td><td >id="description">The maximum number of messages to send in a single network >request</td></tr><tr><td id="name"><strong>Communications >Timeout</strong></td><td id="default-value">30 secs</td><td >id="allowable-values"></td><td id="description">No Description >Provided.</td></tr><tr><td id="name"><strong>Character Set</strong></td><td >id="default-value">UTF-8</td><td >id="allowable-values"><ul><li>Big5</li><li>Big5-HKSCS</li><li>CESU-8</li><li>EUC-JP</li><li>EUC-KR</li><li>GB18030</li><li>GB2312</li><li>GBK</li><li>IBM-Thai</li><li>IBM00858</li><li>IBM01140</li><li>IBM01141</li><li>IBM01142</li><li>IBM01143</li>< li>IBM01144</li><li>IBM01145</li><li>IBM01146</li><li>IBM01147</li><li>IBM01148</li><li>IBM01149</li><li>IBM037</li><li>IBM1026</li><li>IBM1047</li><li>IBM273</li><li>IBM277</li><li>IBM278</li><li>IBM280</li><li>IBM284</li><li>IBM285</li><li>IBM290</li><li>IBM297</li><li>IBM420</li><li>IBM424</li><li>IBM437</li><li>IBM500</li><li>IBM775</li><li>IBM850</li><li>IBM852</li><li>IBM855</li><li>IBM857</li><li>IBM860</li><li>IBM861</li><li>IBM862</li><li>IBM863</li><li>IBM864</li><li>IBM865</li><li>IBM866</li><li>IBM868</li><li>IBM869</li><li>IBM870</li><li>IBM871</li><li>IBM918</li><li>ISO-2022-CN</li><li>ISO-2022-JP</li><li>ISO-2022-JP-2</li><li>ISO-2022-KR</li><li>ISO-8859-1</li><li>ISO-8859-13</li><li>ISO-8859-15</li><li>ISO-8859-2</li><li>ISO-8859-3</li><li>ISO-8859-4</li><li>ISO-8859-5</li><li>ISO-8859-6</li><li>ISO-8859-7</li><li>ISO-8859-8</li><li>ISO-8859-9</li><li>JIS_X0201</li><li>JIS_X0212-1990</li><li>KOI8-R</li><li>KOI8-U</li><li>Shift_JIS</li><li>TIS-620</li><li>US-ASCII</li ><li>UTF-16</li><li>UTF-16BE</li><li>UTF-16LE</li><li>UTF-32</li><li>UTF-32BE</li><li>UTF-32LE</li><li>UTF-8</li><li>windows-1250</li><li>windows-1251</li><li>windows-1252</li><li>windows-1253</li><li>windows-1254</li><li>windows-1255</li><li>windows-1256</li><li>windows-1257</li><li>windows-1258</li><li>windows-31j</li><li>x-Big5-HKSCS-2001</li><li>x-Big5-Solaris</li><li>x-COMPOUND_TEXT</li><li>x-euc-jp-linux</li><li>x-EUC-TW</li><li>x-eucJP-Open</li><li>x-IBM1006</li><li>x-IBM1025</li><li>x-IBM1046</li><li>x-IBM1097</li><li>x-IBM1098</li><li>x-IBM1112</li><li>x-IBM1122</li><li>x-IBM1123</li><li>x-IBM1124</li><li>x-IBM1166</li><li>x-IBM1364</li><li>x-IBM1381</li><li>x-IBM1383</li><li>x-IBM300</li><li>x-IBM33722</li><li>x-IBM737</li><li>x-IBM833</li><li>x-IBM834</li><li>x-IBM856</li><li>x-IBM874</li><li>x-IBM875</li><li>x-IBM921</li><li>x-IBM922</li><li>x-IBM930</li><li>x-IBM933</li><li>x-IBM935</li><li>x-IBM937</li><li>x-IBM939</li><li>x-IBM942</li><li>x-IBM942C</li><li>x-IBM943</l i><li>x-IBM943C</li><li>x-IBM948</li><li>x-IBM949</li><li>x-IBM949C</li><li>x-IBM950</li><li>x-IBM964</li><li>x-IBM970</li><li>x-ISCII91</li><li>x-ISO-2022-CN-CNS</li><li>x-ISO-2022-CN-GB</li><li>x-iso-8859-11</li><li>x-JIS0208</li><li>x-JISAutoDetect</li><li>x-Johab</li><li>x-MacArabic</li><li>x-MacCentralEurope</li><li>x-MacCroatian</li><li>x-MacCyrillic</li><li>x-MacDingbat</li><li>x-MacGreek</li><li>x-MacHebrew</li><li>x-MacIceland</li><li>x-MacRoman</li><li>x-MacRomania</li><li>x-MacSymbol</li><li>x-MacThai</li><li>x-MacTurkish</li><li>x-MacUkraine</li><li>x-MS932_0213</li><li>x-MS950-HKSCS</li><li>x-MS950-HKSCS-XP</li><li>x-mswin-936</li><li>x-PCK</li><li>x-SJIS_0213</li><li>x-UTF-16LE-BOM</li><li>X-UTF-32BE-BOM</li><li>X-UTF-32LE-BOM</li><li>x-windows-50220</li><li>x-windows-50221</li><li>x-windows-874</li><li>x-windows-949</li><li>x-windows-950</li><li>x-windows-iso2022jp</li></ul></td><td id="description">The Character Set that should be used to encode the textual content o f the SQS message</td></tr><tr><td id="name"><strong>Visibility Timeout</strong></td><td id="default-value">15 mins</td><td id="allowable-values"></td><td id="description">The amount of time after a message is received but not deleted that the message is hidden from other consumers</td></tr><tr><td id="name"><strong>Receive Message Wait Time</strong></td><td id="default-value">0 sec</td><td id="allowable-values"></td><td id="description">The maximum amount of time to wait on a long polling receive call. Setting this to a value of 1 second or greater will reduce the number of SQS requests and decrease fetch latency at the cost of a constantly active thread.</td></tr><tr><td id="name">Proxy Host</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Proxy host name or IP<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Proxy Host Port</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Proxy host port<br/><strong>Supports Expression Language: true</strong></td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>FlowFiles are routed to success 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>hash.value</td><td>The MD5 sum of the message</td></tr><tr><td>hash.algorithm</td><td>MD5</td></tr><tr><td>sqs.message.id</td><td>The unique identifier of the SQS message</td></tr><tr><td>sqs.receipt.handle</td><td>The SQS Receipt Handle that is to be used to delete the message from the queue</td></tr></table><h3>See Also:</h3><p><a href="../org.apache.nifi.processors.aws.sqs.PutSQS/index.html">PutSQS</a>, <a href="../org.apache.nifi.processors.aws.sqs.DeleteSQS/index.html">DeleteSQS</a></p></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GetSQS</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Fetches messages from an Amazon Simple Queuing Service Queue</p><h3>Tags: </h3><p>Amazon, AWS, SQS, Queue, Get, Fetch, Poll</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, whether a property supports the <a href="../../html/expression-language-guide.html">NiFi Expression Language</a>, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th>< th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Queue URL</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The URL of the queue to act upon<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Auto Delete Messages</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specifies whether the messages should be automatically deleted by the processors once they have been received.</td></tr><tr><td id="name">Access Key</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">No Description Provided.<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Secret Key</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">No Description Provided.<br/><strong>Sensitive Property: tr ue</strong><br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Credentials File</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Path to a file containing AWS access key and secret key in properties file format.</td></tr><tr><td id="name">AWS Credentials Provider service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>AWSCredentialsProviderService<br/><strong>Implementation:</strong><br/><a href="../org.apache.nifi.processors.aws.credentials.provider.service.AWSCredentialsProviderControllerService/index.html">AWSCredentialsProviderControllerService</a></td><td id="description">The Controller Service that is used to obtain aws credentials provider</td></tr><tr><td id="name"><strong>Region</strong></td><td id="default-value">us-west-2</td><td id="allowable-values"><ul><li>us-gov-west-1 <img src="../../html/images/iconInfo.png" alt="us-gov-west-1" title="us-gov-wes t-1"></img></li><li>us-east-1 <img src="../../html/images/iconInfo.png" alt="us-east-1" title="us-east-1"></img></li><li>us-west-1 <img src="../../html/images/iconInfo.png" alt="us-west-1" title="us-west-1"></img></li><li>us-west-2 <img src="../../html/images/iconInfo.png" alt="us-west-2" title="us-west-2"></img></li><li>eu-west-1 <img src="../../html/images/iconInfo.png" alt="eu-west-1" title="eu-west-1"></img></li><li>eu-central-1 <img src="../../html/images/iconInfo.png" alt="eu-central-1" title="eu-central-1"></img></li><li>ap-southeast-1 <img src="../../html/images/iconInfo.png" alt="ap-southeast-1" title="ap-southeast-1"></img></li><li>ap-southeast-2 <img src="../../html/images/iconInfo.png" alt="ap-southeast-2" title="ap-southeast-2"></img></li><li>ap-northeast-1 <img src="../../html/images/iconInfo.png" alt="ap-northeast-1" title="ap-northeast-1"></img></li><li>ap-northeast-2 <img src="../../html/images/iconInfo.png" alt="ap-northeast-2" title="ap-northeast-2"></img></li><li >sa-east-1 <img src="../../html/images/iconInfo.png" alt="sa-east-1" >title="sa-east-1"></img></li><li>cn-north-1 <img >src="../../html/images/iconInfo.png" alt="cn-north-1" >title="cn-north-1"></img></li></ul></td><td id="description">No Description >Provided.</td></tr><tr><td id="name"><strong>Batch Size</strong></td><td >id="default-value">10</td><td id="allowable-values"></td><td >id="description">The maximum number of messages to send in a single network >request</td></tr><tr><td id="name"><strong>Communications >Timeout</strong></td><td id="default-value">30 secs</td><td >id="allowable-values"></td><td id="description">No Description >Provided.</td></tr><tr><td id="name"><strong>Character Set</strong></td><td >id="default-value">UTF-8</td><td >id="allowable-values"><ul><li>Big5</li><li>Big5-HKSCS</li><li>CESU-8</li><li>EUC-JP</li><li>EUC-KR</li><li>GB18030</li><li>GB2312</li><li>GBK</li><li>IBM-Thai</li><li>IBM00858</li><li>IBM01140</li><li>IBM01141</li><li>IBM01142</li><li>IBM01143</li>< li>IBM01144</li><li>IBM01145</li><li>IBM01146</li><li>IBM01147</li><li>IBM01148</li><li>IBM01149</li><li>IBM037</li><li>IBM1026</li><li>IBM1047</li><li>IBM273</li><li>IBM277</li><li>IBM278</li><li>IBM280</li><li>IBM284</li><li>IBM285</li><li>IBM290</li><li>IBM297</li><li>IBM420</li><li>IBM424</li><li>IBM437</li><li>IBM500</li><li>IBM775</li><li>IBM850</li><li>IBM852</li><li>IBM855</li><li>IBM857</li><li>IBM860</li><li>IBM861</li><li>IBM862</li><li>IBM863</li><li>IBM864</li><li>IBM865</li><li>IBM866</li><li>IBM868</li><li>IBM869</li><li>IBM870</li><li>IBM871</li><li>IBM918</li><li>ISO-2022-CN</li><li>ISO-2022-JP</li><li>ISO-2022-JP-2</li><li>ISO-2022-KR</li><li>ISO-8859-1</li><li>ISO-8859-13</li><li>ISO-8859-15</li><li>ISO-8859-2</li><li>ISO-8859-3</li><li>ISO-8859-4</li><li>ISO-8859-5</li><li>ISO-8859-6</li><li>ISO-8859-7</li><li>ISO-8859-8</li><li>ISO-8859-9</li><li>JIS_X0201</li><li>JIS_X0212-1990</li><li>KOI8-R</li><li>KOI8-U</li><li>Shift_JIS</li><li>TIS-620</li><li>US-ASCII</li ><li>UTF-16</li><li>UTF-16BE</li><li>UTF-16LE</li><li>UTF-32</li><li>UTF-32BE</li><li>UTF-32LE</li><li>UTF-8</li><li>windows-1250</li><li>windows-1251</li><li>windows-1252</li><li>windows-1253</li><li>windows-1254</li><li>windows-1255</li><li>windows-1256</li><li>windows-1257</li><li>windows-1258</li><li>windows-31j</li><li>x-Big5-HKSCS-2001</li><li>x-Big5-Solaris</li><li>x-COMPOUND_TEXT</li><li>x-euc-jp-linux</li><li>x-EUC-TW</li><li>x-eucJP-Open</li><li>x-IBM1006</li><li>x-IBM1025</li><li>x-IBM1046</li><li>x-IBM1097</li><li>x-IBM1098</li><li>x-IBM1112</li><li>x-IBM1122</li><li>x-IBM1123</li><li>x-IBM1124</li><li>x-IBM1166</li><li>x-IBM1364</li><li>x-IBM1381</li><li>x-IBM1383</li><li>x-IBM300</li><li>x-IBM33722</li><li>x-IBM737</li><li>x-IBM833</li><li>x-IBM834</li><li>x-IBM856</li><li>x-IBM874</li><li>x-IBM875</li><li>x-IBM921</li><li>x-IBM922</li><li>x-IBM930</li><li>x-IBM933</li><li>x-IBM935</li><li>x-IBM937</li><li>x-IBM939</li><li>x-IBM942</li><li>x-IBM942C</li><li>x-IBM943</l i><li>x-IBM943C</li><li>x-IBM948</li><li>x-IBM949</li><li>x-IBM949C</li><li>x-IBM950</li><li>x-IBM964</li><li>x-IBM970</li><li>x-ISCII91</li><li>x-ISO-2022-CN-CNS</li><li>x-ISO-2022-CN-GB</li><li>x-iso-8859-11</li><li>x-JIS0208</li><li>x-JISAutoDetect</li><li>x-Johab</li><li>x-MacArabic</li><li>x-MacCentralEurope</li><li>x-MacCroatian</li><li>x-MacCyrillic</li><li>x-MacDingbat</li><li>x-MacGreek</li><li>x-MacHebrew</li><li>x-MacIceland</li><li>x-MacRoman</li><li>x-MacRomania</li><li>x-MacSymbol</li><li>x-MacThai</li><li>x-MacTurkish</li><li>x-MacUkraine</li><li>x-MS932_0213</li><li>x-MS950-HKSCS</li><li>x-MS950-HKSCS-XP</li><li>x-mswin-936</li><li>x-PCK</li><li>x-SJIS_0213</li><li>x-UTF-16LE-BOM</li><li>X-UTF-32BE-BOM</li><li>X-UTF-32LE-BOM</li><li>x-windows-50220</li><li>x-windows-50221</li><li>x-windows-874</li><li>x-windows-949</li><li>x-windows-950</li><li>x-windows-iso2022jp</li></ul></td><td id="description">The Character Set that should be used to encode the textual content o f the SQS message</td></tr><tr><td id="name"><strong>Visibility Timeout</strong></td><td id="default-value">15 mins</td><td id="allowable-values"></td><td id="description">The amount of time after a message is received but not deleted that the message is hidden from other consumers</td></tr><tr><td id="name"><strong>Receive Message Wait Time</strong></td><td id="default-value">0 sec</td><td id="allowable-values"></td><td id="description">The maximum amount of time to wait on a long polling receive call. Setting this to a value of 1 second or greater will reduce the number of SQS requests and decrease fetch latency at the cost of a constantly active thread.</td></tr><tr><td id="name">Proxy Host</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Proxy host name or IP<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Proxy Host Port</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Proxy host port<br/><strong>Supports Expression Language: true</strong></td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>FlowFiles are routed to success 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>hash.value</td><td>The MD5 sum of the message</td></tr><tr><td>hash.algorithm</td><td>MD5</td></tr><tr><td>sqs.message.id</td><td>The unique identifier of the SQS message</td></tr><tr><td>sqs.receipt.handle</td><td>The SQS Receipt Handle that is to be used to delete the message from the queue</td></tr></table><h3>State management: </h3>This processor has no state management.<h3>Restricted: </h3><h3>See Also:</h3><p><a href="../org.apache.nifi.processors.aws.sqs.PutSQS/index.html">PutSQS</a>, <a href="../org.apache.nifi.processors.aws.sqs.DeleteSQS/index.html">DeleteSQS</a></p></ body></html> \ No newline at end of file
Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.sqs.PutSQS/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.sqs.PutSQS/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.sqs.PutSQS/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.sqs.PutSQS/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutSQS</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Publishes a message to an Amazon Simple Queuing Service Queue</p><h3>Tags: </h3><p>Amazon, AWS, SQS, Queue, Put, Publish</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, whether a property supports the <a href="../../html/expression-language-guide.html">NiFi Expression Language</a>, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th> Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Queue URL</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The URL of the queue to act upon<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Access Key</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">No Description Provided.<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Secret Key</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">No Description Provided.<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Credentials File</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Path to a file containing AWS access key and secret key in properties file format.</td></tr><tr><td id="nam e">AWS Credentials Provider service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>AWSCredentialsProviderService<br/><strong>Implementation:</strong><br/><a href="../org.apache.nifi.processors.aws.credentials.provider.service.AWSCredentialsProviderControllerService/index.html">AWSCredentialsProviderControllerService</a></td><td id="description">The Controller Service that is used to obtain aws credentials provider</td></tr><tr><td id="name"><strong>Region</strong></td><td id="default-value">us-west-2</td><td id="allowable-values"><ul><li>us-gov-west-1 <img src="../../html/images/iconInfo.png" alt="us-gov-west-1" title="us-gov-west-1"></img></li><li>us-east-1 <img src="../../html/images/iconInfo.png" alt="us-east-1" title="us-east-1"></img></li><li>us-west-1 <img src="../../html/images/iconInfo.png" alt="us-west-1" title="us-west-1"></img></li><li>us-west-2 <img src="../../html/images/iconInfo.png" alt="us-west-2" title="us-wes t-2"></img></li><li>eu-west-1 <img src="../../html/images/iconInfo.png" alt="eu-west-1" title="eu-west-1"></img></li><li>eu-central-1 <img src="../../html/images/iconInfo.png" alt="eu-central-1" title="eu-central-1"></img></li><li>ap-southeast-1 <img src="../../html/images/iconInfo.png" alt="ap-southeast-1" title="ap-southeast-1"></img></li><li>ap-southeast-2 <img src="../../html/images/iconInfo.png" alt="ap-southeast-2" title="ap-southeast-2"></img></li><li>ap-northeast-1 <img src="../../html/images/iconInfo.png" alt="ap-northeast-1" title="ap-northeast-1"></img></li><li>ap-northeast-2 <img src="../../html/images/iconInfo.png" alt="ap-northeast-2" title="ap-northeast-2"></img></li><li>sa-east-1 <img src="../../html/images/iconInfo.png" alt="sa-east-1" title="sa-east-1"></img></li><li>cn-north-1 <img src="../../html/images/iconInfo.png" alt="cn-north-1" title="cn-north-1"></img></li></ul></td><td id="description">No Description Provided.</td></tr><tr><td id="name"><strong>Delay</str ong></td><td id="default-value">0 secs</td><td id="allowable-values"></td><td id="description">The amount of time to delay the message before it becomes available to consumers</td></tr><tr><td id="name"><strong>Communications Timeout</strong></td><td id="default-value">30 secs</td><td id="allowable-values"></td><td id="description">No Description Provided.</td></tr><tr><td id="name">Proxy Host</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Proxy host name or IP<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Proxy Host Port</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Proxy host port<br/><strong>Supports Expression Language: true</strong></td></tr></table><h3>Dynamic Properties: </h3><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">Th e name of a Message Attribute to add to the message</td><td id="value">The value of the Message Attribute</td><td>Allows the user to add key/value pairs as Message Attributes by adding a property whose name will become the name of the Message Attribute and value will become the value of the Message Attribute<br/><strong>Supports Expression Language: true</strong></td></tr></table></p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>FlowFiles are routed to success relationship</td></tr><tr><td>failure</td><td>FlowFiles are routed to failure relationship</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>See Also:</h3><p><a href="../org.apache.nifi.processors.aws.sqs.GetSQS/index.html">GetSQS</a>, <a href="../org.apache.nifi.processors.aws.sqs.DeleteSQS/index.html">DeleteSQS</a></p></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutSQS</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Publishes a message to an Amazon Simple Queuing Service Queue</p><h3>Tags: </h3><p>Amazon, AWS, SQS, Queue, Put, Publish</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, whether a property supports the <a href="../../html/expression-language-guide.html">NiFi Expression Language</a>, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th> Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Queue URL</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The URL of the queue to act upon<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Access Key</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">No Description Provided.<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Secret Key</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">No Description Provided.<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Credentials File</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Path to a file containing AWS access key and secret key in properties file format.</td></tr><tr><td id="nam e">AWS Credentials Provider service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>AWSCredentialsProviderService<br/><strong>Implementation:</strong><br/><a href="../org.apache.nifi.processors.aws.credentials.provider.service.AWSCredentialsProviderControllerService/index.html">AWSCredentialsProviderControllerService</a></td><td id="description">The Controller Service that is used to obtain aws credentials provider</td></tr><tr><td id="name"><strong>Region</strong></td><td id="default-value">us-west-2</td><td id="allowable-values"><ul><li>us-gov-west-1 <img src="../../html/images/iconInfo.png" alt="us-gov-west-1" title="us-gov-west-1"></img></li><li>us-east-1 <img src="../../html/images/iconInfo.png" alt="us-east-1" title="us-east-1"></img></li><li>us-west-1 <img src="../../html/images/iconInfo.png" alt="us-west-1" title="us-west-1"></img></li><li>us-west-2 <img src="../../html/images/iconInfo.png" alt="us-west-2" title="us-wes t-2"></img></li><li>eu-west-1 <img src="../../html/images/iconInfo.png" alt="eu-west-1" title="eu-west-1"></img></li><li>eu-central-1 <img src="../../html/images/iconInfo.png" alt="eu-central-1" title="eu-central-1"></img></li><li>ap-southeast-1 <img src="../../html/images/iconInfo.png" alt="ap-southeast-1" title="ap-southeast-1"></img></li><li>ap-southeast-2 <img src="../../html/images/iconInfo.png" alt="ap-southeast-2" title="ap-southeast-2"></img></li><li>ap-northeast-1 <img src="../../html/images/iconInfo.png" alt="ap-northeast-1" title="ap-northeast-1"></img></li><li>ap-northeast-2 <img src="../../html/images/iconInfo.png" alt="ap-northeast-2" title="ap-northeast-2"></img></li><li>sa-east-1 <img src="../../html/images/iconInfo.png" alt="sa-east-1" title="sa-east-1"></img></li><li>cn-north-1 <img src="../../html/images/iconInfo.png" alt="cn-north-1" title="cn-north-1"></img></li></ul></td><td id="description">No Description Provided.</td></tr><tr><td id="name"><strong>Delay</str ong></td><td id="default-value">0 secs</td><td id="allowable-values"></td><td id="description">The amount of time to delay the message before it becomes available to consumers</td></tr><tr><td id="name"><strong>Communications Timeout</strong></td><td id="default-value">30 secs</td><td id="allowable-values"></td><td id="description">No Description Provided.</td></tr><tr><td id="name">Proxy Host</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Proxy host name or IP<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Proxy Host Port</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Proxy host port<br/><strong>Supports Expression Language: true</strong></td></tr></table><h3>Dynamic Properties: </h3><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">Th e name of a Message Attribute to add to the message</td><td id="value">The value of the Message Attribute</td><td>Allows the user to add key/value pairs as Message Attributes by adding a property whose name will become the name of the Message Attribute and value will become the value of the Message Attribute<br/><strong>Supports Expression Language: true</strong></td></tr></table></p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>FlowFiles are routed to success relationship</td></tr><tr><td>failure</td><td>FlowFiles are routed to failure relationship</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This processor has no state management.<h3>Restricted: </h3><h3>See Also:</h3><p><a href="../org.apache.nifi.processors.aws.sqs.GetSQS/index.html">GetSQS</a>, <a href="../org.apache.nifi.processors.aws.sqs.DeleteSQS/index.html">DeleteSQS</a>< /p></body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.azure.eventhub.GetAzureEventHub/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.azure.eventhub.GetAzureEventHub/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.azure.eventhub.GetAzureEventHub/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.azure.eventhub.GetAzureEventHub/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GetAzureEventHub</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Receives messages from a Microsoft Azure Event Hub, writing the contents of the Azure message to the content of the FlowFile</p><h3>Tags: </h3><p>azure, microsoft, cloud, eventhub, events, streaming, streams</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 is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values< /th><th>Description</th></tr><tr><td id="name"><strong>Event Hub Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the Azure Event Hub to pull messages from</td></tr><tr><td id="name"><strong>Event Hub Namespace</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Azure Namespace that the Event Hub is assigned to. This is generally equal to <Event Hub Name>-ns</td></tr><tr><td id="name"><strong>Shared Access Policy Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the Event Hub Shared Access Policy. This Policy must have Listen permissions.</td></tr><tr><td id="name"><strong>Shared Access Policy Primary Key</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The primary key of the Event Hub Shared Access Policy<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id ="name"><strong>Number of Event Hub Partitions</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The number of partitions that the Event Hub has. Only this number of partitions will be used, so it is important to ensure that if the number of partitions changes that this value be updated. Otherwise, some messages may not be consumed.</td></tr><tr><td id="name"><strong>Event Hub Consumer Group</strong></td><td id="default-value">$Default</td><td id="allowable-values"></td><td id="description">The name of the Event Hub Consumer Group to use when pulling events</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Any FlowFile that is successfully received from the Azure Event Hub will be 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>Descripti on</th></tr><tr><td>eventhub.enqueued.timestamp</td><td>The time (in milliseconds since epoch, UTC) at which the message was enqueued in the Azure Event Hub</td></tr><tr><td>eventhub.offset</td><td>The offset into the partition at which the message was stored</td></tr><tr><td>eventhub.sequence</td><td>The Azure Sequence number associated with the message</td></tr><tr><td>eventhub.name</td><td>The name of the Event Hub from which the message was pulled</td></tr><tr><td>eventhub.partition</td><td>The name of the Azure Partition from which the message was pulled</td></tr></table></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GetAzureEventHub</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Receives messages from a Microsoft Azure Event Hub, writing the contents of the Azure message to the content of the FlowFile</p><h3>Tags: </h3><p>azure, microsoft, cloud, eventhub, events, streaming, streams</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 is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values< /th><th>Description</th></tr><tr><td id="name"><strong>Event Hub Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the Azure Event Hub to pull messages from</td></tr><tr><td id="name"><strong>Event Hub Namespace</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Azure Namespace that the Event Hub is assigned to. This is generally equal to <Event Hub Name>-ns</td></tr><tr><td id="name"><strong>Shared Access Policy Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the Event Hub Shared Access Policy. This Policy must have Listen permissions.</td></tr><tr><td id="name"><strong>Shared Access Policy Primary Key</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The primary key of the Event Hub Shared Access Policy<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id ="name"><strong>Number of Event Hub Partitions</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The number of partitions that the Event Hub has. Only this number of partitions will be used, so it is important to ensure that if the number of partitions changes that this value be updated. Otherwise, some messages may not be consumed.</td></tr><tr><td id="name"><strong>Event Hub Consumer Group</strong></td><td id="default-value">$Default</td><td id="allowable-values"></td><td id="description">The name of the Event Hub Consumer Group to use when pulling events</td></tr><tr><td id="name">Event Hub Message Enqueue Time</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A timestamp (ISO-8061 Instant) formatted as YYYY-MM-DDThhmmss.sssZ (2016-01-01T01:01:01.000Z) from which messages should have been enqueued in the EventHub to start reading from</td></tr><tr><td id="name">Partition Recivier Fetch Size</td><td id="d efault-value"></td><td id="allowable-values"></td><td id="description">The number of events that a receiver should fetch from an EventHubs partition before returning. Default(100)</td></tr><tr><td id="name">Partiton Receiver Timeout (millseconds)</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The amount of time a Partition Receiver should wait to receive the Fetch Size before returning. Default(60000)</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Any FlowFile that is successfully received from the Azure Event Hub will be 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>eventhub.enqueued.timestamp</td><td>The time (in milliseconds since epoch, UTC) at which the message was enqueued in the Azure Event Hub</td></tr ><tr><td>eventhub.offset</td><td>The offset into the partition at which the >message was stored</td></tr><tr><td>eventhub.sequence</td><td>The Azure >Sequence number associated with the >message</td></tr><tr><td>eventhub.name</td><td>The name of the Event Hub from >which the message was pulled</td></tr><tr><td>eventhub.partition</td><td>The >name of the Azure Partition from which the message was >pulled</td></tr></table><h3>State management: </h3>This processor has no >state management.<h3>Restricted: </h3></body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.azure.eventhub.PutAzureEventHub/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.azure.eventhub.PutAzureEventHub/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.azure.eventhub.PutAzureEventHub/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.azure.eventhub.PutAzureEventHub/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutAzureEventHub</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Sends the contents of a FlowFile to a Windows Azure Event Hub. Note: the content of the FlowFile will be buffered into memory before being sent, so care should be taken to avoid sending FlowFiles to this Processor that exceed the amount of Java Heap Space available.</p><h3>Tags: </h3><p>microsoft, azure, cloud, eventhub, events, streams, streaming</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 is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Event Hub Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the Azure Event Hub to send to</td></tr><tr><td id="name"><strong>Event Hub Namespace</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Azure Namespace that the Event Hub is assigned to. This is generally equal to <Event Hub Name>-ns</td></tr><tr><td id="name"><strong>Shared Access Policy Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the Event Hub Shared Access Policy. This Policy must have Send permissions.</td></tr><tr><td id="name"><strong>Shared Access Policy Primary Key</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="des cription">The primary key of the Event Hub Shared Access Policy<br/><strong>Sensitive Property: true</strong></td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Any FlowFile that is successfully sent to the Azure Event Hub will be transferred to this Relationship.</td></tr><tr><td>failure</td><td>Any FlowFile that could not be sent to the Azure Event Hub will be transferred to this Relationship.</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.</body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutAzureEventHub</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Sends the contents of a FlowFile to a Windows Azure Event Hub. Note: the content of the FlowFile will be buffered into memory before being sent, so care should be taken to avoid sending FlowFiles to this Processor that exceed the amount of Java Heap Space available.</p><h3>Tags: </h3><p>microsoft, azure, cloud, eventhub, events, streams, streaming</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 is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Event Hub Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the Azure Event Hub to send to</td></tr><tr><td id="name"><strong>Event Hub Namespace</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Azure Namespace that the Event Hub is assigned to. This is generally equal to <Event Hub Name>-ns</td></tr><tr><td id="name"><strong>Shared Access Policy Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the Event Hub Shared Access Policy. This Policy must have Send permissions.</td></tr><tr><td id="name"><strong>Shared Access Policy Primary Key</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="des cription">The primary key of the Event Hub Shared Access Policy<br/><strong>Sensitive Property: true</strong></td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Any FlowFile that is successfully sent to the Azure Event Hub will be transferred to this Relationship.</td></tr><tr><td>failure</td><td>Any FlowFile that could not be sent to the Azure Event Hub will be transferred to this Relationship.</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This processor has no state management.<h3>Restricted: </h3></body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.cassandra.PutCassandraQL/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.cassandra.PutCassandraQL/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.cassandra.PutCassandraQL/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.cassandra.PutCassandraQL/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutCassandraQL</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Execute provided Cassandra Query Language (CQL) statement on a Cassandra 1.x, 2.x, or 3.0.x cluster. The content of an incoming FlowFile is expected to be the CQL command to execute. The CQL command may use the ? to escape parameters. In this case, the parameters to use must exist as FlowFile attributes with the naming convention cql.args.N.type and cql.args.N.value, where N is a positive integer. The cql.args.N.type is expected to be a lowercase string indicating the Cassandra type.</p><h3>Tags: </h3><p>cassandra, cql, put, insert, update, set</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 is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Cassandra Contact Points</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Contact points are addresses of Cassandra nodes. The list of contact points should be comma-separated and in hostname:port format. Example node1:port,node2:port,.... The default client port for Cassandra is 9042, but the port(s) must be explicitly specified.</td></tr><tr><td id="name">Keyspace</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Cassandra Keyspace to connect to. If no keyspace is specified, the query will need to include the ke yspace name before any table reference.</td></tr><tr><td id="name">SSL Context Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Implementation:</strong><br/><a href="../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/SSL connections.</td></tr><tr><td id="name">Client Auth</td><td id="default-value">REQUIRED</td><td id="allowable-values"><ul><li>WANT</li><li>REQUIRED</li><li>NONE</li></ul></td><td id="description">Client authentication policy when connecting to secure (TLS/SSL) cluster. Possible values are REQUIRED, WANT, NONE. This property is only used when an SSL Context has been defined and enabled.</td></tr><tr><td id="name">Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Username to access the Cassand ra cluster</td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password to access the Cassandra cluster<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>Consistency Level</strong></td><td id="default-value">ONE</td><td id="allowable-values"><ul><li>ANY</li><li>ONE</li><li>TWO</li><li>THREE</li><li>QUORUM</li><li>ALL</li><li>LOCAL_QUORUM</li><li>EACH_QUORUM</li><li>SERIAL</li><li>LOCAL_SERIAL</li><li>LOCAL_ONE</li></ul></td><td id="description">The strategy for how many replicas must respond before results are returned.</td></tr><tr><td id="name"><strong>Character Set</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">Specifies the character set of the record data.</td></tr><tr><td id="name"><strong>Max Wait Time</strong></td><td id="default-value">0 seconds</td><td id="allowable-values"></td><td id="description">The maximum amount of time allowed for a running CQL select query. Must be of format <duration> <TimeUnit> where <duration> is a non-negative integer and TimeUnit is a supported Time Unit, such as: nanos, millis, secs, mins, hrs, days. A value of zero means there is no limit. </td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>retry</td><td>A FlowFile is transferred to this relationship if the statement cannot be executed successfully but attempting the operation again may succeed.</td></tr><tr><td>success</td><td>Successfully executed CQL statement.</td></tr><tr><td>failure</td><td>CQL statement execution failed.</td></tr></table><h3>Reads Attributes: </h3><table id="reads-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>cql.args.N.type</td><td>Incoming FlowFiles are expected to be parameterized CQL statements. The type of each parameter is specified as a lowercase string corresponding to the Cassandra data type (text, int, boolean, e.g.). In the case of collections, the primitive type(s) of the elements in the collection should be comma-delimited, follow the collection type, and be enclosed in angle brackets (< and >), for example set<text> or map<timestamp, int>.</td></tr><tr><td>cql.args.N.value</td><td>Incoming FlowFiles are expected to be parameterized CQL statements. The value of the parameters are specified as cql.args.1.value, cql.args.2.value, cql.args.3.value, and so on. The type of the cql.args.1.value parameter is specified by the cql.args.1.type attribute.</td></tr></table><h3>Writes Attributes: </h3>None specified.</body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutCassandraQL</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Execute provided Cassandra Query Language (CQL) statement on a Cassandra 1.x, 2.x, or 3.0.x cluster. The content of an incoming FlowFile is expected to be the CQL command to execute. The CQL command may use the ? to escape parameters. In this case, the parameters to use must exist as FlowFile attributes with the naming convention cql.args.N.type and cql.args.N.value, where N is a positive integer. The cql.args.N.type is expected to be a lowercase string indicating the Cassandra type.</p><h3>Tags: </h3><p>cassandra, cql, put, insert, update, set</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 is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Cassandra Contact Points</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Contact points are addresses of Cassandra nodes. The list of contact points should be comma-separated and in hostname:port format. Example node1:port,node2:port,.... The default client port for Cassandra is 9042, but the port(s) must be explicitly specified.</td></tr><tr><td id="name">Keyspace</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Cassandra Keyspace to connect to. If no keyspace is specified, the query will need to include the ke yspace name before any table reference.</td></tr><tr><td id="name">SSL Context Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Implementation:</strong><br/><a href="../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/SSL connections.</td></tr><tr><td id="name">Client Auth</td><td id="default-value">REQUIRED</td><td id="allowable-values"><ul><li>WANT</li><li>REQUIRED</li><li>NONE</li></ul></td><td id="description">Client authentication policy when connecting to secure (TLS/SSL) cluster. Possible values are REQUIRED, WANT, NONE. This property is only used when an SSL Context has been defined and enabled.</td></tr><tr><td id="name">Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Username to access the Cassand ra cluster</td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password to access the Cassandra cluster<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>Consistency Level</strong></td><td id="default-value">ONE</td><td id="allowable-values"><ul><li>ANY</li><li>ONE</li><li>TWO</li><li>THREE</li><li>QUORUM</li><li>ALL</li><li>LOCAL_QUORUM</li><li>EACH_QUORUM</li><li>SERIAL</li><li>LOCAL_SERIAL</li><li>LOCAL_ONE</li></ul></td><td id="description">The strategy for how many replicas must respond before results are returned.</td></tr><tr><td id="name"><strong>Character Set</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">Specifies the character set of the record data.</td></tr><tr><td id="name"><strong>Max Wait Time</strong></td><td id="default-value">0 seconds</td><td id="allowable-values"></td><td id="description">The maximum amount of time allowed for a running CQL select query. Must be of format <duration> <TimeUnit> where <duration> is a non-negative integer and TimeUnit is a supported Time Unit, such as: nanos, millis, secs, mins, hrs, days. A value of zero means there is no limit. </td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>retry</td><td>A FlowFile is transferred to this relationship if the statement cannot be executed successfully but attempting the operation again may succeed.</td></tr><tr><td>success</td><td>Successfully executed CQL statement.</td></tr><tr><td>failure</td><td>CQL statement execution failed.</td></tr></table><h3>Reads Attributes: </h3><table id="reads-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>cql.args.N.type</td><td>Incoming FlowFiles are expected to be parameterized CQL statements. The type of each parameter is specified as a lowercase string corresponding to the Cassandra data type (text, int, boolean, e.g.). In the case of collections, the primitive type(s) of the elements in the collection should be comma-delimited, follow the collection type, and be enclosed in angle brackets (< and >), for example set<text> or map<timestamp, int>.</td></tr><tr><td>cql.args.N.value</td><td>Incoming FlowFiles are expected to be parameterized CQL statements. The value of the parameters are specified as cql.args.1.value, cql.args.2.value, cql.args.3.value, and so on. The type of the cql.args.1.value parameter is specified by the cql.args.1.type attribute.</td></tr></table><h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This processor has no state management.<h3>Restricted: </h3></body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.cassandra.QueryCassandra/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.cassandra.QueryCassandra/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.cassandra.QueryCassandra/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.cassandra.QueryCassandra/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>QueryCassandra</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Execute provided Cassandra Query Language (CQL) select query on a Cassandra 1.x, 2.x, or 3.0.x cluster. Query result may be converted to Avro or JSON format. Streaming is used so arbitrarily large result sets are supported. This processor can be scheduled to run on a timer, or cron expression, using the standard scheduling methods, or it can be triggered by an incoming FlowFile. If it is triggered by an incoming FlowFile, then attributes of that FlowFile will be available when evaluating the select query. FlowFile attribute 'executecql.row.count' indicates how many rows were selected.</p><h3>Tags: </h3><p>cassandra, cql, select</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, whether a property supports the <a href="../../html/expression-language-guide.html">NiFi Expression Language</a>, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Cassandra Contact Points</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Contact points are addresses of Cassandra nodes. The list of contact points should be comma-separated and in hostname:port format. Example node1:port,node2:port,.... The default client port for Cassandra is 9042, but the port(s) must be explicitly specified.</td></tr><tr><td id="name ">Keyspace</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Cassandra Keyspace to connect to. If no keyspace is specified, the query will need to include the keyspace name before any table reference.</td></tr><tr><td id="name">SSL Context Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Implementation:</strong><br/><a href="../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/SSL connections.</td></tr><tr><td id="name">Client Auth</td><td id="default-value">REQUIRED</td><td id="allowable-values"><ul><li>WANT</li><li>REQUIRED</li><li>NONE</li></ul></td><td id="description">Client authentication policy when connecting to secure (TLS/SSL) cluster. Possible values are REQUIRED, WANT, NONE. This property is only used w hen an SSL Context has been defined and enabled.</td></tr><tr><td id="name">Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Username to access the Cassandra cluster</td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password to access the Cassandra cluster<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>Consistency Level</strong></td><td id="default-value">ONE</td><td id="allowable-values"><ul><li>ANY</li><li>ONE</li><li>TWO</li><li>THREE</li><li>QUORUM</li><li>ALL</li><li>LOCAL_QUORUM</li><li>EACH_QUORUM</li><li>SERIAL</li><li>LOCAL_SERIAL</li><li>LOCAL_ONE</li></ul></td><td id="description">The strategy for how many replicas must respond before results are returned.</td></tr><tr><td id="name"><strong>Character Set</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">Specifies the character se t of the record data.</td></tr><tr><td id="name"><strong>CQL select query</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">CQL select query<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Max Wait Time</strong></td><td id="default-value">0 seconds</td><td id="allowable-values"></td><td id="description">The maximum amount of time allowed for a running CQL select query. Must be of format <duration> <TimeUnit> where <duration> is a non-negative integer and TimeUnit is a supported Time Unit, such as: nanos, millis, secs, mins, hrs, days. A value of zero means there is no limit. </td></tr><tr><td id="name"><strong>Fetch size</strong></td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">The number of result rows to be fetched from the result set at a time. Zero is the default and means there is no limit.</td></tr><tr><td id="name"><strong>Output Format</ strong></td><td id="default-value">Avro</td><td id="allowable-values"><ul><li>Avro</li><li>JSON</li></ul></td><td id="description">The format to which the result rows will be converted. If JSON is selected, the output will contain an object with field 'results' containing an array of result rows. Each row in the array is a map of the named column to its value. For example: { "results": [{"userid":1, "name":"Joe Smith"}]}</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>retry</td><td>A FlowFile is transferred to this relationship if the query cannot be completed but attempting the operation again may succeed.</td></tr><tr><td>success</td><td>Successfully created FlowFile from CQL query result set.</td></tr><tr><td>failure</td><td>CQL query execution failed.</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>executecql.row.count</td><td>The number of rows returned by the CQL >query</td></tr></table></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>QueryCassandra</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Execute provided Cassandra Query Language (CQL) select query on a Cassandra 1.x, 2.x, or 3.0.x cluster. Query result may be converted to Avro or JSON format. Streaming is used so arbitrarily large result sets are supported. This processor can be scheduled to run on a timer, or cron expression, using the standard scheduling methods, or it can be triggered by an incoming FlowFile. If it is triggered by an incoming FlowFile, then attributes of that FlowFile will be available when evaluating the select query. FlowFile attribute 'executecql.row.count' indicates how many rows were selected.</p><h3>Tags: </h3><p>cassandra, cql, select</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, whether a property supports the <a href="../../html/expression-language-guide.html">NiFi Expression Language</a>, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Cassandra Contact Points</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Contact points are addresses of Cassandra nodes. The list of contact points should be comma-separated and in hostname:port format. Example node1:port,node2:port,.... The default client port for Cassandra is 9042, but the port(s) must be explicitly specified.</td></tr><tr><td id="name ">Keyspace</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Cassandra Keyspace to connect to. If no keyspace is specified, the query will need to include the keyspace name before any table reference.</td></tr><tr><td id="name">SSL Context Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Implementation:</strong><br/><a href="../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/SSL connections.</td></tr><tr><td id="name">Client Auth</td><td id="default-value">REQUIRED</td><td id="allowable-values"><ul><li>WANT</li><li>REQUIRED</li><li>NONE</li></ul></td><td id="description">Client authentication policy when connecting to secure (TLS/SSL) cluster. Possible values are REQUIRED, WANT, NONE. This property is only used w hen an SSL Context has been defined and enabled.</td></tr><tr><td id="name">Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Username to access the Cassandra cluster</td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password to access the Cassandra cluster<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>Consistency Level</strong></td><td id="default-value">ONE</td><td id="allowable-values"><ul><li>ANY</li><li>ONE</li><li>TWO</li><li>THREE</li><li>QUORUM</li><li>ALL</li><li>LOCAL_QUORUM</li><li>EACH_QUORUM</li><li>SERIAL</li><li>LOCAL_SERIAL</li><li>LOCAL_ONE</li></ul></td><td id="description">The strategy for how many replicas must respond before results are returned.</td></tr><tr><td id="name"><strong>Character Set</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">Specifies the character se t of the record data.</td></tr><tr><td id="name"><strong>CQL select query</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">CQL select query<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Max Wait Time</strong></td><td id="default-value">0 seconds</td><td id="allowable-values"></td><td id="description">The maximum amount of time allowed for a running CQL select query. Must be of format <duration> <TimeUnit> where <duration> is a non-negative integer and TimeUnit is a supported Time Unit, such as: nanos, millis, secs, mins, hrs, days. A value of zero means there is no limit. </td></tr><tr><td id="name"><strong>Fetch size</strong></td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">The number of result rows to be fetched from the result set at a time. Zero is the default and means there is no limit.</td></tr><tr><td id="name"><strong>Output Format</ strong></td><td id="default-value">Avro</td><td id="allowable-values"><ul><li>Avro</li><li>JSON</li></ul></td><td id="description">The format to which the result rows will be converted. If JSON is selected, the output will contain an object with field 'results' containing an array of result rows. Each row in the array is a map of the named column to its value. For example: { "results": [{"userid":1, "name":"Joe Smith"}]}</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>retry</td><td>A FlowFile is transferred to this relationship if the query cannot be completed but attempting the operation again may succeed.</td></tr><tr><td>success</td><td>Successfully created FlowFile from CQL query result set.</td></tr><tr><td>failure</td><td>CQL query execution failed.</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>executecql.row.count</td><td>The number of rows returned by the CQL >query</td></tr></table><h3>State management: </h3>This processor has no state >management.<h3>Restricted: </h3></body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.couchbase.GetCouchbaseKey/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.couchbase.GetCouchbaseKey/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.couchbase.GetCouchbaseKey/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.couchbase.GetCouchbaseKey/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GetCouchbaseKey</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Get a document from Couchbase Server via Key/Value access. The ID of the document to fetch may be supplied by setting the <Document Id> property. NOTE: if the Document Id property is not set, the contents of the FlowFile will be read to determine the Document Id, which means that the contents of the entire FlowFile will be buffered in memory.</p><h3>Tags: </h3><p>nosql, couchbase, database, get</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>Name</t h><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Couchbase Cluster Controller Service</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>CouchbaseClusterControllerService<br/><strong>Implementation:</strong><br/><a href="../org.apache.nifi.couchbase.CouchbaseClusterService/index.html">CouchbaseClusterService</a></td><td id="description">A Couchbase Cluster Controller Service which manages connections to a Couchbase cluster.</td></tr><tr><td id="name"><strong>Bucket Name</strong></td><td id="default-value">default</td><td id="allowable-values"></td><td id="description">The name of bucket to access.</td></tr><tr><td id="name"><strong>Document Type</strong></td><td id="default-value">Json</td><td id="allowable-values"><ul><li>Json</li><li>Binary</li></ul></td><td id="description">The type of contents.</td></tr><tr><td id="name">Document Id</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A static, fixed Couchbase document id, or an expression to construct the Couchbase document id.<br/><strong>Supports Expression Language: true</strong></td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>retry</td><td>All FlowFiles that cannot written to Couchbase Server but can be retried are routed to this relationship.</td></tr><tr><td>success</td><td>All FlowFiles that are written to Couchbase Server are routed to this relationship.</td></tr><tr><td>failure</td><td>All FlowFiles that cannot written to Couchbase Server and can't be retried are routed to this relationship.</td></tr><tr><td>original</td><td>The original input file will be routed to this destination when it has been successfully processed.</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> couchbase.cluster</td><td>Cluster where the document was retrieved from.</td></tr><tr><td>couchbase.bucket</td><td>Bucket where the document was retrieved from.</td></tr><tr><td>couchbase.doc.id</td><td>Id of the document.</td></tr><tr><td>couchbase.doc.cas</td><td>CAS of the document.</td></tr><tr><td>couchbase.doc.expiry</td><td>Expiration of the document.</td></tr><tr><td>couchbase.exception</td><td>If Couchbase related error occurs the CouchbaseException class name will be captured here.</td></tr></table><h3>See Also:</h3><p><a href="http://localhost:8080/nifi-docs/components/org.apache.nifi.couchbase.CouchbaseClusterControllerService/index.html";>CouchbaseClusterControllerService</a></p></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GetCouchbaseKey</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Get a document from Couchbase Server via Key/Value access. The ID of the document to fetch may be supplied by setting the <Document Id> property. NOTE: if the Document Id property is not set, the contents of the FlowFile will be read to determine the Document Id, which means that the contents of the entire FlowFile will be buffered in memory.</p><h3>Tags: </h3><p>nosql, couchbase, database, get</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>Name</t h><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Couchbase Cluster Controller Service</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>CouchbaseClusterControllerService<br/><strong>Implementation:</strong><br/><a href="../org.apache.nifi.couchbase.CouchbaseClusterService/index.html">CouchbaseClusterService</a></td><td id="description">A Couchbase Cluster Controller Service which manages connections to a Couchbase cluster.</td></tr><tr><td id="name"><strong>Bucket Name</strong></td><td id="default-value">default</td><td id="allowable-values"></td><td id="description">The name of bucket to access.</td></tr><tr><td id="name"><strong>Document Type</strong></td><td id="default-value">Json</td><td id="allowable-values"><ul><li>Json</li><li>Binary</li></ul></td><td id="description">The type of contents.</td></tr><tr><td id="name">Document Id</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A static, fixed Couchbase document id, or an expression to construct the Couchbase document id.<br/><strong>Supports Expression Language: true</strong></td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>retry</td><td>All FlowFiles that cannot written to Couchbase Server but can be retried are routed to this relationship.</td></tr><tr><td>success</td><td>All FlowFiles that are written to Couchbase Server are routed to this relationship.</td></tr><tr><td>failure</td><td>All FlowFiles that cannot written to Couchbase Server and can't be retried are routed to this relationship.</td></tr><tr><td>original</td><td>The original input file will be routed to this destination when it has been successfully processed.</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> couchbase.cluster</td><td>Cluster where the document was retrieved from.</td></tr><tr><td>couchbase.bucket</td><td>Bucket where the document was retrieved from.</td></tr><tr><td>couchbase.doc.id</td><td>Id of the document.</td></tr><tr><td>couchbase.doc.cas</td><td>CAS of the document.</td></tr><tr><td>couchbase.doc.expiry</td><td>Expiration of the document.</td></tr><tr><td>couchbase.exception</td><td>If Couchbase related error occurs the CouchbaseException class name will be captured here.</td></tr></table><h3>State management: </h3>This processor has no state management.<h3>Restricted: </h3><h3>See Also:</h3><p><a href="../org.apache.nifi.couchbase.CouchbaseClusterControllerService/index.html">CouchbaseClusterControllerService</a></p></body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.couchbase.PutCouchbaseKey/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.couchbase.PutCouchbaseKey/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.couchbase.PutCouchbaseKey/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.couchbase.PutCouchbaseKey/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutCouchbaseKey</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Put a document to Couchbase Server via Key/Value access.</p><h3>Tags: </h3><p>nosql, couchbase, database, put</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>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Couchbase Cluster Controller Service</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>CouchbaseClusterControllerService<br/><stron g>Implementation:</strong><br/><a href="../org.apache.nifi.couchbase.CouchbaseClusterService/index.html">CouchbaseClusterService</a></td><td id="description">A Couchbase Cluster Controller Service which manages connections to a Couchbase cluster.</td></tr><tr><td id="name"><strong>Bucket Name</strong></td><td id="default-value">default</td><td id="allowable-values"></td><td id="description">The name of bucket to access.</td></tr><tr><td id="name"><strong>Document Type</strong></td><td id="default-value">Json</td><td id="allowable-values"><ul><li>Json</li><li>Binary</li></ul></td><td id="description">The type of contents.</td></tr><tr><td id="name">Document Id</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A static, fixed Couchbase document id, or an expression to construct the Couchbase document id.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Persist To</strong></td><td id="default-value">NONE</td><t d id="allowable-values"><ul><li>MASTER</li><li>NONE</li><li>ONE</li><li>TWO</li><li>THREE</li><li>FOUR</li></ul></td><td id="description">Durability constraint about disk persistence.</td></tr><tr><td id="name"><strong>Replicate To</strong></td><td id="default-value">NONE</td><td id="allowable-values"><ul><li>NONE</li><li>ONE</li><li>TWO</li><li>THREE</li></ul></td><td id="description">Durability constraint about replication.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>retry</td><td>All FlowFiles that cannot written to Couchbase Server but can be retried are routed to this relationship.</td></tr><tr><td>success</td><td>All FlowFiles that are written to Couchbase Server are routed to this relationship.</td></tr><tr><td>failure</td><td>All FlowFiles that cannot written to Couchbase Server and can't be retried are routed to this relationship.</td></tr></table><h3>Reads Attributes: </h3><table id="reads-attributes" ><tr><th>Name</th><th>Description</th></tr><tr><td>uuid</td><td>Used as a >document id if 'Document Id' is not specified</td></tr></table><h3>Writes >Attributes: </h3><table >id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>couchbase.cluster</td><td>Cluster > where the document was >stored.</td></tr><tr><td>couchbase.bucket</td><td>Bucket where the document >was stored.</td></tr><tr><td>couchbase.doc.id</td><td>Id of the >document.</td></tr><tr><td>couchbase.doc.cas</td><td>CAS of the >document.</td></tr><tr><td>couchbase.doc.expiry</td><td>Expiration of the >document.</td></tr><tr><td>couchbase.exception</td><td>If Couchbase related >error occurs the CouchbaseException class name will be captured >here.</td></tr></table><h3>See Also:</h3><p><a >href="http://localhost:8080/nifi-docs/components/org.apache.nifi.couchbase.CouchbaseClusterControllerService/index.html";>CouchbaseClusterControllerService</a></p></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutCouchbaseKey</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Put a document to Couchbase Server via Key/Value access.</p><h3>Tags: </h3><p>nosql, couchbase, database, put</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>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Couchbase Cluster Controller Service</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>CouchbaseClusterControllerService<br/><stron g>Implementation:</strong><br/><a href="../org.apache.nifi.couchbase.CouchbaseClusterService/index.html">CouchbaseClusterService</a></td><td id="description">A Couchbase Cluster Controller Service which manages connections to a Couchbase cluster.</td></tr><tr><td id="name"><strong>Bucket Name</strong></td><td id="default-value">default</td><td id="allowable-values"></td><td id="description">The name of bucket to access.</td></tr><tr><td id="name"><strong>Document Type</strong></td><td id="default-value">Json</td><td id="allowable-values"><ul><li>Json</li><li>Binary</li></ul></td><td id="description">The type of contents.</td></tr><tr><td id="name">Document Id</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A static, fixed Couchbase document id, or an expression to construct the Couchbase document id.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Persist To</strong></td><td id="default-value">NONE</td><t d id="allowable-values"><ul><li>MASTER</li><li>NONE</li><li>ONE</li><li>TWO</li><li>THREE</li><li>FOUR</li></ul></td><td id="description">Durability constraint about disk persistence.</td></tr><tr><td id="name"><strong>Replicate To</strong></td><td id="default-value">NONE</td><td id="allowable-values"><ul><li>NONE</li><li>ONE</li><li>TWO</li><li>THREE</li></ul></td><td id="description">Durability constraint about replication.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>retry</td><td>All FlowFiles that cannot written to Couchbase Server but can be retried are routed to this relationship.</td></tr><tr><td>success</td><td>All FlowFiles that are written to Couchbase Server are routed to this relationship.</td></tr><tr><td>failure</td><td>All FlowFiles that cannot written to Couchbase Server and can't be retried are routed to this relationship.</td></tr></table><h3>Reads Attributes: </h3><table id="reads-attributes" ><tr><th>Name</th><th>Description</th></tr><tr><td>uuid</td><td>Used as a >document id if 'Document Id' is not specified</td></tr></table><h3>Writes >Attributes: </h3><table >id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>couchbase.cluster</td><td>Cluster > where the document was >stored.</td></tr><tr><td>couchbase.bucket</td><td>Bucket where the document >was stored.</td></tr><tr><td>couchbase.doc.id</td><td>Id of the >document.</td></tr><tr><td>couchbase.doc.cas</td><td>CAS of the >document.</td></tr><tr><td>couchbase.doc.expiry</td><td>Expiration of the >document.</td></tr><tr><td>couchbase.exception</td><td>If Couchbase related >error occurs the CouchbaseException class name will be captured >here.</td></tr></table><h3>State management: </h3>This processor has no state >management.<h3>Restricted: </h3><h3>See Also:</h3><p><a >href="../org.apache.nifi.couchbase.CouchbaseClusterControllerService/index.html">CouchbaseClusterControllerService</a></p></body></html> \ No newline at end of file
