Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-aws-nar/1.7.0/org.apache.nifi.processors.aws.sns.PutSNS/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-aws-nar/1.7.0/org.apache.nifi.processors.aws.sns.PutSNS/index.html?rev=1834461&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-aws-nar/1.7.0/org.apache.nifi.processors.aws.sns.PutSNS/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-aws-nar/1.7.0/org.apache.nifi.processors.aws.sns.PutSNS/index.html Wed Jun 27 00:37:46 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutSNS</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;">PutSNS</h1><h2>Description: </h2><p>Sends the content of a FlowFile as a notification to the Amazon Simple Notification Service</p><h3>Tags: </h3><p>amazon, aws, sns, topic, put, publish, pubsub</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 wil l 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>Amazon Resource Name (ARN)</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the resource to which notifications should be published<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>ARN Type</strong></td><td id="default-value">Topic ARN</td><td id="allowable-values"><ul><li>Topic ARN <img src="../../../../../html/images/iconInfo.png" alt="The ARN is the name of a topic" title="The ARN is the name of a topic"></img></li><li>Target ARN <img src="../../../../../html/images/iconInfo.png" alt="The ARN is the name of a particular Target, used to notify a specific subscriber" title="The ARN is the name of a particular Target, used to notify a specific subscriber"></img></li></ul></td><td id="description">The type of Amazon Resource Name that is being used.</td></tr><tr><td id="name">E-mail Subject</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The optional subject to use for any subscribers that are subscribed via E-mail<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Region</strong></td><td id="default-value">us-west-2</td><td id="allowable-values"><ul><li>AWS GovCloud (US)</li><li>US East (N. Virginia)</li><li>US East (Ohio)</li><li>US West (N. California)</li><li>US West (Oregon)</li><li>EU (Ireland)</li><li>EU (London)</li><li>EU (Paris)</li><li>EU (Frankfurt)</li><li>Asia Pacific (Mumbai)</li><li>Asia Pacific (Singapore)</li>< li>Asia Pacific (Sydney)</li><li>Asia Pacific (Tokyo)</li><li>Asia Pacific (Seoul)</li><li>South America (Sao Paulo)</li><li>China (Beijing)</li><li>China (Ningxia)</li><li>Canada (Central)</li></ul></td><td id="description">No Description Provided.</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 (will be evaluated using variable registry only)</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 (will be evaluated using variable registry only)</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 containi ng 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><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>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>Use JSON Structure</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If true, the contents of the FlowFile must be JSON with a top-level ele ment named 'default'. Additional elements can be used to send different messages to different protocols. See the Amazon SNS Documentation for more information.</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">The character set in which the FlowFile's content is encoded<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></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 (will be evaluated using variable registry only)</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 (will be evaluated using variable registry only)</strong></td></t r><tr><td id="name">Proxy Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Proxy username<br/><strong>Supports Expression Language: true (undefined scope)</strong></td></tr><tr><td id="name">Proxy Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Proxy password<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true (undefined scope)</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><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 component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires a n incoming relationship.<h3>System Resource Considerations:</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.PutSQS/index.html">PutSQS</a></p></body></html> \ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-aws-nar/1.7.0/org.apache.nifi.processors.aws.sqs.DeleteSQS/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-aws-nar/1.7.0/org.apache.nifi.processors.aws.sqs.DeleteSQS/index.html?rev=1834461&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-aws-nar/1.7.0/org.apache.nifi.processors.aws.sqs.DeleteSQS/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-aws-nar/1.7.0/org.apache.nifi.processors.aws.sqs.DeleteSQS/index.html Wed Jun 27 00:37:46 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>DeleteSQS</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;">DeleteSQS</h1><h2>Description: </h2><p>Deletes a message from an Amazon Simple Queuing Service Queue</p><h3>Tags: </h3><p>Amazon, AWS, SQS, Queue, Delete</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 valu e 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 (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Receipt Handle</strong></td><td id="default-value">${sqs.receipt.handle}</td><td id="allowable-values"></td><td id="description">The identifier that specifies the receipt of the message<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</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 (will >be evaluated using variable registry only)</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 (will be evaluated using variable registry >only)</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><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>AWS GovCloud (US)</li><li>US East (N. Virginia)</li><li>US East (Ohio)</li><li>US West (N. California)</li><li>US West (Oregon)</li><li>EU (Ireland)</li><li>EU (London)</li><li>EU (Paris)</li><li>EU (Frankfurt)</li><li>Asia Pacific (Mumbai)</li><li>Asia Pacific (Singapore)</li><li>Asia Pacific (Sydney)</li><li>Asia Pacific (Tokyo)</li><li>Asia Pacific (Seoul)</li><li>South America (Sao Paulo)</li><li>China (Beijing)</li><li>China (Ningxia)</li><li>Canada (Central)</li></ul></td><td id="description">No Description Provided.</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 (will be evaluated using variable registry only)</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 (will be evaluated using variable registry only)</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><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 component does not store state.<h3>Restricted: </h3>This co mponent is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</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.PutSQS/index.html">PutSQS</a></p></body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-aws-nar/1.7.0/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/nifi-aws-nar/1.7.0/org.apache.nifi.processors.aws.sqs.GetSQS/index.html?rev=1834461&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-aws-nar/1.7.0/org.apache.nifi.processors.aws.sqs.GetSQS/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-aws-nar/1.7.0/org.apache.nifi.processors.aws.sqs.GetSQS/index.html Wed Jun 27 00:37:46 2018 @@ -0,0 +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><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">GetSQS</h1><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 v alue 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 (will be evaluated using variable registry only)</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 (will be evaluated using variable registry >only)</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 (will be >evaluated using variable registry only)</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><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>AWS GovCloud (US)</li><li>US East (N. Virginia)</li><li>US East (Ohio)</li><li>US West (N. California)</li><li>US West (Oregon)</li><li>EU (Ireland)</li><li>EU (London)</li><li>EU (Paris)</li><li>EU (Frankfurt)</li><li>Asia Pacific (Mumbai)</li><li>Asia Pacific (Singapore)</li><li>Asia Pacific (Sydney)</li><li>Asia Pacific (Tokyo)</li><li>Asia Pacific (Seoul)</li><li>South America (Sao Paulo)</li><li>China (Beijing)</li><li>China (Ningxia)</li><li>Canada (Central)</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 net work 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>I BM863</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</li><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-Mac Roman</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 of 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 (will be evaluated using variable registry only)</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 (will be evaluated using variable registry only)</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-attri butes"><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 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.<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 Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-aws-nar/1.7.0/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/nifi-aws-nar/1.7.0/org.apache.nifi.processors.aws.sqs.PutSQS/index.html?rev=1834461&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-aws-nar/1.7.0/org.apache.nifi.processors.aws.sqs.PutSQS/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-aws-nar/1.7.0/org.apache.nifi.processors.aws.sqs.PutSQS/index.html Wed Jun 27 00:37:46 2018 @@ -0,0 +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><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">PutSQS</h1><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 valu e 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 (will be evaluated using flow file attributes and variable registry)</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 (will be evaluated using variable registry only)</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 Provid ed.<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</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><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>AWS GovClo ud (US)</li><li>US East (N. Virginia)</li><li>US East (Ohio)</li><li>US West (N. California)</li><li>US West (Oregon)</li><li>EU (Ireland)</li><li>EU (London)</li><li>EU (Paris)</li><li>EU (Frankfurt)</li><li>Asia Pacific (Mumbai)</li><li>Asia Pacific (Singapore)</li><li>Asia Pacific (Sydney)</li><li>Asia Pacific (Tokyo)</li><li>Asia Pacific (Seoul)</li><li>South America (Sao Paulo)</li><li>China (Beijing)</li><li>China (Ningxia)</li><li>Canada (Central)</li></ul></td><td id="description">No Description Provided.</td></tr><tr><td id="name"><strong>Delay</strong></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 (will be evaluated using variable registry only)</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 (will be evaluated using variable registry only)</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">The 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 Expr ession Language: true (will be evaluated using flow file attributes and variable registry)</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 component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</h3>None specified.<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 Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-aws-nar/1.7.0/org.apache.nifi.processors.aws.wag.InvokeAWSGatewayApi/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-aws-nar/1.7.0/org.apache.nifi.processors.aws.wag.InvokeAWSGatewayApi/index.html?rev=1834461&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-aws-nar/1.7.0/org.apache.nifi.processors.aws.wag.InvokeAWSGatewayApi/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-aws-nar/1.7.0/org.apache.nifi.processors.aws.wag.InvokeAWSGatewayApi/index.html Wed Jun 27 00:37:46 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>InvokeAWSGatewayApi</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;">InvokeAWSGatewayApi</h1><h2>Description: </h2><p>Client for AWS Gateway API endpoint</p><h3>Tags: </h3><p>Amazon, AWS, Client, Gateway-API, Rest, http, https</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 e ntering 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>HTTP Method</strong></td><td id="default-value">GET</td><td id="allowable-values"></td><td id="description">HTTP request method (GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS).Methods other than POST, PUT and PATCH will be sent without a message body.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Amazon Region</strong></td><td id="default-value">us-west-2</td><td id="allowable-values"><ul><li>AWS GovCloud (US)</li><li>US East (N. Virginia)</li><li>US East (Ohio)</li><li>US West (N. California)</li><li>US West (Oregon)</li><li>EU (Ireland)</li><li>EU (London)</li><li>EU (Paris)</li><li>EU (Frankfurt)</li><li>Asia Pacific (Mumbai)</li><li>Asia Pacific (Singapore)</li><li>Asia Pacific (Sydney)</li><li>Asia Pacific (Tokyo)</li><li>Asia Pacific (Seoul)</li><li>South America (Sao Paulo)</li><li>China (Beijing)</li><li>China (Ningxia)</li><li>Canada (Central)</li></ul></td><td id="description">No Description Provided.</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 (will be evaluated using variable registry only)</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 (will be evaluated using variable registry only)</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><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>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>Amazon Gateway Api ResourceName</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description" >The Name of the Gateway API Resource</td></tr><tr><td >id="name"><strong>Amazon Gateway Api Endpoint</strong></td><td >id="default-value"></td><td id="allowable-values"></td><td >id="description">The Api Endpoint</td></tr><tr><td id="name">Amazon Gateway >Api Key</td><td id="default-value"></td><td id="allowable-values"></td><td >id="description">The API Key<br/><strong>Sensitive Property: >true</strong><br/><strong>Supports Expression Language: true (will be >evaluated using flow file attributes and variable >registry)</strong></td></tr><tr><td id="name">Attributes to Send</td><td >id="default-value"></td><td id="allowable-values"></td><td >id="description">Regular expression that defines which attributes to send as >HTTP headers in the request. If not defined, no attributes are sent as >headers. Also any dynamic properties set will be sent as headers. The dynamic >property key will be the header key and the dynamic property value will be >interpreted as expression language will be the header v alue.</td></tr><tr><td id="name">Put Response Body In Attribute</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">If set, the response body received back will be put into an attribute of the original FlowFile instead of a separate FlowFile. The attribute key to put to is determined by evaluating value of this property. <br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Content-Type</strong></td><td id="default-value">${mime.type}</td><td id="allowable-values"></td><td id="description">The Content-Type to specify for when content is being transmitted through a PUT, POST or PATCH. In the case of an empty value after evaluating an expression language expression, Content-Type defaults to application/octet-stream<br/><strong>Supports Expression Language: true (undefined scope)</strong></td></tr><tr><td id="name">Send Message Body</td><td id="defa ult-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If true, sends the HTTP message body on POST/PUT/PATCH requests (default). If false, suppresses the message body and content-type header for these requests.</td></tr><tr><td id="name">Always Output Response</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Will force a response FlowFile to be generated and routed to the 'Response' relationship regardless of what the server status code received is or if the processor is configured to put the server response body in the request attribute. In the later configuration a request FlowFile with the response body in the attribute and a typical response FlowFile will be emitted to their respective relationships.</td></tr><tr><td id="name">Penalize on "No Retry"</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></t d><td id="description">Enabling this property will penalize FlowFiles that are routed to the "No Retry" relationship.</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 (will be evaluated using variable registry only)</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 (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Proxy Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Proxy username<br/><strong>Supports Expression Language: true (undefined scope)</strong></td></tr><tr><td id="name">Proxy Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Proxy password<br/><strong>Sensitive Prop erty: true</strong><br/><strong>Supports Expression Language: true (undefined scope)</strong></td></tr><tr><td id="name">Query Parameters</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The query parameters for this request in the form of Name=Value separated by &<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Max Length To Put In Attribute</td><td id="default-value">256</td><td id="allowable-values"></td><td id="description">If routing the response body to an attribute of the original (by setting the "Put response body in attribute" property or by receiving an error status code), the number of characters put to the attribute value will be at most this amount. This is important because attributes are held in memory and large attributes will quickly cause out of memory issues. If the output goes longer than this value, it will be truncated t o fit. Consider making this smaller if able.</td></tr><tr><td id="name">Add Response Headers To Request</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Enabling this property saves all the response headers to the original request. This may be when the response headers are needed but a response is not generated due to the status code received.</td></tr><tr><td id="name">Proxy Configuration Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>ProxyConfigurationService<br/><strong>Implementation: </strong><a href="../../../nifi-proxy-configuration-nar/1.7.0/org.apache.nifi.proxy.StandardProxyConfigurationService/index.html">StandardProxyConfigurationService</a></td><td id="description">Specifies the Proxy Configuration Controller Service to proxy network requests. If set, it supersedes proxy settings configured per component. Supported proxies: HTTP + AuthN</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">Header Name</td><td id="value">Attribute Expression Language</td><td>Send request header with a key matching the Dynamic Property Key and a value created by evaluating the Attribute Expression Language set in the value of the Dynamic Property.<br/><strong>Supports Expression Language: true (undefined scope)</strong></td></tr></table></p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>Original</td><td>The original FlowFile will be routed upon success (2xx status codes). It will have new attributes detailing the success of the request.</td></tr><tr><td>Failure</td><td>The original FlowFile will be routed on any type of connection failure, timeout or general exception. It will have new attribute s detailing the request.</td></tr><tr><td>Retry</td><td>The original FlowFile will be routed on any status code that can be retried (5xx status codes). It will have new attributes detailing the request.</td></tr><tr><td>No Retry</td><td>The original FlowFile will be routed on any status code that should NOT be retried (1xx, 3xx, 4xx status codes). It will have new attributes detailing the request.</td></tr><tr><td>Response</td><td>A Response FlowFile will be routed upon success (2xx status codes). If the 'Output Response Regardless' property is true then the response will be sent to this relationship regardless of the status code received.</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>mime.type</td><td>The MIME Type of the flowfiles</td></tr><tr><td>aws.gateway.api.status.code</td><td>The status code that is returned</td></tr><tr><td>aws.gateway.api.status.messag e</td><td>The status message that is returned</td></tr><tr><td>aws.gateway.api.response.body</td><td>In the instance where the status code received is not a success (2xx)</td></tr><tr><td>aws.gateway.api.resource</td><td>The request resource</td></tr><tr><td>aws.gateway.api.tx.id</td><td>The transaction ID that is returned after reading the response</td></tr><tr><td>aws.gateway.api.java.exception.class</td><td>The Java exception class raised when the processor fails</td></tr><tr><td>aws.gateway.api.java.exception.message</td><td>The Java exception message raised when the processor fails</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component allows an incoming relationship.<h3>System Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-azure-nar/1.7.0/org.apache.nifi.processors.azure.eventhub.ConsumeAzureEventHub/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-azure-nar/1.7.0/org.apache.nifi.processors.azure.eventhub.ConsumeAzureEventHub/index.html?rev=1834461&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-azure-nar/1.7.0/org.apache.nifi.processors.azure.eventhub.ConsumeAzureEventHub/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-azure-nar/1.7.0/org.apache.nifi.processors.azure.eventhub.ConsumeAzureEventHub/index.html Wed Jun 27 00:37:46 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ConsumeAzureEventHub</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;">ConsumeAzureEventHub</h1><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, 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>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.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></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.<br/><strong>Supports Expression Language: true (will be evalu ated using variable registry only)</strong></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.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></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><br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></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.<br/><strong>Supports Expres sion Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Event Hub Consumer Hostname</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The hostname of this Event Hub Consumer instance. If not specified, an unique identifier is generated in 'nifi-<UUID>' format.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Record Reader</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>RecordReaderFactory<br/><strong>Implementations: </strong><a href="../../../nifi-scripting-nar/1.7.0/org.apache.nifi.record.script.ScriptedReader/index.html">ScriptedReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.7.0/org.apache.nifi.grok.GrokReader/index.html">GrokReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.7.0/org.apache.nifi.json.JsonPa thReader/index.html">JsonPathReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.7.0/org.apache.nifi.json.JsonTreeReader/index.html">JsonTreeReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.7.0/org.apache.nifi.avro.AvroReader/index.html">AvroReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.7.0/org.apache.nifi.xml.XMLReader/index.html">XMLReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.7.0/org.apache.nifi.csv.CSVReader/index.html">CSVReader</a></td><td id="description">The Record Reader to use for reading received messages. The Event Hub name can be referred by Expression Language '${eventhub.name}' to access a schema.</td></tr><tr><td id="name">Record Writer</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>RecordSetWriterFactory<br/><strong>Implementations: </strong><a href="../../../nifi-record-serialization-services-nar/1.7.0/org. apache.nifi.avro.AvroRecordSetWriter/index.html">AvroRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.7.0/org.apache.nifi.csv.CSVRecordSetWriter/index.html">CSVRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.7.0/org.apache.nifi.text.FreeFormTextRecordSetWriter/index.html">FreeFormTextRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.7.0/org.apache.nifi.json.JsonRecordSetWriter/index.html">JsonRecordSetWriter</a><br/><a href="../../../nifi-scripting-nar/1.7.0/org.apache.nifi.record.script.ScriptedRecordSetWriter/index.html">ScriptedRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.7.0/org.apache.nifi.xml.XMLRecordSetWriter/index.html">XMLRecordSetWriter</a></td><td id="description">The Record Writer to use for serializing Records to an output FlowFile. The Event Hub name can be referred by Expression Language '${eventhub.name}' to access a schema. If not specified, each message will create a FlowFile.</td></tr><tr><td id="name"><strong>Initial Offset</strong></td><td id="default-value">end-of-stream</td><td id="allowable-values"><ul><li>Start of stream <img src="../../../../../html/images/iconInfo.png" alt="Read from the oldest message retained in the stream." title="Read from the oldest message retained in the stream."></img></li><li>End of stream <img src="../../../../../html/images/iconInfo.png" alt="Ignore old retained messages even if exist, start reading new ones from now." title="Ignore old retained messages even if exist, start reading new ones from now."></img></li></ul></td><td id="description">Specify where to start receiving messages if offset is not stored in Azure Storage.</td></tr><tr><td id="name"><strong>Prefetch Count</strong></td><td id="default-value">300</td><td id="allowable-values"></td><td id="description">No Description Provided.<br/><strong>Supports Expression Language: true (will be evaluated using var iable registry only)</strong></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 number of messages to process within a NiFi session. This parameter affects throughput and consistency. NiFi commits its session and Event Hub checkpoint after processing this number of messages. If NiFi session is committed, but failed to create an Event Hub checkpoint, then it is possible that the same messages to be retrieved again. The higher number, the higher throughput, but possibly less consistent.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Message Receive Timeout</strong></td><td id="default-value">1 min</td><td id="allowable-values"></td><td id="description">The amount of time this consumer should wait to receive the Prefetch Count before returning.<br/><strong>Supports Expression Language: true (will be e valuated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Storage Account Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Name of the Azure Storage account to store Event Hub Consumer Group state.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Storage Account Key</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Azure Storage account key to store Event Hub Consumer Group state.<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Storage Container Name</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Name of the Azure Storage Container to store Event Hub Consumer Group state. If not specified, Event Hub name is use d.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>FlowFiles received from Event Hub.</td></tr><tr><td>parse.failure</td><td>If a message from Event Hub cannot be parsed using the configured Record Reader or failed to be written by the configured Record Writer, the contents of the message will be routed to this Relationship as its own individual FlowFile.</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 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> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-azure-nar/1.7.0/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/nifi-azure-nar/1.7.0/org.apache.nifi.processors.azure.eventhub.GetAzureEventHub/index.html?rev=1834461&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-azure-nar/1.7.0/org.apache.nifi.processors.azure.eventhub.GetAzureEventHub/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-azure-nar/1.7.0/org.apache.nifi.processors.azure.eventhub.GetAzureEventHub/index.html Wed Jun 27 00:37:46 2018 @@ -0,0 +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><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">GetAzureEventHub</h1><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>Service Bus Endpoint</strong></td><td id="default-value">.servicebus.windows.net</td><td id="allowable-values"><ul><li>.servicebus.windows.net</li><li>.servicebus.chinacloudapi.cn</li></ul></td><td id="description">To support Namespaces in non-standard Host URIs ( not .servicebus.windows.net, ie .servicebus.chinacloudapi.cn) select from the drop down acceptable options </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="default-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 Re ceiver 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 Partiti on from which the message was pulled</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> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-azure-nar/1.7.0/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/nifi-azure-nar/1.7.0/org.apache.nifi.processors.azure.eventhub.PutAzureEventHub/index.html?rev=1834461&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-azure-nar/1.7.0/org.apache.nifi.processors.azure.eventhub.PutAzureEventHub/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-azure-nar/1.7.0/org.apache.nifi.processors.azure.eventhub.PutAzureEventHub/index.html Wed Jun 27 00:37:46 2018 @@ -0,0 +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><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">PutAzureEventHub</h1><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 defa ult 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="description">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 component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relations hip.<h3>System Resource Considerations:</h3><table id="system-resource-considerations"><tr><th>Resource</th><th>Description</th></tr><tr><td>MEMORY</td><td>An instance of this component can cause high usage of this system resource. Multiple instances or high concurrency settings may result a degradation of performance.</td></tr></table></body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-azure-nar/1.7.0/org.apache.nifi.processors.azure.storage.DeleteAzureBlobStorage/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-azure-nar/1.7.0/org.apache.nifi.processors.azure.storage.DeleteAzureBlobStorage/index.html?rev=1834461&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-azure-nar/1.7.0/org.apache.nifi.processors.azure.storage.DeleteAzureBlobStorage/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-azure-nar/1.7.0/org.apache.nifi.processors.azure.storage.DeleteAzureBlobStorage/index.html Wed Jun 27 00:37:46 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>DeleteAzureBlobStorage</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;">DeleteAzureBlobStorage</h1><h2>Description: </h2><p>Deletes the provided blob from Azure Storage</p><h3>Tags: </h3><p>azure, microsoft, cloud, storage, blob</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>Container Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Name of the Azure storage container<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">SAS Token</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Shared Access Signature token, including the leading '?'. Specify either SAS Token (recommended) or Account Key. There are certain risks in allowing the SAS token to be stored as a flowfile attribute. While it does provide for a more flexible flow by allowing the account name to be fetched dynam ically from a flowfile attribute, care must be taken to restrict access to the event provenance data (e.g. by strictly controlling the policies governing provenance for this Processor). In addition, the provenance repositories may be put on encrypted disk partitions.<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Storage Account Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The storage account name. There are certain risks in allowing the account name to be stored as a flowfile attribute. While it does provide for a more flexible flow by allowing the account name to be fetched dynamically from a flowfile attribute, care must be taken to restrict access to the event provenance data (e.g. by strictly controlling the policies governing provenance for this Processor). In additio n, the provenance repositories may be put on encrypted disk partitions.<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Storage Account Key</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The storage account key. This is an admin-like password providing access to every container in this account. It is recommended one uses Shared Access Signature (SAS) token instead for fine-grained control with policies. There are certain risks in allowing the account key to be stored as a flowfile attribute. While it does provide for a more flexible flow by allowing the account key to be fetched dynamically from a flow file attribute, care must be taken to restrict access to the event provenance data (e.g. by strictly controlling the policies governing provenance for this Processor). In addition, the provenance repo sitories may be put on encrypted disk partitions.<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Blob</strong></td><td id="default-value">${azure.blobname}</td><td id="allowable-values"></td><td id="description">The filename of the blob<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Proxy Configuration Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>ProxyConfigurationService<br/><strong>Implementation: </strong><a href="../../../nifi-proxy-configuration-nar/1.7.0/org.apache.nifi.proxy.StandardProxyConfigurationService/index.html">StandardProxyConfigurationService</a></td><td id="description">Specifies the Proxy Configuration Controller Service to proxy network requests. Supported proxies: HTTP, SOCKS</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All successfully processed FlowFiles are routed to this relationship</td></tr><tr><td>failure</td><td>Unsuccessful operations will be transferred to the failure relationship.</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</h3>None specified.<h3>See Also:</h3><p><a href="../org.apache.nifi.processors.azure.storage.ListAzureBlobStorage/index.html">ListAzureBlobStorage</a>, <a href="../org.apache.nifi.processors.azure.storage.FetchAzureBlobStorage/index.html">FetchAzureBlobStorage</a>, <a href="../org.apache.nifi.processors.azure.stora ge.PutAzureBlobStorage/index.html">PutAzureBlobStorage</a></p></body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-azure-nar/1.7.0/org.apache.nifi.processors.azure.storage.FetchAzureBlobStorage/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-azure-nar/1.7.0/org.apache.nifi.processors.azure.storage.FetchAzureBlobStorage/index.html?rev=1834461&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-azure-nar/1.7.0/org.apache.nifi.processors.azure.storage.FetchAzureBlobStorage/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-azure-nar/1.7.0/org.apache.nifi.processors.azure.storage.FetchAzureBlobStorage/index.html Wed Jun 27 00:37:46 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>FetchAzureBlobStorage</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;">FetchAzureBlobStorage</h1><h2>Description: </h2><p>Retrieves contents of an Azure Storage Blob, writing the contents to the content of the FlowFile</p><h3>Tags: </h3><p>azure, microsoft, cloud, storage, blob</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>Container Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Name of the Azure storage container<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">SAS Token</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Shared Access Signature token, including the leading '?'. Specify either SAS Token (recommended) or Account Key. There are certain risks in allowing the SAS token to be stored as a flowfile attribute. While it does provide for a more flexible flo w by allowing the account name to be fetched dynamically from a flowfile attribute, care must be taken to restrict access to the event provenance data (e.g. by strictly controlling the policies governing provenance for this Processor). In addition, the provenance repositories may be put on encrypted disk partitions.<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Storage Account Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The storage account name. There are certain risks in allowing the account name to be stored as a flowfile attribute. While it does provide for a more flexible flow by allowing the account name to be fetched dynamically from a flowfile attribute, care must be taken to restrict access to the event provenance data (e.g. by strictly controlling the policies go verning provenance for this Processor). In addition, the provenance repositories may be put on encrypted disk partitions.<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Storage Account Key</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The storage account key. This is an admin-like password providing access to every container in this account. It is recommended one uses Shared Access Signature (SAS) token instead for fine-grained control with policies. There are certain risks in allowing the account key to be stored as a flowfile attribute. While it does provide for a more flexible flow by allowing the account key to be fetched dynamically from a flow file attribute, care must be taken to restrict access to the event provenance data (e.g. by strictly controlling the policies governing provenance for this Processor). In addition, the provenance repositories may be put on encrypted disk partitions.<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Blob</strong></td><td id="default-value">${azure.blobname}</td><td id="allowable-values"></td><td id="description">The filename of the blob<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Proxy Configuration Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>ProxyConfigurationService<br/><strong>Implementation: </strong><a href="../../../nifi-proxy-configuration-nar/1.7.0/org.apache.nifi.proxy.StandardProxyConfigurationService/index.html">StandardProxyConfigurationService</a></td><td id="description">Specifies the Proxy Configuration Controller Service to proxy network requests. Supported proxies: HTTP, SOCKS</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All successfully processed FlowFiles are routed to this relationship</td></tr><tr><td>failure</td><td>Unsuccessful operations will be transferred to the failure 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>azure.length</td><td>The length of the blob fetched</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</h3>None specified.<h3>See Also:</h3><p><a href="../org.apache.nifi.processors.azure.storage.ListAzureBlobStorage/index.html">ListAz ureBlobStorage</a>, <a href="../org.apache.nifi.processors.azure.storage.PutAzureBlobStorage/index.html">PutAzureBlobStorage</a>, <a href="../org.apache.nifi.processors.azure.storage.DeleteAzureBlobStorage/index.html">DeleteAzureBlobStorage</a></p></body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-azure-nar/1.7.0/org.apache.nifi.processors.azure.storage.ListAzureBlobStorage/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-azure-nar/1.7.0/org.apache.nifi.processors.azure.storage.ListAzureBlobStorage/index.html?rev=1834461&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-azure-nar/1.7.0/org.apache.nifi.processors.azure.storage.ListAzureBlobStorage/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-azure-nar/1.7.0/org.apache.nifi.processors.azure.storage.ListAzureBlobStorage/index.html Wed Jun 27 00:37:46 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ListAzureBlobStorage</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;">ListAzureBlobStorage</h1><h2>Description: </h2><p>Lists blobs in an Azure Storage container. Listing details are attached to an empty FlowFile for use with FetchAzureBlobStorage. This Processor is designed to run on Primary Node only in a cluster. If the primary node changes, the new Primary Node will pick up where the previous node left off without duplicating all of the data.</p><h3>Tags: </h3><p>azure, microsoft, cloud, storage, blob</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 cons idered 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>Container Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Name of the Azure storage container<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">SAS Token</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Shared Access Signature token, in cluding the leading '?'. Specify either SAS Token (recommended) or Account Key. There are certain risks in allowing the SAS token to be stored as a flowfile attribute. While it does provide for a more flexible flow by allowing the account name to be fetched dynamically from a flowfile attribute, care must be taken to restrict access to the event provenance data (e.g. by strictly controlling the policies governing provenance for this Processor). In addition, the provenance repositories may be put on encrypted disk partitions.<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Storage Account Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The storage account name. There are certain risks in allowing the account name to be stored as a flowfile attribute. While it does provide for a more flexible flow b y allowing the account name to be fetched dynamically from a flowfile attribute, care must be taken to restrict access to the event provenance data (e.g. by strictly controlling the policies governing provenance for this Processor). In addition, the provenance repositories may be put on encrypted disk partitions.<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Storage Account Key</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The storage account key. This is an admin-like password providing access to every container in this account. It is recommended one uses Shared Access Signature (SAS) token instead for fine-grained control with policies. There are certain risks in allowing the account key to be stored as a flowfile attribute. While it does provide for a more flexible flow by allowing the account key to be fetched d ynamically from a flow file attribute, care must be taken to restrict access to the event provenance data (e.g. by strictly controlling the policies governing provenance for this Processor). In addition, the provenance repositories may be put on encrypted disk partitions.<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Prefix</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Search prefix for listing<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Proxy Configuration Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>ProxyConfigurationService<br/><strong>Implementation: </strong><a href="../../../nifi-proxy-configuration-nar/1.7.0/org.apache.nifi.proxy.StandardProxyConfigurationS ervice/index.html">StandardProxyConfigurationService</a></td><td id="description">Specifies the Proxy Configuration Controller Service to proxy network requests. Supported proxies: HTTP, SOCKS</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All FlowFiles that are received are routed to success</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>azure.container</td><td>The name of the Azure container</td></tr><tr><td>azure.blobname</td><td>The name of the Azure blob</td></tr><tr><td>azure.primaryUri</td><td>Primary location for blob content</td></tr><tr><td>azure.secondaryUri</td><td>Secondary location for blob content</td></tr><tr><td>azure.etag</td><td>Etag for the Azure blob</td></tr><tr><td>azure.length</td><td>Length of the blob</td></tr><tr><td>azure.timestamp</td><td>The timestamp in Azure for the blob</td></tr><tr><td>mime.type</td><td>MimeType of the content</td></tr><tr><td>lang</td><td>Language code for the content</td></tr><tr><td>azure.blobtype</td><td>This is the type of blob and can be either page or block type</td></tr></table><h3>State management: </h3><table id="stateful"><tr><th>Scope</th><th>Description</th></tr><tr><td>CLUSTER</td><td>After performing a listing of blobs, the timestamp of the newest blob is stored. This allows the Processor to list only blobs that have been added or modified after this date the next time that the Processor is run. State is stored across the cluster so that this Processor can be run on Primary Node only and if a new Primary Node is selected, the new node can pick up where the previous node left off, without duplicating the data.</td></tr></table><h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component does not allow an incoming relationship.<h3>System Resource Consideratio ns:</h3>None specified.<h3>See Also:</h3><p><a href="../org.apache.nifi.processors.azure.storage.FetchAzureBlobStorage/index.html">FetchAzureBlobStorage</a>, <a href="../org.apache.nifi.processors.azure.storage.PutAzureBlobStorage/index.html">PutAzureBlobStorage</a>, <a href="../org.apache.nifi.processors.azure.storage.DeleteAzureBlobStorage/index.html">DeleteAzureBlobStorage</a></p></body></html> \ No newline at end of file
