Author: tkurc
Date: Wed Feb 17 02:20:53 2016
New Revision: 1730777
URL: http://svn.apache.org/viewvc?rev=1730777&view=rev
Log:
NIFI-1379: Updating components doc
Added:
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.GetHTMLElement/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.GetHTMLElement/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.ModifyHTMLElement/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.ModifyHTMLElement/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.PutHTMLElement/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.PutHTMLElement/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.amqp.processors.ConsumeAMQP/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.amqp.processors.ConsumeAMQP/additionalDetails.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.amqp.processors.ConsumeAMQP/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.amqp.processors.PublishAMQP/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.amqp.processors.PublishAMQP/additionalDetails.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.amqp.processors.PublishAMQP/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.credentials.provider.service.AWSCredentialsProviderControllerService/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.credentials.provider.service.AWSCredentialsProviderControllerService/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.elasticsearch.FetchElasticsearch/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.elasticsearch.FetchElasticsearch/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.elasticsearch.PutElasticsearch/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.elasticsearch.PutElasticsearch/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.kite.InferAvroSchema/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.kite.InferAvroSchema/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.riemann.PutRiemann/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.riemann.PutRiemann/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.script.ExecuteScript/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.script.ExecuteScript/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.script.InvokeScriptedProcessor/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.script.InvokeScriptedProcessor/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.FetchDistributedMapCache/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.FetchDistributedMapCache/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ListenRELP/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ListenRELP/index.html
Modified:
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.hbase.GetHBase/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.s3.DeleteS3Object/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.s3.FetchS3Object/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.s3.PutS3Object/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.sns.PutSNS/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.sqs.DeleteSQS/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.sqs.GetSQS/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.sqs.PutSQS/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.hadoop.ListHDFS/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.mongodb.GetMongo/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.solr.GetSolr/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.solr.PutSolrContentStream/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ConvertJSONToSQL/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.DetectDuplicate/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.EncryptContent/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.FetchSFTP/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.GetHTTP/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.HashContent/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.InvokeHTTP/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ListFile/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ListenSyslog/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.MergeContent/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.PostHTTP/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.PutDistributedMapCache/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.PutSyslog/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.TailFile/index.html
Added:
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.GetHTMLElement/index.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.GetHTMLElement/index.html?rev=1730777&view=auto
==============================================================================
---
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.GetHTMLElement/index.html
(added)
+++
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.GetHTMLElement/index.html
Wed Feb 17 02:20:53 2016
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta
charset="utf-8"></meta><title>GetHTMLElement</title><link rel="stylesheet"
href="../../css/component-usage.css"
type="text/css"></link></head><body><h2>Description: </h2><p>Extracts HTML
element values from the incoming flowfile's content using a CSS selector. The
incoming HTML is first converted into a HTML Document Object Model so that HTML
elements may be selected in the similar manner that CSS selectors are used to
apply styles to HTML. The resulting HTML DOM is then "queried" using the user
defined CSS selector string. The result of "querying" the HTML DOM may produce
0-N results. If no results are found the flowfile will be transferred to the
"element not found" relationship to indicate so to the end user. If N results
are found a new flowfile will be created and emitted for each result. The query
result will either be placed in the content of the new flowfile or as an
attribute of the new flowfile. By default the result is written to
an attribute. This can be controlled by the "Destination" property. Resulting
query values may also have data prepended or appended to them by setting the
value of property "Prepend Element Value" or "Append Element Value". Prepended
and appended values are treated as string values and concatenated to the result
retrieved from the HTML DOM query operation. A more thorough reference for the
CSS selector syntax can be found at
"http://jsoup.org/apidocs/org/jsoup/select/Selector.html";</p><h3>Tags:
</h3><p>get, html, dom, css, element</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 i
d="name"><strong>URL</strong></td><td id="default-value"></td><td
id="allowable-values"></td><td id="description">Base URL for the HTML page
being parsed.</td></tr><tr><td id="name"><strong>CSS Selector</strong></td><td
id="default-value"></td><td id="allowable-values"></td><td id="description">CSS
selector syntax string used to extract the desired HTML
element(s).<br/><strong>Supports Expression Language:
true</strong></td></tr><tr><td id="name"><strong>HTML Character
Encoding</strong></td><td id="default-value">UTF-8</td><td
id="allowable-values"></td><td id="description">Character encoding of the input
HTML</td></tr><tr><td id="name"><strong>Output Type</strong></td><td
id="default-value">HTML</td><td
id="allowable-values"><ul><li>HTML</li><li>Text</li><li>Attribute</li><li>Data</li></ul></td><td
id="description">Controls the type of DOM value that is retrieved from the
HTML element.</td></tr><tr><td id="name"><strong>Destination</strong></td><td
id="default-value">flowfile-attri
bute</td><td
id="allowable-values"><ul><li>flowfile-attribute</li><li>flowfile-content</li></ul></td><td
id="description">Control if element extracted is written as a flowfile
attribute or as flowfile content.</td></tr><tr><td id="name">Prepend Element
Value</td><td id="default-value"></td><td id="allowable-values"></td><td
id="description">Prepends the specified value to the resulting
Element<br/><strong>Supports Expression Language:
true</strong></td></tr><tr><td id="name">Append Element Value</td><td
id="default-value"></td><td id="allowable-values"></td><td
id="description">Appends the specified value to the resulting
Element<br/><strong>Supports Expression Language:
true</strong></td></tr><tr><td id="name">Attribute Name</td><td
id="default-value"></td><td id="allowable-values"></td><td
id="description">When getting the value of a HTML element attribute this value
is used as the key to determine which attribute on the selected element should
be retrieved. This value is used whe
n the "Output Type" is set to "Attribute"<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>element
not found</td><td>Element could not be found in the HTML document. The original
HTML input will remain in the flowfile content unchanged. Relationship
'original' will not be invoked in this
scenario.</td></tr><tr><td>success</td><td>Successfully parsed HTML
element</td></tr><tr><td>original</td><td>The original HTML
input</td></tr><tr><td>invalid html</td><td>The input HTML syntax is
invalid</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>HTMLElement</td><td>Flowfile
attribute where the element result parsed from the HTML using the CSS selector
syntax are placed if the destination is a flowfile
attribute.</td></tr></table><h3>See Also:</h3><p><a h
ref="../org.apache.nifi.ModifyHTMLElement/index.html">ModifyHTMLElement</a>,
<a
href="../org.apache.nifi.PutHTMLElement/index.html">PutHTMLElement</a></p></body></html>
\ No newline at end of file
Added:
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.ModifyHTMLElement/index.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.ModifyHTMLElement/index.html?rev=1730777&view=auto
==============================================================================
---
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.ModifyHTMLElement/index.html
(added)
+++
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.ModifyHTMLElement/index.html
Wed Feb 17 02:20:53 2016
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta
charset="utf-8"></meta><title>ModifyHTMLElement</title><link rel="stylesheet"
href="../../css/component-usage.css"
type="text/css"></link></head><body><h2>Description: </h2><p>Modifies the value
of an existing HTML element. The desired element to be modified is located by
using CSS selector syntax. The incoming HTML is first converted into a HTML
Document Object Model so that HTML elements may be selected in the similar
manner that CSS selectors are used to apply styles to HTML. The resulting HTML
DOM is then "queried" using the user defined CSS selector string to find the
element the user desires to modify. If the HTML element is found the element's
value is updated in the DOM using the value specified "Modified Value"
property. All DOM elements that match the CSS selector will be updated. Once
all of the DOM elements have been updated the DOM is rendered to HTML and the
result replaces the flowfile content with the updated HTML. A more th
orough reference for the CSS selector syntax can be found at
"http://jsoup.org/apidocs/org/jsoup/select/Selector.html";</p><h3>Tags:
</h3><p>modify, html, dom, css, element</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>URL</strong></td><td id="default-value"></td><td
id="allowable-values"></td><td id="description">Base URL for the HTML page
being parsed.</td></tr><tr><td id="name"><strong>CSS Selector</strong></td><td
id="default-value"></td><td id="allowable-values"></td><td id="description">CSS
selector syntax string used to extract the desired HTML element(s)
.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td
id="name"><strong>HTML Character Encoding</strong></td><td
id="default-value">UTF-8</td><td id="allowable-values"></td><td
id="description">Character encoding of the input HTML</td></tr><tr><td
id="name"><strong>Output Type</strong></td><td id="default-value">HTML</td><td
id="allowable-values"><ul><li>HTML</li><li>Text</li><li>Attribute</li></ul></td><td
id="description">Controls whether the HTML element is output as HTML,Text or
Data</td></tr><tr><td id="name"><strong>Modified Value</strong></td><td
id="default-value"></td><td id="allowable-values"></td><td
id="description">Value to update the found HTML elements
with<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td
id="name">Attribute Name</td><td id="default-value"></td><td
id="allowable-values"></td><td id="description">When modifying the value of an
element attribute this value is used as the key to determine which attribute on
th
e selected element will be modified with the new value.<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>element
not found</td><td>Element could not be found in the HTML document. The original
HTML input will remain in the flowfile content unchanged. Relationship
'original' will not be invoked in this
scenario.</td></tr><tr><td>success</td><td>Successfully parsed HTML
element</td></tr><tr><td>original</td><td>The original HTML
input</td></tr><tr><td>invalid html</td><td>The input HTML syntax is
invalid</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>NumElementsModified</td><td>Total
number of HTML element modifications made</td></tr></table><h3>See
Also:</h3><p><a
href="../org.apache.nifi.GetHTMLElement/index.html">GetHTMLElement</a>, <a
href="
../org.apache.nifi.PutHTMLElement/index.html">PutHTMLElement</a></p></body></html>
\ No newline at end of file
Added:
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.PutHTMLElement/index.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.PutHTMLElement/index.html?rev=1730777&view=auto
==============================================================================
---
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.PutHTMLElement/index.html
(added)
+++
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.PutHTMLElement/index.html
Wed Feb 17 02:20:53 2016
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta
charset="utf-8"></meta><title>PutHTMLElement</title><link rel="stylesheet"
href="../../css/component-usage.css"
type="text/css"></link></head><body><h2>Description: </h2><p>Places a new HTML
element in the existing HTML DOM. The desired position for the new HTML element
is specified by using CSS selector syntax. The incoming HTML is first converted
into a HTML Document Object Model so that HTML DOM location may be located in a
similar manner that CSS selectors are used to apply styles to HTML. The
resulting HTML DOM is then "queried" using the user defined CSS selector string
to find the position where the user desires to add the new HTML element. Once
the new HTML element is added to the DOM it is rendered to HTML and the result
replaces the flowfile content with the updated HTML. A more thorough reference
for the CSS selector syntax can be found at
"http://jsoup.org/apidocs/org/jsoup/select/Selector.html";</p><h3>Tags:
</h3><p>put, html, d
om, css, element</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>URL</strong></td><td id="default-value"></td><td
id="allowable-values"></td><td id="description">Base URL for the HTML page
being parsed.</td></tr><tr><td id="name"><strong>CSS Selector</strong></td><td
id="default-value"></td><td id="allowable-values"></td><td id="description">CSS
selector syntax string used to extract the desired HTML
element(s).<br/><strong>Supports Expression Language:
true</strong></td></tr><tr><td id="name"><strong>HTML Character
Encoding</strong></td><td id="default-value">UT
F-8</td><td id="allowable-values"></td><td id="description">Character encoding
of the input HTML</td></tr><tr><td id="name"><strong>Element Insert Location
Type</strong></td><td id="default-value">append-html</td><td
id="allowable-values"><ul><li>append-html</li><li>prepend-html</li></ul></td><td
id="description">Controls whether the new element is prepended or appended to
the children of the Element located by the CSS selector. EX: prepended value
'<b>Hi</b>' inside of Element (using CSS Selector 'p')
'<p>There</p>' would result in
'<p><b>Hi</b>There</p>'. Appending the value would
result in '<p>There<b>Hi</b></p>'</td></tr><tr><td
id="name"><strong>Put Value</strong></td><td id="default-value"></td><td
id="allowable-values"></td><td id="description">Value used when creating the
new Element. Value should be a valid HTML element. The text should be supplied
unencoded: characters like '<', '>', etc will be
properly HTML encoded in the resulting output.<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>element
not found</td><td>Element could not be found in the HTML document. The original
HTML input will remain in the flowfile content unchanged. Relationship
'original' will not be invoked in this
scenario.</td></tr><tr><td>success</td><td>Successfully parsed HTML
element</td></tr><tr><td>original</td><td>The original HTML
input</td></tr><tr><td>invalid html</td><td>The input HTML syntax is
invalid</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.GetHTMLElement/index.html">GetHTMLElement</a>, <a
href="../org.apache.nifi.ModifyHTMLElement/index.html">ModifyHTMLElement</a></p></body></html>
\ No newline at end of file
Added:
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.amqp.processors.ConsumeAMQP/additionalDetails.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.amqp.processors.ConsumeAMQP/additionalDetails.html?rev=1730777&view=auto
==============================================================================
---
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.amqp.processors.ConsumeAMQP/additionalDetails.html
(added)
+++
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.amqp.processors.ConsumeAMQP/additionalDetails.html
Wed Feb 17 02:20:53 2016
@@ -0,0 +1,72 @@
+<!DOCTYPE html>
+<html lang="en">
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<head>
+ <meta charset="utf-8" />
+ <title>ConsumeAMQP</title>
+ <link rel="stylesheet" href="../../css/component-usage.css"
type="text/css" />
+</head>
+
+<body>
+<h2>Summary</h2>
+<p>
+ This processor consumes messages from AMQP messaging queue and converts
them to a FlowFile to be routed to the next component in the flow.
+ At the time of writing this document the supported AMQP protocol version
is v0.9.1.
+</p>
+<p>
+ The component is based on <a
href="https://www.rabbitmq.com/api-guide.html";>RabbitMQ Client API</a>
+ <a href="https://www.rabbitmq.com/getstarted.html";>The following guide
and tutorial</a> may also help you to brush up on some of the AMQP basics.
+</p>
+<p>
+ This processor does two things. It constructs FlwFile by extracting
information from the consumed AMQP message (both body and attributes).
+ Once message is consumed a FlowFile is constructed. The message body is
written to a FlowFile and its <i>com.rabbitmq.client.AMQP.BasicProperties</i>
+ are transfered into the FlowFile as attributes. AMQP attribute names are
prefixed with <i>amqp$</i> prefix.
+</p>
+<h2>AMQP Properties</h2>
+<p>
+ The following is the list of available standard AMQP properties which may
come with the message: <i>("amqp$contentType", "amqp$contentEncoding",
+ "amqp$headers", "amqp$deliveryMode", "amqp$priority",
"amqp$correlationId", "amqp$replyTo",
+ "amqp$expiration", "amqp$messageId", "amqp$timestamp",
"amqp$type", "amqp$userId", "amqp$appId",
+ "amqp$clusterId")</i>
+</p>
+<h2>Configuration Details</h2>
+<p>
+ At the time of writing this document it only defines the essential
configuration properties which are suitable for most cases.
+ Other properties will be defined later as this component progresses.
+ Configuring PublishAMQP:
+</p>
+<ol>
+ <li><b>Queue</b> - [REQUIRED] the name of AMQP queue the messages will
retrieved from. Usually provided by administrator (e.g., 'amq.direct')
+ </li>
+ <li><b>Host Name</b> - [REQUIRED] the name of the host where AMQP broker
is running.
+ Usually provided by administrator (e.g., 'myhost.com'). Defaults to
'localhost'.
+ </li>
+ <li><b>Port</b> - [REQUIRED] the port number where AMQP broker is running.
+ Usually provided by the administrator (e.g., '2453'). Defaults to '5672'.
+ </li>
+ <li><b>User Name</b> - [REQUIRED] user name to connect to AMQP broker.
+ Usually provided by the administrator (e.g., 'me'). Defaults to 'guest'.
+ </li>
+ <li><b>Password</b> - [REQUIRED] password to use with user name to connect
to AMQP broker.
+ Usually provided by the administrator. Defaults to 'guest'.
+ </li>
+ <li><b>Virtual Host</b> - [OPTIONAL] Virtual Host name which segregates
AMQP system for enhanced security.
+ Please refer to <a
href="http://blog.dtzq.com/2012/06/rabbitmq-users-and-virtual-hosts.html";>this
blog</a> for more details on Virtual Host.
+ </li>
+</ol>
+
+</body>
+</html>
\ No newline at end of file
Added:
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.amqp.processors.ConsumeAMQP/index.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.amqp.processors.ConsumeAMQP/index.html?rev=1730777&view=auto
==============================================================================
---
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.amqp.processors.ConsumeAMQP/index.html
(added)
+++
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.amqp.processors.ConsumeAMQP/index.html
Wed Feb 17 02:20:53 2016
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta
charset="utf-8"></meta><title>ConsumeAMQP</title><link rel="stylesheet"
href="../../css/component-usage.css"
type="text/css"></link></head><body><h2>Description: </h2><p>Consumes AMQP
Message transforming its content to a FlowFile and transitioning it to
'success' relationship</p><p><a href="additionalDetails.html">Additional
Details...</a></p><h3>Tags: </h3><p>amqp, rabbit, get, message, receive,
consume</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>Queue</strong></td><td id="default-value"></td><td
id="allowable-values"></td><td id="description">The name of the existing AMQP
Queue from which messages will be consumed. Usually pre-defined by AMQP
administrator. </td></tr><tr><td id="name"><strong>Host Name</strong></td><td
id="default-value">localhost</td><td id="allowable-values"></td><td
id="description">Network address of AMQP broker (e.g.,
localhost)</td></tr><tr><td id="name"><strong>Port</strong></td><td
id="default-value">5672</td><td id="allowable-values"></td><td
id="description">Numeric value identifying Port of AMQP broker (e.g.,
5671)</td></tr><tr><td id="name">Virtual Host</td><td
id="default-value"></td><td id="allowable-values"></td><td
id="description">Virtual Host name which segregates AMQP system for enhanced
security.</td></tr><tr><td id="name"><strong>User Name</strong></td><td
id="default-value">guest</td><td id="allowable-valu
es"></td><td id="description">User Name used for authentication and
authorization.</td></tr><tr><td id="name"><strong>Password</strong></td><td
id="default-value">guest</td><td id="allowable-values"></td><td
id="description">Password used for authentication and
authorization.<br/><strong>Sensitive Property: true</strong></td></tr><tr><td
id="name"><strong>AMQP Version</strong></td><td
id="default-value">0.9.1</td><td
id="allowable-values"><ul><li>0.9.1</li></ul></td><td id="description">AMQP
Version. Currently only supports AMQP
v0.9.1.</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 from the AMQP queue are routed 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
Added:
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.amqp.processors.PublishAMQP/additionalDetails.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.amqp.processors.PublishAMQP/additionalDetails.html?rev=1730777&view=auto
==============================================================================
---
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.amqp.processors.PublishAMQP/additionalDetails.html
(added)
+++
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.amqp.processors.PublishAMQP/additionalDetails.html
Wed Feb 17 02:20:53 2016
@@ -0,0 +1,94 @@
+<!DOCTYPE html>
+<html lang="en">
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<head>
+ <meta charset="utf-8" />
+ <title>PublishAMQP</title>
+ <link rel="stylesheet" href="../../css/component-usage.css"
type="text/css" />
+</head>
+
+<body>
+<h2>Summary</h2>
+<p>
+ This processor publishes the contents of the incoming FlowFile to an
AMQP-based messaging system.
+ At the time of writing this document the supported AMQP protocol version
is v0.9.1.
+</p>
+<p>
+ The component is based on <a
href="https://www.rabbitmq.com/api-guide.html";>RabbitMQ Client API</a>
+ <a href="https://www.rabbitmq.com/getstarted.html";>The following guide
and tutorial</a> may also help you to brush up on some of the AMQP basics.
+</p>
+<p>
+ This processor does two things. It constructs AMQP Message by extracting
FlowFile contents (both body and attributes).
+ Once message is constructed it is sent to an AMQP Exchange.
+ AMQP Properties will be extracted from the FlowFile and converted to
<i>com.rabbitmq.client.AMQP.BasicProperties</i> to be sent
+ along with the message. Upon success the incoming FlowFile is transfered
to <i>success</i> Relationship and upon failure FlowFile is
+ penalized and transfered to the <i>failure</i> Relationship.
+</p>
+<h2>Where did my message go?</h2>
+<p>
+ In a typical AMQP exchange model, the message that is sent to an AMQP
Exchange will be routed based on the <i>Routing Key</i>
+ to its final destination in the <i>Queue</i>. It's called <b>Binding</b>.
If due to some misconfiguration the binding between the <i>Exchange, Routing Key
+ and the Queue</i> is not set up, the message will have no final
destination and will return (i.e., the data will not make it to the queue).
+ If that happens you will see a log in both app-log and bulletin stating to
that effect. Fixing the binding (normally done by AMQP administrator)
+ will resolve the issue.
+</p>
+<h2>AMQP Properties</h2>
+<p>
+ Attributes extracted from the FlowFile are considered candidates for
AMQP
+ properties if their names are prefixed with <i>amqp$</i> (e.g.,
amqp$contentType=text/xml). To enrich message with additional AMQP properties
+ you may use <b>UpdateAttribute</b> processor between the source processor
and PublishAMQP processor.
+ The following is the list of available standard AMQP properties:
<i>("amqp$contentType", "amqp$contentEncoding",
+ "amqp$headers", "amqp$deliveryMode", "amqp$priority",
"amqp$correlationId", "amqp$replyTo",
+ "amqp$expiration", "amqp$messageId", "amqp$timestamp",
"amqp$type", "amqp$userId", "amqp$appId",
+ "amqp$clusterId")</i>
+</p>
+<h2>Configuration Details</h2>
+<p>
+ At the time of writing this document it only defines the essential
configuration properties which are suitable for most cases.
+ Other properties will be defined later as this component progresses.
+ Configuring PublishAMQP:
+</p>
+<ol>
+ <li><b>Exchange Name</b> - [OPTIONAL] the name of AMQP exchange the
messages will be sent to. Usually provided by the administrator (e.g.,
'amq.direct')
+ It is an optional property. If kept empty the messages will be sent to a
default AMQP exchange. More on AMQP Exchanges could be found
+ <a href="https://www.rabbitmq.com/tutorials/amqp-concepts.html";>here</a>.
+ </li>
+ <li><b>Routing Key</b> - [REQUIRED] the name of the routing key that will
be used by AMQP to route messages from the exchange to destination queue(s).
+ Usually provided by administrator (e.g., 'myKey')
+ In the event when messages are sent to a default exchange this property
corresponds to a destination queue name, otherwise a binding from the Exchange
to a Queue via
+ Routing Key must be set (usually by the AMQP administrator). More on AMQP
Exchanges and Bindings could be found
+ <a href="https://www.rabbitmq.com/tutorials/amqp-concepts.html";>here</a>.
+ </li>
+ <li><b>Host Name</b> - [REQUIRED] the name of the host where AMQP broker
is running.
+ Usually provided by administrator (e.g., 'myhost.com'). Defaults to
'localhost'.
+ </li>
+ <li><b>Port</b> - [REQUIRED] the port number where AMQP broker is running.
+ Usually provided by the administrator (e.g., '2453'). Defaults to '5672'.
+ </li>
+ <li><b>User Name</b> - [REQUIRED] user name to connect to AMQP broker.
+ Usually provided by the administrator (e.g., 'me'). Defaults to 'guest'.
+ </li>
+ <li><b>Password</b> - [REQUIRED] password to use with user name to connect
to AMQP broker.
+ Usually provided by the administrator. Defaults to 'guest'.
+ </li>
+ <li><b>Virtual Host</b> - [OPTIONAL] Virtual Host name which segregates
AMQP system for enhanced security.
+ Please refer to <a
href="http://blog.dtzq.com/2012/06/rabbitmq-users-and-virtual-hosts.html";>this
blog</a> for more details on Virtual Host.
+ </li>
+
+</ol>
+
+</body>
+</html>
\ No newline at end of file
Added:
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.amqp.processors.PublishAMQP/index.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.amqp.processors.PublishAMQP/index.html?rev=1730777&view=auto
==============================================================================
---
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.amqp.processors.PublishAMQP/index.html
(added)
+++
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.amqp.processors.PublishAMQP/index.html
Wed Feb 17 02:20:53 2016
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta
charset="utf-8"></meta><title>PublishAMQP</title><link rel="stylesheet"
href="../../css/component-usage.css"
type="text/css"></link></head><body><h2>Description: </h2><p>Creates a AMQP
Message from the contents of a FlowFile and sends the message to an AMQP
Exchange.In a typical AMQP exchange model, the message that is sent to the AMQP
Exchange will be routed based on the 'Routing Key' to its final destination in
the queue (the binding). If due to some misconfiguration the binding between
the Exchange, Routing Key and Queue is not set up, the message will have no
final destination and will return (i.e., the data will not make it to the
queue). If that happens you will see a log in both app-log and bulletin stating
to that effect. Fixing the binding (normally done by AMQP administrator) will
resolve the issue.</p><p><a href="additionalDetails.html">Additional
Details...</a></p><h3>Tags: </h3><p>amqp, rabbit, put, message, send,
publish</p><h
3>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>Exchange
Name</strong></td><td id="default-value"></td><td
id="allowable-values"></td><td id="description">The name of the AMQP Exchange
the messages will be sent to. Usually provided by the AMQP administrator (e.g.,
'amq.direct'). It is an optional property. If kept empty the messages will be
sent to a default AMQP exchange.</td></tr><tr><td id="name"><strong>Routing
Key</
strong></td><td id="default-value"></td><td id="allowable-values"></td><td
id="description">The name of the Routing Key that will be used by AMQP to route
messages from the exchange to a destination queue(s). Usually provided by the
administrator (e.g., 'myKey')In the event when messages are sent to a default
exchange this property corresponds to a destination queue name, otherwise a
binding from the Exchange to a Queue via Routing Key must be set (usually by
the AMQP administrator)</td></tr><tr><td id="name"><strong>Host
Name</strong></td><td id="default-value">localhost</td><td
id="allowable-values"></td><td id="description">Network address of AMQP broker
(e.g., localhost)</td></tr><tr><td id="name"><strong>Port</strong></td><td
id="default-value">5672</td><td id="allowable-values"></td><td
id="description">Numeric value identifying Port of AMQP broker (e.g.,
5671)</td></tr><tr><td id="name">Virtual Host</td><td
id="default-value"></td><td id="allowable-values"></td><td id="descri
ption">Virtual Host name which segregates AMQP system for enhanced
security.</td></tr><tr><td id="name"><strong>User Name</strong></td><td
id="default-value">guest</td><td id="allowable-values"></td><td
id="description">User Name used for authentication and
authorization.</td></tr><tr><td id="name"><strong>Password</strong></td><td
id="default-value">guest</td><td id="allowable-values"></td><td
id="description">Password used for authentication and
authorization.<br/><strong>Sensitive Property: true</strong></td></tr><tr><td
id="name"><strong>AMQP Version</strong></td><td
id="default-value">0.9.1</td><td
id="allowable-values"><ul><li>0.9.1</li></ul></td><td id="description">AMQP
Version. Currently only supports AMQP
v0.9.1.</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 sent to the AMQP destination are routed to this
relationship</td></tr><tr><td>failure</td><td>All FlowFiles
that cannot be routed to the AMQP destination are routed 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
Modified:
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.hbase.GetHBase/index.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.hbase.GetHBase/index.html?rev=1730777&r1=1730776&r2=1730777&view=diff
==============================================================================
---
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.hbase.GetHBase/index.html
(original)
+++
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.hbase.GetHBase/index.html
Wed Feb 17 02:20:53 2016
@@ -1 +1 @@
-<!DOCTYPE html><html lang="en"><head><meta
charset="utf-8"></meta><title>GetHBase</title><link rel="stylesheet"
href="../../css/component-usage.css"
type="text/css"></link></head><body><h2>Description: </h2><p>This Processor
polls HBase for any records in the specified table. The processor keeps track
of the timestamp of the cells that it receives, so that as new records are
pushed to HBase, they will automatically be pulled. Each record is output in
JSON format, as {"row": "<row key>", "cells": { "<column 1
family>:<column 1 qualifier>": "<cell 1 value>", "<column 2
family>:<column 2 qualifier>": "<cell 2 value>", ... }}. For
each record received, a Provenance RECEIVE event is emitted with the format
hbase://<table name>/<row key>, where <row key> is the UTF-8
encoded value of the row's key.</p><h3>Tags: </h3><p>hbase, get,
ingest</p><h3>Properties: </h3><p>In the list below, the names of required
properties appear in <str
ong>bold</strong>. Any other properties (not in bold) are considered optional.
The table also indicates any default values.</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>HBase Client
Service</strong></td><td id="default-value"></td><td
id="allowable-values"><strong>Controller Service API:
</strong><br/>HBaseClientService<br/><strong>Implementation:</strong><br/><a
href="../org.apache.nifi.hbase.HBase_1_1_2_ClientService/index.html">HBase_1_1_2_ClientService</a></td><td
id="description">Specifies the Controller Service to use for accessing
HBase.</td></tr><tr><td id="name"><strong>Distributed Cache
Service</strong></td><td id="default-value"></td><td
id="allowable-values"><strong>Controller Service API:
</strong><br/>DistributedMapCacheClient<br/><strong>Implementation:</strong><br/><a
href="../org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService/index.html">Distributed
MapCacheClientService</a></td><td id="description">Specifies the Controller
Service that should be used to maintain state about what has been pulled from
HBase so that if a new node begins pulling data, it won't duplicate all of the
work that has been done.</td></tr><tr><td id="name"><strong>Table
Name</strong></td><td id="default-value"></td><td
id="allowable-values"></td><td id="description">The name of the HBase Table to
put data into</td></tr><tr><td id="name">Columns</td><td
id="default-value"></td><td id="allowable-values"></td><td id="description">A
comma-separated list of "<colFamily>:<colQualifier>" pairs to
return when scanning. To return all columns for a given family, leave off the
qualifier such as "<colFamily1>,<colFamily2>".</td></tr><tr><td
id="name">Filter Expression</td><td id="default-value"></td><td
id="allowable-values"></td><td id="description">An HBase filter expression that
will be applied to the scan. This property can not be used whe
n also using the Columns property.</td></tr><tr><td id="name"><strong>Initial
Time Range</strong></td><td id="default-value">None</td><td
id="allowable-values"><ul><li>None</li><li>Current Time</li></ul></td><td
id="description">The time range to use on the first scan of a table. None will
pull the entire table on the first scan, Current Time will pull entries from
that point forward.</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 which character set
is used to encode the data in HBase</td></tr></table><h3>Relationships:
</h3><table
id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All
FlowFiles are routed to this relationship</td></tr></table><h3>Reads
Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table
id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>hbase.table</td><td>The
name of the HBase table th
at the data was pulled from</td></tr><tr><td>mime.type</td><td>Set to
application/json to indicate that output is JSON</td></tr></table></body></html>
\ No newline at end of file
+<!DOCTYPE html><html lang="en"><head><meta
charset="utf-8"></meta><title>GetHBase</title><link rel="stylesheet"
href="../../css/component-usage.css"
type="text/css"></link></head><body><h2>Description: </h2><p>This Processor
polls HBase for any records in the specified table. The processor keeps track
of the timestamp of the cells that it receives, so that as new records are
pushed to HBase, they will automatically be pulled. Each record is output in
JSON format, as {"row": "<row key>", "cells": { "<column 1
family>:<column 1 qualifier>": "<cell 1 value>", "<column 2
family>:<column 2 qualifier>": "<cell 2 value>", ... }}. For
each record received, a Provenance RECEIVE event is emitted with the format
hbase://<table name>/<row key>, where <row key> is the UTF-8
encoded value of the row's key.</p><h3>Tags: </h3><p>hbase, get,
ingest</p><h3>Properties: </h3><p>In the list below, the names of required
properties appear in <str
ong>bold</strong>. Any other properties (not in bold) are considered optional.
The table also indicates any default values.</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>HBase Client
Service</strong></td><td id="default-value"></td><td
id="allowable-values"><strong>Controller Service API:
</strong><br/>HBaseClientService<br/><strong>Implementation:</strong><br/><a
href="../org.apache.nifi.hbase.HBase_1_1_2_ClientService/index.html">HBase_1_1_2_ClientService</a></td><td
id="description">Specifies the Controller Service to use for accessing
HBase.</td></tr><tr><td id="name">Distributed Cache Service</td><td
id="default-value"></td><td id="allowable-values"><strong>Controller Service
API:
</strong><br/>DistributedMapCacheClient<br/><strong>Implementation:</strong><br/><a
href="../org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService/index.html">DistributedMapCacheClientSer
vice</a></td><td id="description">Specifies the Controller Service that should
be used to maintain state about what has been pulled from HBase so that if a
new node begins pulling data, it won't duplicate all of the work that has been
done.</td></tr><tr><td id="name"><strong>Table Name</strong></td><td
id="default-value"></td><td id="allowable-values"></td><td id="description">The
name of the HBase Table to put data into</td></tr><tr><td
id="name">Columns</td><td id="default-value"></td><td
id="allowable-values"></td><td id="description">A comma-separated list of
"<colFamily>:<colQualifier>" pairs to return when scanning. To
return all columns for a given family, leave off the qualifier such as
"<colFamily1>,<colFamily2>".</td></tr><tr><td id="name">Filter
Expression</td><td id="default-value"></td><td id="allowable-values"></td><td
id="description">An HBase filter expression that will be applied to the scan.
This property can not be used when also using the
Columns property.</td></tr><tr><td id="name"><strong>Initial Time
Range</strong></td><td id="default-value">None</td><td
id="allowable-values"><ul><li>None</li><li>Current Time</li></ul></td><td
id="description">The time range to use on the first scan of a table. None will
pull the entire table on the first scan, Current Time will pull entries from
that point forward.</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 which character set
is used to encode the data in HBase</td></tr></table><h3>Relationships:
</h3><table
id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All
FlowFiles are routed to this relationship</td></tr></table><h3>Reads
Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table
id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>hbase.table</td><td>The
name of the HBase table that the data was p
ulled from</td></tr><tr><td>mime.type</td><td>Set to application/json to
indicate that output is JSON</td></tr></table></body></html>
\ No newline at end of file
Added:
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.credentials.provider.service.AWSCredentialsProviderControllerService/index.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.credentials.provider.service.AWSCredentialsProviderControllerService/index.html?rev=1730777&view=auto
==============================================================================
---
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.credentials.provider.service.AWSCredentialsProviderControllerService/index.html
(added)
+++
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.credentials.provider.service.AWSCredentialsProviderControllerService/index.html
Wed Feb 17 02:20:53 2016
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta
charset="utf-8"></meta><title>AWSCredentialsProviderControllerService</title><link
rel="stylesheet" href="../../css/component-usage.css"
type="text/css"></link></head><body><h2>Description: </h2><p>Defines
credentials for Amazon Web Services processors.</p><h3>Tags: </h3><p>aws,
credentials, provider</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>Defaul
t Value</th><th>Allowable Values</th><th>Description</th></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">No
Description Provided.</td></tr><tr><td id="name">Assume Role ARN</td><td
id="default-value"></td><td id="allowable-values"></td><td id="description">The
AWS Role ARN for cross account access. This is used in conjunction with role
name and session timeout</td></tr><tr><td id="name">Assume Role Session
Name</td><td
id="default-value"></td><td id="allowable-values"></td><td
id="description">The aws role name for cross account access. This is used in
conjunction with role arn and session time out</td></tr><tr><td
id="name">Session Time</td><td id="default-value">3600</td><td
id="allowable-values"></td><td id="description">Session time for role based
session (between 900 and 3600 seconds). This is used in conjunction with role
arn and name</td></tr></table></body></html>
\ No newline at end of file
Modified:
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.s3.DeleteS3Object/index.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.s3.DeleteS3Object/index.html?rev=1730777&r1=1730776&r2=1730777&view=diff
==============================================================================
---
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.s3.DeleteS3Object/index.html
(original)
+++
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.s3.DeleteS3Object/index.html
Wed Feb 17 02:20:53 2016
@@ -1 +1 @@
-<!DOCTYPE html><html lang="en"><head><meta
charset="utf-8"></meta><title>DeleteS3Object</title><link rel="stylesheet"
href="../../css/component-usage.css"
type="text/css"></link></head><body><h2>Description: </h2><p>Deletes FlowFiles
on an Amazon S3 Bucket. If attempting to delete a file that does not exist,
FlowFile is routed to success.</p><h3>Tags: </h3><p>Amazon, S3, AWS, Archive,
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 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>Object
Key</strong></td><td id="default-value">${filename}</td><td
id="allowable-values"></td><td id="description">No Description
Provided.<br/><strong>Supports Expression Language:
true</strong></td></tr><tr><td id="name"><strong>Bucket</strong></td><td
id="default-value"></td><td id="allowable-values"></td><td id="description">No
Description Provided.<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></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></td></tr><tr><td id="name">Credentials File</td><td id="defau
lt-value"></td><td id="allowable-values"></td><td id="description">No
Description Provided.</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-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>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>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">Version</td><td
id="default-value"></td><td id="allowable-values"></td><td id="description">The
Version of the Object to delete<br/><strong>Supports Expression Language:
true</strong></td></tr><tr><td id="name">FullControl User List</td><td
id="default-value">${s3.permissions.full.users}</td><td
id="allowable-values"></td><td id="de
scription">A comma-separated list of Amazon User ID's or E-mail addresses that
specifies who should have Full Control for an object<br/><strong>Supports
Expression Language: true</strong></td></tr><tr><td id="name">Read Permission
User List</td><td id="default-value">${s3.permissions.read.users}</td><td
id="allowable-values"></td><td id="description">A comma-separated list of
Amazon User ID's or E-mail addresses that specifies who should have Read Access
for an object<br/><strong>Supports Expression Language:
true</strong></td></tr><tr><td id="name">Write Permission User List</td><td
id="default-value">${s3.permissions.write.users}</td><td
id="allowable-values"></td><td id="description">A comma-separated list of
Amazon User ID's or E-mail addresses that specifies who should have Write
Access for an object<br/><strong>Supports Expression Language:
true</strong></td></tr><tr><td id="name">Read ACL User List</td><td
id="default-value">${s3.permissions.readacl.users}</td><td id="allowab
le-values"></td><td id="description">A comma-separated list of Amazon User
ID's or E-mail addresses that specifies who should have permissions to read the
Access Control List for an object<br/><strong>Supports Expression Language:
true</strong></td></tr><tr><td id="name">Write ACL User List</td><td
id="default-value">${s3.permissions.writeacl.users}</td><td
id="allowable-values"></td><td id="description">A comma-separated list of
Amazon User ID's or E-mail addresses that specifies who should have permissions
to change the Access Control List for an object<br/><strong>Supports Expression
Language: true</strong></td></tr><tr><td id="name">Owner</td><td
id="default-value">${s3.owner}</td><td id="allowable-values"></td><td
id="description">The Amazon ID to use for the object's
owner<br/><strong>Supports Expression Language: true</strong></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">Specifies an optional SSL Context Service that, if provided,
will be used to create connections</td></tr><tr><td id="name">Endpoint Override
URL</td><td id="default-value"></td><td id="allowable-values"></td><td
id="description">Endpoint URL to use instead of the AWS default including
scheme, host, port, and path. The AWS libraries select an endpoint URL based on
the AWS region, but this property overrides the selected endpoint URL, allowing
use with other S3-compatible endpoints.</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 after being successfully copied to Amazon
S3</td></tr><tr><td>failure</td><td>FlowFiles are routed to failure if unable
to be copied to Amazon S3</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.s3.PutS3Object/index.html">PutS3Object</a>,
> <a
>href="../org.apache.nifi.processors.aws.s3.FetchS3Object/index.html">FetchS3Object</a></p></body></html>
\ No newline at end of file
+<!DOCTYPE html><html lang="en"><head><meta
charset="utf-8"></meta><title>DeleteS3Object</title><link rel="stylesheet"
href="../../css/component-usage.css"
type="text/css"></link></head><body><h2>Description: </h2><p>Deletes FlowFiles
on an Amazon S3 Bucket. If attempting to delete a file that does not exist,
FlowFile is routed to success.</p><h3>Tags: </h3><p>Amazon, S3, AWS, Archive,
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 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>Object
Key</strong></td><td id="default-value">${filename}</td><td
id="allowable-values"></td><td id="description">No Description
Provided.<br/><strong>Supports Expression Language:
true</strong></td></tr><tr><td id="name"><strong>Bucket</strong></td><td
id="default-value"></td><td id="allowable-values"></td><td id="description">No
Description Provided.<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">No Description
Provided.</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-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-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>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>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">Version</td><td
id="default-value"></td><td id="allowable-values"></td><td id="description">The
Version of the Object to delete<br/><strong>Supports Expression Language:
true</strong></td></tr><tr><td id="name">FullControl User List</td><td
id="default-value">${s3.permissions.full.users}</td><td
id="allowable-values"></td><td id="description">A comma-separated list of
Amazon User ID's or E-mail addresses that specifies who should have Full
Control for an object<br/><strong>Supports Expression Language:
true</strong></td></tr><tr><td id="name">Read Permission User List</td><td
id="default-value">${s3.permissions.read.users}</td><td
id="allowable-values"></td><td id="description">A comma-separated list of
Amazon
User ID's or E-mail addresses that specifies who should have Read Access for
an object<br/><strong>Supports Expression Language:
true</strong></td></tr><tr><td id="name">Write Permission User List</td><td
id="default-value">${s3.permissions.write.users}</td><td
id="allowable-values"></td><td id="description">A comma-separated list of
Amazon User ID's or E-mail addresses that specifies who should have Write
Access for an object<br/><strong>Supports Expression Language:
true</strong></td></tr><tr><td id="name">Read ACL User List</td><td
id="default-value">${s3.permissions.readacl.users}</td><td
id="allowable-values"></td><td id="description">A comma-separated list of
Amazon User ID's or E-mail addresses that specifies who should have permissions
to read the Access Control List for an object<br/><strong>Supports Expression
Language: true</strong></td></tr><tr><td id="name">Write ACL User List</td><td
id="default-value">${s3.permissions.writeacl.users}</td><td
id="allowable-values"></td
><td id="description">A comma-separated list of Amazon User ID's or E-mail
>addresses that specifies who should have permissions to change the Access
>Control List for an object<br/><strong>Supports Expression Language:
>true</strong></td></tr><tr><td id="name">Owner</td><td
>id="default-value">${s3.owner}</td><td id="allowable-values"></td><td
>id="description">The Amazon ID to use for the object's
>owner<br/><strong>Supports Expression Language:
>true</strong></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">Specifies an optional SSL Context Service that, if
>provided, will be used to create connections</td></tr><tr><td
>id="name">Endpoint Override URL</td><td id="default-value"></td><td
>id="allowable-values"
></td><td id="description">Endpoint URL to use instead of the AWS default
>including scheme, host, port, and path. The AWS libraries select an endpoint
>URL based on the AWS region, but this property overrides the selected
>endpoint URL, allowing use with other S3-compatible
>endpoints.</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 after being successfully copied to Amazon
>S3</td></tr><tr><td>failure</td><td>FlowFiles are routed to failure if unable
>to be copied to Amazon S3</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.s3.PutS3Object/index.html">PutS3Object</a>,
> <a
>href="../org.apache.nifi.processors.aws.s3.FetchS3Object/index.html">FetchS3Object</a></p></body></html>
\ No newline at end of file
Modified:
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.s3.FetchS3Object/index.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.s3.FetchS3Object/index.html?rev=1730777&r1=1730776&r2=1730777&view=diff
==============================================================================
---
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.s3.FetchS3Object/index.html
(original)
+++
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.s3.FetchS3Object/index.html
Wed Feb 17 02:20:53 2016
@@ -1 +1 @@
-<!DOCTYPE html><html lang="en"><head><meta
charset="utf-8"></meta><title>FetchS3Object</title><link rel="stylesheet"
href="../../css/component-usage.css"
type="text/css"></link></head><body><h2>Description: </h2><p>Retrieves the
contents of an S3 Object and writes it to the content of a
FlowFile</p><h3>Tags: </h3><p>Amazon, S3, AWS, Get, Fetch</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>Defau
lt Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td
id="name"><strong>Bucket</strong></td><td id="default-value"></td><td
id="allowable-values"></td><td id="description">No Description
Provided.<br/><strong>Supports Expression Language:
true</strong></td></tr><tr><td id="name"><strong>Object Key</strong></td><td
id="default-value">${filename}</td><td id="allowable-values"></td><td
id="description">No Description Provided.<br/><strong>Supports Expression
Language: true</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>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-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>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">Access Key</td><td
id="default-value"></td><td id="allowable-values"></td><td id="description">No
Descriptio
n Provided.<br/><strong>Sensitive Property: 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></td></tr><tr><td
id="name">Credentials File</td><td id="default-value"></td><td
id="allowable-values"></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">Version</td><td
id="default-value"></td><td id="allowable-values"></td><td id="description">The
Version of the Object to download<br/><strong>Supports Expression Language:
true</strong></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">Specifies an optional SSL Context Service that, if provided,
will be used to create connections</td></tr><tr><td id="name">Endpoint Override
URL</td><td id="default-value"></td><td id="allowable-values"></td><td
id="description">Endpoint URL to use instead of the AWS default including
scheme, host, port, and path. The AWS libraries select an endpoint URL based on
the AWS region, but this property overrides the selected endpoint URL, allowing
use with other S3-compatible endpoints.</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 after being successfully copied to Amazon
S3</td></tr><tr><td>failure</td><td>FlowFiles are routed to failure if unable
to be copied to Amazon S3</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>s3.bucket</td><td>The
> name of the S3 bucket</td></tr><tr><td>path</td><td>The path of the
>file</td></tr><tr><td>absolute.path</td><td>The path of the
>file</td></tr><tr><td>filename</td><td>The name of the
>file</td></tr><tr><td>hash.value</td><td>The MD5 sum of the
>file</td></tr><tr><td>hash.algorithm</td><td>MD5</td></tr><tr><td>mime.type</td><td>If
> S3 provides the content type/MIME type, this attribute will hold that
>file</td></tr><tr><td>s3.etag</td><td>The ETag that can be used to see if the
>file has changed</td></tr><tr><td>s3.expirationTime</td><td>If the file has
>an expiration date, this attribute will be set, containing the milliseconds
>since epoch in UTC time</td></tr><tr><td>s3.expirationTimeRuleId</td><td>The
>ID of the rule that dictates this object's expiration
>time</td></tr><tr><td>s3.version</td><td>The version of the S3
>object</td></tr></table><h3>See Also:</h3><p><
a
href="../org.apache.nifi.processors.aws.s3.PutS3Object/index.html">PutS3Object</a>,
<a
href="../org.apache.nifi.processors.aws.s3.DeleteS3Object/index.html">DeleteS3Object</a></p></body></html>
\ No newline at end of file
+<!DOCTYPE html><html lang="en"><head><meta
charset="utf-8"></meta><title>FetchS3Object</title><link rel="stylesheet"
href="../../css/component-usage.css"
type="text/css"></link></head><body><h2>Description: </h2><p>Retrieves the
contents of an S3 Object and writes it to the content of a
FlowFile</p><h3>Tags: </h3><p>Amazon, S3, AWS, Get, Fetch</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>Defau
lt Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td
id="name"><strong>Bucket</strong></td><td id="default-value"></td><td
id="allowable-values"></td><td id="description">No Description
Provided.<br/><strong>Supports Expression Language:
true</strong></td></tr><tr><td id="name"><strong>Object Key</strong></td><td
id="default-value">${filename}</td><td id="allowable-values"></td><td
id="description">No Description Provided.<br/><strong>Supports Expression
Language: true</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>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-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>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">Access Key</td><td
id="default-value"></td><td id="allowable-values"></td><td id="description">No
Descriptio
n 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">No
Description Provided.</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 cre
dentials 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">Version</td><td
id="default-value"></td><td id="allowable-values"></td><td id="description">The
Version of the Object to download<br/><strong>Supports Expression Language:
true</strong></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">Specifies an optional SSL Context Service that, if provided,
will be used to create connections</td></tr><tr><td id="name">Endpoint Override
URL</td><td id="default-value"></td><td id="allowable-values"></td><td
id="description">Endpoint URL to use
instead of the AWS default including scheme, host, port, and path. The AWS
libraries select an endpoint URL based on the AWS region, but this property
overrides the selected endpoint URL, allowing use with other S3-compatible
endpoints.</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 after being successfully copied to Amazon
S3</td></tr><tr><td>failure</td><td>FlowFiles are routed to failure if unable
to be copied to Amazon S3</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>s3.bucket</td><td>The
name of the S3 bucket</td></tr><tr><td>path</td><td>The path of the
file</td></tr><tr><td>absolute.path</td><td>The path of the
file</td></tr><tr><td>filename</td><td>The name of the
file</td></tr><tr><td>hash.value</td><td>The MD5 sum of the file</td></tr><t
r><td>hash.algorithm</td><td>MD5</td></tr><tr><td>mime.type</td><td>If S3
provides the content type/MIME type, this attribute will hold that
file</td></tr><tr><td>s3.etag</td><td>The ETag that can be used to see if the
file has changed</td></tr><tr><td>s3.expirationTime</td><td>If the file has an
expiration date, this attribute will be set, containing the milliseconds since
epoch in UTC time</td></tr><tr><td>s3.expirationTimeRuleId</td><td>The ID of
the rule that dictates this object's expiration
time</td></tr><tr><td>s3.version</td><td>The version of the S3
object</td></tr></table><h3>See Also:</h3><p><a
href="../org.apache.nifi.processors.aws.s3.PutS3Object/index.html">PutS3Object</a>,
<a
href="../org.apache.nifi.processors.aws.s3.DeleteS3Object/index.html">DeleteS3Object</a></p></body></html>
\ No newline at end of file
