Author: aldrin
Date: Sun Mar 27 04:51:17 2016
New Revision: 1736720
URL: http://svn.apache.org/viewvc?rev=1736720&view=rev
Log:
NIFI-1634 Updating site to for the 0.6.0 release.
Added:
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.jms.cf.JMSConnectionFactoryProvider/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.jms.cf.JMSConnectionFactoryProvider/additionalDetails.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.jms.cf.JMSConnectionFactoryProvider/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.jms.processors.ConsumeJMS/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.jms.processors.ConsumeJMS/additionalDetails.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.jms.processors.ConsumeJMS/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.jms.processors.PublishJMS/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.jms.processors.PublishJMS/additionalDetails.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.jms.processors.PublishJMS/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.kinesis.firehose.PutKinesisFirehose/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.kinesis.firehose.PutKinesisFirehose/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.lambda.PutLambda/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.lambda.PutLambda/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.cassandra.PutCassandraQL/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.cassandra.PutCassandraQL/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.cassandra.QueryCassandra/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.cassandra.QueryCassandra/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.splunk.GetSplunk/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.splunk.GetSplunk/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.splunk.PutSplunk/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.splunk.PutSplunk/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ListenTCP/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ListenTCP/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.QueryDatabaseTable/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.QueryDatabaseTable/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.spring.SpringContextProcessor/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.spring.SpringContextProcessor/additionalDetails.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.spring.SpringContextProcessor/index.html
Modified:
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.hbase.HBase_1_1_2_ClientService/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.FetchHDFS/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.kafka.PutKafka/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.kite.ConvertAvroSchema/index.html
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.standard.CompressContent/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ControlRate/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.ExtractText/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ListenRELP/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.ListenUDP/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.RouteText/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.SplitText/index.html
nifi/site/trunk/docs/nifi-docs/html/administration-guide.html
nifi/site/trunk/docs/nifi-docs/html/developer-guide.html
nifi/site/trunk/docs/nifi-docs/html/expression-language-guide.html
nifi/site/trunk/docs/nifi-docs/html/getting-started.html
nifi/site/trunk/docs/nifi-docs/html/overview.html
nifi/site/trunk/docs/nifi-docs/html/user-guide.html
nifi/site/trunk/docs/nifi-docs/index.html
nifi/site/trunk/docs/nifi-docs/rest-api/index.html
Modified:
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.hbase.HBase_1_1_2_ClientService/index.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.hbase.HBase_1_1_2_ClientService/index.html?rev=1736720&r1=1736719&r2=1736720&view=diff
==============================================================================
---
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.hbase.HBase_1_1_2_ClientService/index.html
(original)
+++
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.hbase.HBase_1_1_2_ClientService/index.html
Sun Mar 27 04:51:17 2016
@@ -1 +1 @@
-<!DOCTYPE html><html lang="en"><head><meta
charset="utf-8"></meta><title>HBase_1_1_2_ClientService</title><link
rel="stylesheet" href="../../css/component-usage.css"
type="text/css"></link></head><body><h2>Description: </h2><p>Implementation of
HBaseClientService for HBase 1.1.2. This service can be configured by providing
a comma-separated list of configuration files, or by specifying values for the
other properties. If configuration files are provided, they will be loaded
first, and the values of the additional properties will override the values
from the configuration files. In addition, any user defined properties on the
processor will also be passed to the HBase configuration.</p><h3>Tags:
</h3><p>hbase, client</p><h3>Properties: </h3><p>In the list below, the names
of required properties appear in <strong>bold</strong>. Any other properties
(not in bold) are considered optional. The table also indicates any default
values.</p><table id="properties"><tr><th>Name</th><th>Default
Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td
id="name">Hadoop Configuration Files</td><td id="default-value"></td><td
id="allowable-values"></td><td id="description">Comma-separated list of Hadoop
Configuration files, such as hbase-site.xml, including full paths to the
files.</td></tr><tr><td id="name">ZooKeeper Quorum</td><td
id="default-value"></td><td id="allowable-values"></td><td
id="description">Comma-separated list of ZooKeeper hosts for HBase. Required if
Hadoop Configuration Files are not provided.</td></tr><tr><td
id="name">ZooKeeper Client Port</td><td id="default-value"></td><td
id="allowable-values"></td><td id="description">The port on which ZooKeeper is
accepting client connections. Required if Hadoop Configuration Files are not
provided.</td></tr><tr><td id="name">ZooKeeper ZNode Parent</td><td
id="default-value"></td><td id="allowable-values"></td><td id="description">The
ZooKeeper ZNode Parent value for HBase (example: /hbase). Required if H
adoop Configuration Files are not provided.</td></tr><tr><td id="name">HBase
Client Retries</td><td id="default-value">1</td><td
id="allowable-values"></td><td id="description">The number of times the HBase
client will retry connecting. Required if Hadoop Configuration Files are not
provided.</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 an HBase configuration property.</td><td id="value">The
value of the given HBase configuration property.</td><td>These properties will
be set on the HBase configuration after loading any provided configuration
files.</td></tr></table></p></body></html>
\ No newline at end of file
+<!DOCTYPE html><html lang="en"><head><meta
charset="utf-8"></meta><title>HBase_1_1_2_ClientService</title><link
rel="stylesheet" href="../../css/component-usage.css"
type="text/css"></link></head><body><h2>Description: </h2><p>Implementation of
HBaseClientService for HBase 1.1.2. This service can be configured by providing
a comma-separated list of configuration files, or by specifying values for the
other properties. If configuration files are provided, they will be loaded
first, and the values of the additional properties will override the values
from the configuration files. In addition, any user defined properties on the
processor will also be passed to the HBase configuration.</p><h3>Tags:
</h3><p>hbase, client</p><h3>Properties: </h3><p>In the list below, the names
of required properties appear in <strong>bold</strong>. Any other properties
(not in bold) are considered optional. The table also indicates any default
values.</p><table id="properties"><tr><th>Name</th><th>Default
Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td
id="name">Hadoop Configuration Files</td><td id="default-value"></td><td
id="allowable-values"></td><td id="description">Comma-separated list of Hadoop
Configuration files, such as hbase-site.xml and core-site.xml for kerberos,
including full paths to the files.</td></tr><tr><td id="name">Kerberos
Principal</td><td id="default-value"></td><td id="allowable-values"></td><td
id="description">Kerberos principal to authenticate as. Requires
nifi.kerberos.krb5.file to be set in your nifi.properties</td></tr><tr><td
id="name">Kerberos Keytab</td><td id="default-value"></td><td
id="allowable-values"></td><td id="description">Kerberos keytab associated with
the principal. Requires nifi.kerberos.krb5.file to be set in your
nifi.properties</td></tr><tr><td id="name">ZooKeeper Quorum</td><td
id="default-value"></td><td id="allowable-values"></td><td
id="description">Comma-separated list of ZooKeeper hosts for HBase. Required
if Hadoop Configuration Files are not provided.</td></tr><tr><td
id="name">ZooKeeper Client Port</td><td id="default-value"></td><td
id="allowable-values"></td><td id="description">The port on which ZooKeeper is
accepting client connections. Required if Hadoop Configuration Files are not
provided.</td></tr><tr><td id="name">ZooKeeper ZNode Parent</td><td
id="default-value"></td><td id="allowable-values"></td><td id="description">The
ZooKeeper ZNode Parent value for HBase (example: /hbase). Required if Hadoop
Configuration Files are not provided.</td></tr><tr><td id="name">HBase Client
Retries</td><td id="default-value">1</td><td id="allowable-values"></td><td
id="description">The number of times the HBase client will retry connecting.
Required if Hadoop Configuration Files are not
provided.</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 an HBase configuration
property.</td><td id="value">The value of the given HBase configuration
property.</td><td>These properties will be set on the HBase configuration after
loading any provided configuration files.</td></tr></table></p></body></html>
\ No newline at end of file
Added:
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.jms.cf.JMSConnectionFactoryProvider/additionalDetails.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.jms.cf.JMSConnectionFactoryProvider/additionalDetails.html?rev=1736720&view=auto
==============================================================================
---
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.jms.cf.JMSConnectionFactoryProvider/additionalDetails.html
(added)
+++
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.jms.cf.JMSConnectionFactoryProvider/additionalDetails.html
Sun Mar 27 04:51:17 2016
@@ -0,0 +1,56 @@
+<!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>JMSConnectionFactoryProvider</title>
+ <link rel="stylesheet" href="../../css/component-usage.css"
type="text/css" />
+ </head>
+
+ <body>
+ <h2>Description:</h2>
+ <p>
+ This ControllerService serves as a general factory service to
serving vendor specific
+ instances of the <i>javax.jms.ConnectionFactory</i>. It does so by
allowing user to
+ configure vendor specific properties as well as point to the
location of the vendor
+ provided JMS client libraries so the correct implementation of the
<i>javax.jms.ConnectionFactory</i>
+ can be found, loaded, instantiated and served to the dependent
Processors (see PublishJMS, ConsumeJMS).
+ </p>
+ <p>
+ To accommodate variety of JMS vendors and their implementation of
the <i>ConnectionFactory</i>
+ this ControllerService exposes only 3 static configuration
properties that are common across many implementations
+ of the <i>ConnectionFactory</i>. The rest of the configuration
properties are set following
+ <a
href="http://docstore.mik.ua/orelly/java-ent/jnut/ch06_02.htm";>Java Beans</a>
convention (see below).
+ </p>
+ <p>
+ The 3 static configuration properties are:
+ <ul>
+ <li><b>MQ ConnectionFactory Implementation</b> - A fully
qualified name of the JMS ConnectionFactory implementation
+ class (i.e.,
org.apache.activemq.ActiveMQConnectionFactory)</li>
+ <li><b>MQ Client Libraries path</b> - Path to the directory with
additional resources (i.e., JARs, configuration files etc.) to be added
+ to the classpath. Such
resources typically represent target MQ client libraries for the
ConnectionFactory
+ implementation. It is
optional if you are using Apache ActiveMQ since its libraries are distributed
with this component.</li>
+ <li><b>Broker URI</b> - URI pointing to the network location of the
JMS Message broker. For example, 'tcp://myhost:61616' for ActiveMQ or simply
'myhost:1414'.</li>
+ </ul>
+ The rest of the properties are set as Dynamic Properties following <a
href="http://docstore.mik.ua/orelly/java-ent/jnut/ch06_02.htm";>Java Beans</a>
+ convention where a property name is derived from the <i>set*</i>
method of the vendor specific ConnectionFactory's implementation.
+ For example,
<i>com.ibm.mq.jms.MQConnectionFactory.setChannel(String)</i> would imply
'channel' property and
+ <i>com.ibm.mq.jms.MQConnectionFactory.setTransportType(int)</i> would
imply 'transportType' property.
+ For the list of available properties please consult vendor provided
documentation. Here is an example for
+ <a
href="https://www-01.ibm.com/support/knowledgecenter/SSFKSJ_8.0.0/com.ibm.mq.javadoc.doc/WMQJMSClasses/com/ibm/mq/jms/MQQueueConnectionFactory.html";>IBM's
com.ibm.mq.jms.MQConnectionFactory</a>
+ </p>
+ </body>
+</html>
Added:
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.jms.cf.JMSConnectionFactoryProvider/index.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.jms.cf.JMSConnectionFactoryProvider/index.html?rev=1736720&view=auto
==============================================================================
---
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.jms.cf.JMSConnectionFactoryProvider/index.html
(added)
+++
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.jms.cf.JMSConnectionFactoryProvider/index.html
Sun Mar 27 04:51:17 2016
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta
charset="utf-8"></meta><title>JMSConnectionFactoryProvider</title><link
rel="stylesheet" href="../../css/component-usage.css"
type="text/css"></link></head><body><h2>Description: </h2><p>Provides a generic
service to create vendor specific javax.jms.ConnectionFactory implementations.
ConnectionFactory can be served once this service is configured
successfully</p><p><a href="additionalDetails.html">Additional
Details...</a></p><h3>Tags: </h3><p>jms, messaging, integration, queue, topic,
publish, subscribe</p><h3>Properties: </h3><p>In the list below, the names of
required properties appear in <strong>bold</strong>. Any other properties (not
in bold) are considered optional. The table also indicates any default
values.</p><table id="properties"><tr><th>Name</th><th>Default
Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td
id="name"><strong>MQ ConnectionFactory Implementation</strong></td><td
id="default-value"></td><td id="a
llowable-values"></td><td id="description">A fully qualified name of the JMS
ConnectionFactory implementation class (i.e.,
org.apache.activemq.ActiveMQConnectionFactory)</td></tr><tr><td
id="name"><strong>MQ Client Libraries path (i.e.,
/usr/jms/lib)</strong></td><td id="default-value"></td><td
id="allowable-values"></td><td id="description">Path to the directory with
additional resources (i.e., JARs, configuration files etc.) to be added to the
classpath. Such resources typically represent target MQ client libraries for
the ConnectionFactory implementation.</td></tr><tr><td id="name"><strong>Broker
URI</strong></td><td id="default-value"></td><td id="allowable-values"></td><td
id="description">URI pointing to the network location of the JMS Message
broker. For example, 'tcp://myhost:61616' for ActiveMQ or 'myhost:1414' for IBM
MQ</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/>SSL
ContextService<br/><strong>Implementation:</strong><br/><a
href="../org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td
id="description">The SSL Context Service used to provide client certificate
information for TLS/SSL connections.</td></tr></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 Connection Factory configuration property.</td><td
id="value">The value of a given Connection Factory configuration
property.</td><td>The properties that are set following Java Beans convention
where a property name is derived from the 'set*' method of the vendor specific
ConnectionFactory's implementation. For example,
'com.ibm.mq.jms.MQConnectionFactory.setChannel(String)' would imply 'channel'
property and 'com.ibm.mq.jms.MQConnectionFactory.setTransportType(int
)' would imply 'transportType' property.</td></tr></table></p><h3>See
Also:</h3><p><a
href="../org.apache.nifi.jms.processors.ConsumeJMS/index.html">ConsumeJMS</a>,
<a
href="../org.apache.nifi.jms.processors.PublishJMS/index.html">PublishJMS</a></p></body></html>
\ No newline at end of file
Added:
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.jms.processors.ConsumeJMS/additionalDetails.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.jms.processors.ConsumeJMS/additionalDetails.html?rev=1736720&view=auto
==============================================================================
---
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.jms.processors.ConsumeJMS/additionalDetails.html
(added)
+++
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.jms.processors.ConsumeJMS/additionalDetails.html
Sun Mar 27 04:51:17 2016
@@ -0,0 +1,61 @@
+<!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>ConsumeJMS</title>
+ <link rel="stylesheet" href="../../css/component-usage.css"
type="text/css" />
+</head>
+
+<body>
+<h2>Summary</h2>
+<p>
+ This processor consumes messages from JMS compliant messaging system and
converts them to a FlowFile to be routed to the next component in the flow.
+</p>
+<p>
+ This processor does two things. It constructs FlowFile by extracting
information from the consumed JMS message including body, standard
+ <a
href="http://docs.spring.io/spring-integration/api/org/springframework/integration/jms/JmsHeaders.html";>JMS
Headers</a> and Properties.
+ The message body is written to a FlowFile while standard JMS Headers and
Properties are set as FlowFile attributes.
+</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 ConsumeJMS:
+</p>
+<ol>
+ <li><b>User Name</b> - [OPTIONAL] User Name used for authentication and
authorization when this processor obtains <i>javax.jms.Connection</i>
+ from the pre-configured <i>javax.jms.ConnectionFactory</i> (see below).
+ </li>
+ <li><b>Password</b> - [OPTIONAL] Password used in conjunction with <b>User
Name</b>.
+ </li>
+ <li><b>Destination Name</b> - [REQUIRED] the name of the
<i>javax.jms.Destination</i>.
+ Usually provided by administrator (e.g., 'topic://myTopic').
+ </li>
+ <li><b>Destination Type</b> - [OPTIONAL] the type of the
<i>javax.jms.Destination</i>. Could be one of 'QUEUE' or 'TOPIC'
+ Usually provided by the administrator. Defaults to 'TOPIC'.
+ </li>
+ <li><b>Session Cache size</b> - [OPTIONAL] Specify the desired size for
the JMS Session cache (per JMS Session type). This cache
+ size is the maximum limit for the number of cached Sessions.
+ Usually provided by the administrator (e.g., '2453'). Defaults to '1'.
+ </li>
+ <li><b>Connection Factory Service</b> - [REQUIRED] link to a
pre-configured instance of org.apache.nifi.jms.cf.JMSConnectionFactoryProvider.
+ </li>
+</ol>
+
+</body>
+</html>
\ No newline at end of file
Added:
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.jms.processors.ConsumeJMS/index.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.jms.processors.ConsumeJMS/index.html?rev=1736720&view=auto
==============================================================================
---
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.jms.processors.ConsumeJMS/index.html
(added)
+++
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.jms.processors.ConsumeJMS/index.html
Sun Mar 27 04:51:17 2016
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta
charset="utf-8"></meta><title>ConsumeJMS</title><link rel="stylesheet"
href="../../css/component-usage.css"
type="text/css"></link></head><body><h2>Description: </h2><p>Consumes JMS
Message of type BytesMessage or TextMessage 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>jms, 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">User Name</td><td
id="default-value"></td><td id="allowable-values"></td><td
id="description">User Name used for authentication and
authorization.</td></tr><tr><td id="name">Password</td><td
id="default-value"></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>Destination Name</strong></td><td id="default-value"></td><td
id="allowable-values"></td><td id="description">The name of the JMS
Destination. Usually provided by the administrator (e.g.,
'topic://myTopic').</td></tr><tr><td id="name"><strong>Destination
Type</strong></td><td id="default-value">QUEUE</td><td
id="allowable-values"><ul><li>QUEUE</li><li>TOPIC</li></ul></td><td
id="description">The type of the JMS Destination. Could be one of 'QUEUE' or
'TOPIC'. Usually provided by the administra
tor. Defaults to 'TOPIC</td></tr><tr><td id="name"><strong>Session Cache
size</strong></td><td id="default-value">1</td><td
id="allowable-values"></td><td id="description">The maximum limit for the
number of cached Sessions.</td></tr><tr><td id="name"><strong>Connection
Factory Service</strong></td><td id="default-value"></td><td
id="allowable-values"><strong>Controller Service API:
</strong><br/>JMSConnectionFactoryProviderDefinition<br/><strong>Implementation:</strong><br/><a
href="../org.apache.nifi.jms.cf.JMSConnectionFactoryProvider/index.html">JMSConnectionFactoryProvider</a></td><td
id="description">The Controller Service that is used to obtain
ConnectionFactory</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 JMS Destination are routed to this
relationship</td></tr></table><h3>Reads Attributes: </h3>None
specified.<h3>Writes Attributes: </h3>None speci
fied.<h3>See Also:</h3><p><a
href="../org.apache.nifi.jms.processors.PublishJMS/index.html">PublishJMS</a>,
<a
href="../org.apache.nifi.jms.cf.JMSConnectionFactoryProvider/index.html">JMSConnectionFactoryProvider</a></p></body></html>
\ No newline at end of file
Added:
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.jms.processors.PublishJMS/additionalDetails.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.jms.processors.PublishJMS/additionalDetails.html?rev=1736720&view=auto
==============================================================================
---
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.jms.processors.PublishJMS/additionalDetails.html
(added)
+++
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.jms.processors.PublishJMS/additionalDetails.html
Sun Mar 27 04:51:17 2016
@@ -0,0 +1,64 @@
+<!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>PublishJMS</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 a JMS
compliant messaging system.
+</p>
+<p>
+ This processor does two things. It constructs JMS Message by extracting
FlowFile contents (both body and attributes).
+ Once message is constructed it is sent to a pre-configured JMS Destination.
+ Standard <a
href="http://docs.spring.io/spring-integration/api/org/springframework/integration/jms/JmsHeaders.html";>JMS
Headers</a>
+ will be extracted from the FlowFile and set on <i>javax.jms.Message</i> as
JMS headers while other
+ FlowFile attributes will be set as properties of <i>javax.jms.Message</i>.
Upon success the incoming FlowFile is transfered
+ to the <i>success</i> Relationship and upon failure FlowFile is
+ penalized and transfered to the <i>failure</i> Relationship.
+</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 PublishJMS:
+</p>
+<ol>
+ <li><b>User Name</b> - [OPTIONAL] User Name used for authentication and
authorization when this processor obtains <i>javax.jms.Connection</i>
+ from the pre-configured <i>javax.jms.ConnectionFactory</i> (see below).
+ </li>
+ <li><b>Password</b> - [OPTIONAL] Password used in conjunction with <b>User
Name</b>.
+ </li>
+ <li><b>Destination Name</b> - [REQUIRED] the name of the
<i>javax.jms.Destination</i>.
+ Usually provided by administrator (e.g., 'topic://myTopic').
+ </li>
+ <li><b>Destination Type</b> - [OPTIONAL] the type of the
<i>javax.jms.Destination</i>. Could be one of 'QUEUE' or 'TOPIC'
+ Usually provided by the administrator. Defaults to 'TOPIC'.
+ </li>
+ <li><b>Session Cache size</b> - [OPTIONAL] Specify the desired size for
the JMS Session cache (per JMS Session type). This cache
+ size is the maximum limit for the number of cached Sessions.
+ Usually provided by the administrator (e.g., '2453'). Defaults to '1'.
+ </li>
+ <li><b>Connection Factory Service</b> - [REQUIRED] link to a
pre-configured instance of org.apache.nifi.jms.cf.JMSConnectionFactoryProvider.
+ </li>
+</ol>
+
+</body>
+</html>
\ No newline at end of file
Added:
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.jms.processors.PublishJMS/index.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.jms.processors.PublishJMS/index.html?rev=1736720&view=auto
==============================================================================
---
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.jms.processors.PublishJMS/index.html
(added)
+++
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.jms.processors.PublishJMS/index.html
Sun Mar 27 04:51:17 2016
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta
charset="utf-8"></meta><title>PublishJMS</title><link rel="stylesheet"
href="../../css/component-usage.css"
type="text/css"></link></head><body><h2>Description: </h2><p>Creates a JMS
Message from the contents of a FlowFile and sends it to a JMS Destination
(queue or topic) as JMS BytesMessage.</p><p><a
href="additionalDetails.html">Additional Details...</a></p><h3>Tags:
</h3><p>jms, put, message, send, 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, 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">User Name</td><td id="default-value"></td><td
id="allowable-values"></td><td id="description">User Name used for
authentication and authorization.</td></tr><tr><td id="name">Password</td><td
id="default-value"></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>Destination Name</strong></td><td id="default-value"></td><td
id="allowable-values"></td><td id="description">The name of the JMS
Destination. Usually provided by the administrator (e.g.,
'topic://myTopic').</td></tr><tr><td id="name"><strong>Destination
Type</strong></td><td id="default-value">QUEUE</td><td
id="allowable-values"><ul><li>QUEUE</li><li>TOPIC</li></ul></td><td
id="description">The type of the JMS Destination. Could be one of 'QUEUE' or
'TOPIC'. Usually provided by the administrator. Defaults to 'TOP
IC</td></tr><tr><td id="name"><strong>Session Cache size</strong></td><td
id="default-value">1</td><td id="allowable-values"></td><td
id="description">The maximum limit for the number of cached
Sessions.</td></tr><tr><td id="name"><strong>Connection Factory
Service</strong></td><td id="default-value"></td><td
id="allowable-values"><strong>Controller Service API:
</strong><br/>JMSConnectionFactoryProviderDefinition<br/><strong>Implementation:</strong><br/><a
href="../org.apache.nifi.jms.cf.JMSConnectionFactoryProvider/index.html">JMSConnectionFactoryProvider</a></td><td
id="description">The Controller Service that is used to obtain
ConnectionFactory</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 JMS destination are routed to this
relationship</td></tr><tr><td>failure</td><td>All FlowFiles that cannot be sent
to JMS destination are routed to this relationship</td></
tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes:
</h3>None specified.<h3>See Also:</h3><p><a
href="../org.apache.nifi.jms.processors.ConsumeJMS/index.html">ConsumeJMS</a>,
<a
href="../org.apache.nifi.jms.cf.JMSConnectionFactoryProvider/index.html">JMSConnectionFactoryProvider</a></p></body></html>
\ No newline at end of file
Added:
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.kinesis.firehose.PutKinesisFirehose/index.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.kinesis.firehose.PutKinesisFirehose/index.html?rev=1736720&view=auto
==============================================================================
---
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.kinesis.firehose.PutKinesisFirehose/index.html
(added)
+++
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.kinesis.firehose.PutKinesisFirehose/index.html
Sun Mar 27 04:51:17 2016
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta
charset="utf-8"></meta><title>PutKinesisFirehose</title><link rel="stylesheet"
href="../../css/component-usage.css"
type="text/css"></link></head><body><h2>Description: </h2><p>Sends the contents
to a specified Amazon Kinesis Firehose. In order to send data to firehose, the
firehose delivery stream name has to be specified.</p><h3>Tags: </h3><p>amazon,
aws, firehose, kinesis, put, stream</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>Amazon Kinesis
>Firehose Delivery Stream Name</strong></td><td id="default-value"></td><td
>id="allowable-values"></td><td id="description">The name of kinesis firehose
>delivery stream</td></tr><tr><td id="name">Batch Size</td><td
>id="default-value">250</td><td id="allowable-values"></td><td
>id="description">Batch size for messages (1-500).</td></tr><tr><td
>id="name">Max message buffer size</td><td id="default-value">1 MB</td><td
>id="allowable-values"></td><td id="description">Max message
>buffer</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 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>Communications
Timeout</strong></td><td id="default-value">30 secs</td><td
id="allowable-values"></td><td id="description">No Description
Provided.</td></tr><tr><td id="name">Proxy Host</td><td
id="default-value"></td><td id="allowable-values"></td><td
id="description">Proxy host name or IP<br/><strong>Supports Expression
Language: true</strong></td></tr><tr><td id="name">Proxy Host Port</td><td
id="default-value"></td><td id="allowable-values"></td><td
id="description">Proxy host port<br/><strong>Supports Expression Language:
true</strong></td></tr></table><h3>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 a
re routed to 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>aws.kinesis.firehose.error.message</td><td>Error
message on posting message to AWS Kinesis
Firehose</td></tr><tr><td>aws.kinesis.firehose.error.code</td><td>Error code
for the message when posting to AWS Kinesis
Firehose</td></tr><tr><td>aws.kinesis.firehose.record.id</td><td>Record id of
the message posted to Kinesis Firehose</td></tr></table></body></html>
\ No newline at end of file
Added:
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.lambda.PutLambda/index.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.lambda.PutLambda/index.html?rev=1736720&view=auto
==============================================================================
---
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.lambda.PutLambda/index.html
(added)
+++
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.lambda.PutLambda/index.html
Sun Mar 27 04:51:17 2016
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta
charset="utf-8"></meta><title>PutLambda</title><link rel="stylesheet"
href="../../css/component-usage.css"
type="text/css"></link></head><body><h2>Description: </h2><p>Sends the contents
to a specified Amazon Lamba Function. The AWS credentials used for
authentication must have permissions execute the Lambda function
(lambda:InvokeFunction).The FlowFile content must be JSON.</p><h3>Tags:
</h3><p>amazon, aws, lambda, put</p><h3>Properties: </h3><p>In the list below,
the names of required properties appear in <strong>bold</strong>. Any other
properties (not in bold) are considered optional. The table also indicates any
default values, 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>Amazon Lambda
Name</strong></td><td id="default-value"></td><td
id="allowable-values"></td><td id="description">The Lambda Function
Name</td></tr><tr><td id="name"><strong>Amazon Lambda Qualifier
(version)</strong></td><td id="default-value">$LATEST</td><td
id="allowable-values"></td><td id="description">The Lambda Function
Version</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 <i
mg 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-valu
es"></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 Contro
ller 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></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><table
id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>aws.lambda.result.function.error</td><td>Function
error message in result on posting message to AWS
Lambda</td></tr><tr><td>aws.lambda.result.status.code</td><td>Status code in
the result for the message when posting to AWS
Lambda</td></tr><tr><td>aws.lambda.result.payload</td><td>Payload in the result
from AWS Lambda</td></tr><
tr><td>aws.lambda.result.log</td><td>Log in the result of the message posted
to Lambda</td></tr><tr><td>aws.lambda.exception.message</td><td>Exception
message on invoking from AWS
Lambda</td></tr><tr><td>aws.lambda.exception.cause</td><td>Exception cause on
invoking from AWS
Lambda</td></tr><tr><td>aws.lambda.exception.error.code</td><td>Exception error
code on invoking from AWS
Lambda</td></tr><tr><td>aws.lambda.exception.request.id</td><td>Exception
request id on invoking from AWS
Lambda</td></tr><tr><td>aws.lambda.exception.status.code</td><td>Exception
status code on invoking from AWS
Lambda</td></tr><tr><td>aws.lambda.exception.error.type</td><td>Exception error
type on invoking from AWS Lambda</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=1736720&r1=1736719&r2=1736720&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
Sun Mar 27 04:51:17 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><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
+<!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><tr><td id="name">Proxy Host</td><td
>id="default-value"></td><td id="allowable-values"></td><td
>id="description">Proxy host name or IP<br/><strong>Supports Expression
>Language: true</strong></td></tr><tr><td id="name">Proxy Host Port</td><td
>id="default-value"></td><td id="allowable-values"></td><td
>id="description">Proxy host port<br/><strong>Supports Expression Language:
>true</strong></td></tr></table><h3>Relationships: </h3><table
>id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>FlowFiles
> are routed to success
>relationship</td></tr><tr><td>failure</td><td>FlowFiles are routed to failure
>relationship</td></tr></table><h3>Reads Attributes: </h3>None specified
.<h3>Writes Attributes: </h3>None specified.<h3>See Also:</h3><p><a
href="../org.apache.nifi.processors.aws.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=1736720&r1=1736719&r2=1736720&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
Sun Mar 27 04:51:17 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><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
+<!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><tr><td id="name">Proxy Host</td><td
id="default-value"></td><td id="allowable-values"></td><td
id="description">Proxy host name or IP<br/><strong>Supports Expression
Language: true</strong></td></tr><tr><td id="name">Proxy Host Port</td><td
id="default-value"></td><td id="allowable-values"></td><td
id="description">Proxy host port<br/><strong>Supports Expression Language:
true</strong></td></tr></table><h3>Relationships: </h3><table
id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>FlowFiles
are routed to success relationship</td></tr><tr><td>failure</td><td>FlowFiles
are routed to 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>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
