You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nifi.apache.org by jo...@apache.org on 2015/12/12 01:55:23 UTC
svn commit: r1719609 [1/12] - in /nifi/site/trunk/docs/nifi-docs: ./
components/org.apache.nifi.couchbase.CouchbaseClusterService/
components/org.apache.nifi.hbase.GetHBase/
components/org.apache.nifi.hbase.HBase_1_1_2_ClientService/
components/org.apa...
Author: joewitt
Date: Sat Dec 12 00:55:22 2015
New Revision: 1719609
URL: http://svn.apache.org/viewvc?rev=1719609&view=rev
Log:
NIFI-1122
Added:
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.couchbase.CouchbaseClusterService/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.couchbase.CouchbaseClusterService/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.hbase.GetHBase/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.hbase.GetHBase/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.hbase.HBase_1_1_2_ClientService/
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.hbase.PutHBaseCell/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.hbase.PutHBaseCell/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.hbase.PutHBaseJSON/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.hbase.PutHBaseJSON/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.avro.ExtractAvroMetadata/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.avro.ExtractAvroMetadata/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.avro.SplitAvro/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.avro.SplitAvro/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.s3.DeleteS3Object/
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.azure.eventhub.GetAzureEventHub/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.azure.eventhub.GetAzureEventHub/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.azure.eventhub.PutAzureEventHub/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.azure.eventhub.PutAzureEventHub/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.couchbase.GetCouchbaseKey/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.couchbase.GetCouchbaseKey/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.couchbase.PutCouchbaseKey/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.couchbase.PutCouchbaseKey/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.AttributesToJSON/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.AttributesToJSON/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.FetchFile/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.FetchFile/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.FetchSFTP/
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.ListFile/
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.ListSFTP/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ListSFTP/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ListenSyslog/
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.ParseSyslog/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ParseSyslog/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.PutDistributedMapCache/
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/
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/
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.TailFile/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.TailFile/index.html
nifi/site/trunk/docs/nifi-docs/html/asciidoc-mod.css
nifi/site/trunk/docs/nifi-docs/html/images/anonymous-access.png (with props)
nifi/site/trunk/docs/nifi-docs/html/images/login.png (with props)
nifi/site/trunk/docs/nifi-docs/html/images/nifi-connection-menu.png (with props)
nifi/site/trunk/docs/nifi-docs/html/images/nifi-connection.png (with props)
nifi/site/trunk/docs/nifi-docs/html/images/nifi-process-group-menu.png (with props)
nifi/site/trunk/docs/nifi-docs/html/images/nifi-processor-menu.png (with props)
nifi/site/trunk/docs/nifi-docs/html/images/nifi-rpg-menu.png (with props)
nifi/site/trunk/docs/nifi-docs/html/images/request-access.png (with props)
Modified:
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.attributes.UpdateAttribute/additionalDetails.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.attributes.UpdateAttribute/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.avro.ConvertAvroToJSON/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.sqs.GetSQS/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.hadoop.CreateHadoopSequenceFile/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.GetHDFS/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.hadoop.GetHDFSSequenceFile/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.hadoop.PutHDFS/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.kafka.GetKafka/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.standard.ConvertCharacterSet/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.EncryptContent/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ExecuteProcess/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ExecuteSQL/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ExecuteStreamCommand/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.GetFTP/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.GetFile/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.GetJMSQueue/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.GetJMSTopic/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.GetSFTP/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.ListenHTTP/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.LogAttribute/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.PutFTP/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.PutFile/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.PutJMS/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.PutSFTP/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ReplaceText/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/images/add-processor.png
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
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.couchbase.CouchbaseClusterService/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.couchbase.CouchbaseClusterService/index.html?rev=1719609&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.couchbase.CouchbaseClusterService/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.couchbase.CouchbaseClusterService/index.html Sat Dec 12 00:55:22 2015
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>CouchbaseClusterService</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Provides a centralized Couchbase connection and bucket passwords management. Bucket passwords can be specified via dynamic properties.</p><h3>Tags: </h3><p>nosql, couchbase, database, connection</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>Connection String</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The hostnames or ip addresses of the bootstraping nodes and optional parameters. Syntax) couchbase://node1,n
ode2,nodeN?param1=value1&param2=value2&paramN=valueN</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">Bucket Password for BUCKET_NAME</td><td id="value">bucket password</td><td>Specify bucket password if neseccery.</td></tr></table></p></body></html>
\ No newline at end of file
Added: 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=1719609&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.hbase.GetHBase/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.hbase.GetHBase/index.html Sat Dec 12 00:55:22 2015
@@ -0,0 +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
Added: 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=1719609&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.hbase.HBase_1_1_2_ClientService/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.hbase.HBase_1_1_2_ClientService/index.html Sat Dec 12 00:55:22 2015
@@ -0,0 +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
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.hbase.PutHBaseCell/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.hbase.PutHBaseCell/index.html?rev=1719609&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.hbase.PutHBaseCell/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.hbase.PutHBaseCell/index.html Sat Dec 12 00:55:22 2015
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutHBaseCell</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Adds the Contents of a FlowFile to HBase as the value of a single cell</p><h3>Tags: </h3><p>hadoop, hbase</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>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>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<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Row Identifier</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specifies the Row ID to use when inserting data into HBase<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Column Family</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Column Family to use when inserting data into HBase<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Column Qualifier</strong></td><td id="default-
value"></td><td id="allowable-values"></td><td id="description">The Column Qualifier to use when inserting data into HBase<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Batch Size</strong></td><td id="default-value">25</td><td id="allowable-values"></td><td id="description">The maximum number of FlowFiles to process in a single execution. The FlowFiles will be grouped by table, and a single Put per table will be performed.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>A FlowFile is routed to this relationship after it has been successfully stored in HBase</td></tr><tr><td>failure</td><td>A FlowFile is routed to this relationship if it cannot be sent to HBase</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.hbase.PutHBaseJSON/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.hbase.PutHBaseJSON/index.html?rev=1719609&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.hbase.PutHBaseJSON/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.hbase.PutHBaseJSON/index.html Sat Dec 12 00:55:22 2015
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutHBaseJSON</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Adds rows to HBase based on the contents of incoming JSON documents. Each FlowFile must contain a single UTF-8 encoded JSON document, and any FlowFiles where the root element is not a single document will be routed to failure. Each JSON field name and value will become a column qualifier and value of the HBase row. Any fields with a null value will be skipped, and fields with a complex value will be handled according to the Complex Field Strategy. The row id can be specified either directly on the processor through the Row Identifier property, or can be extracted from the JSON document by specifying the Row Identifier Field Name property. This processor will hold the contents of all FlowFiles for the given batch in memory at one time.</p><h3>Tags: </h3><p>hadoop, hbase, pu
t, json</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, 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>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>Table Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="descr
iption">The name of the HBase Table to put data into<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Row Identifier</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specifies the Row ID to use when inserting data into HBase<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Row Identifier Field Name</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specifies the name of a JSON element whose value should be used as the row id for the given JSON document.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Column Family</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Column Family to use when inserting data into HBase<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Batch Size</strong></td><td id="default-value">25</td><td
id="allowable-values"></td><td id="description">The maximum number of FlowFiles to process in a single execution. The FlowFiles will be grouped by table, and a single Put per table will be performed.</td></tr><tr><td id="name"><strong>Complex Field Strategy</strong></td><td id="default-value">Text</td><td id="allowable-values"><ul><li>Fail <img src="../../html/images/iconInfo.png" alt="Route entire FlowFile to failure if any elements contain complex values." title="Route entire FlowFile to failure if any elements contain complex values."></img></li><li>Warn <img src="../../html/images/iconInfo.png" alt="Provide a warning and do not include field in row sent to HBase." title="Provide a warning and do not include field in row sent to HBase."></img></li><li>Ignore <img src="../../html/images/iconInfo.png" alt="Silently ignore and do not include in row sent to HBase." title="Silently ignore and do not include in row sent to HBase."></img></li><li>Text <img src="../../html/images/iconInf
o.png" alt="Use the string representation of the complex field as the value of the given column." title="Use the string representation of the complex field as the value of the given column."></img></li></ul></td><td id="description">Indicates how to handle complex fields, i.e. fields that do not have a single text value.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>A FlowFile is routed to this relationship after it has been successfully stored in HBase</td></tr><tr><td>failure</td><td>A FlowFile is routed to this relationship if it cannot be sent to HBase</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.processors.attributes.UpdateAttribute/additionalDetails.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.attributes.UpdateAttribute/additionalDetails.html?rev=1719609&r1=1719608&r2=1719609&view=diff
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.attributes.UpdateAttribute/additionalDetails.html (original)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.attributes.UpdateAttribute/additionalDetails.html Sat Dec 12 00:55:22 2015
@@ -26,9 +26,10 @@
<h2>Description:</h2>
<p>
This processor updates the attributes of a FlowFile using properties or rules that are added by the user.
- There are two ways to use this processor to add or modify attributes. One way is the "Basic Usage"; this allows you to set default attribute changes that affect
+ There are three ways to use this processor to add or modify attributes. One way is the "Basic Usage"; this allows you to set default attribute changes that affect
every FlowFile going through the processor. The second way is the "Advanced Usage"; this allows you to make conditional attribute changes that only affect a FlowFile if it
- meets certain conditions. It is possible to use both methods in the same processor at the same time.
+ meets certain conditions. It is possible to use both methods in the same processor at the same time. The third way is the "Delete Attributes Expression"; this allows you to
+ provide a regular expression and any attributes with a matching name will be deleted.
</p>
<p>
@@ -189,6 +190,26 @@
a type of "else" construct. In other words, if none of the rules match for the attribute, then the basic usage changes will be made.
</p>
+ <p><strong>Deleting Attributes</strong></p>
+
+ <p>
+ Deleting attributes is a simple as providing a regular expression for attribute names to be deleted. This can be a simple regular expression that will
+ match a single attribute or more complex regular expression to match a group of similarly named attributes or even seveal individual attribute names.
+ </p>
+ <ul>
+ <li><strong>lastUser</strong> - will delete an attribute with the name "lastUser".
+ </li>
+ <li><strong>user.*</strong> - will delete attributes beginning with "user", including for example "username, "userName", "userID", and "users". But
+ it will not delete "User" or "localuser".
+ </li>
+ <li><strong>(user.*|host.*|.*Date)</strong> - will delete "user", "username", "userName", "hostInfo", "hosts", and "updateDate", but not "User", "HOST", "update", or "updatedate".
+ </li>
+ </ul>
+
+ <p>
+ The delete attributes function does not produce a Provenance Event if the <strong>alternate.identified</strong> Attribute is deleted.
+ </p>
+
<p><strong>FlowFile Policy</strong>
</p>
Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.attributes.UpdateAttribute/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.attributes.UpdateAttribute/index.html?rev=1719609&r1=1719608&r2=1719609&view=diff
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.attributes.UpdateAttribute/index.html (original)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.attributes.UpdateAttribute/index.html Sat Dec 12 00:55:22 2015
@@ -1 +1 @@
-<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>UpdateAttribute</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Updates the Attributes for a FlowFile by using the Attribute Expression Language</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>attributes, modification, update, Attribute Expression Language</p><h3>Properties: </h3><p>This component has no required or optional properties.</p><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">A FlowFile attribute to update</td><td id="value">The value to set it to</td><td>Updates a FlowFile attribute specified by the Dynamic Property's key with the value specified by the Dynamic Property's value<br/><strong>Supports Expression Langu
age: true</strong></td></tr></table></p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>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>See additional details</td><td>This processor may write zero or more attributes as described in additional details</td></tr></table></body></html>
\ No newline at end of file
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>UpdateAttribute</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Updates the Attributes for a FlowFile by using the Attribute Expression Language and/or deletes the attributes based on a regular expression</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>attributes, modification, update, delete, Attribute Expression Language</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">Delete Attrib
utes Expression</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Regular expression for attributes to be deleted from flowfiles.<br/><strong>Supports Expression Language: true</strong></td></tr></table><h3>Dynamic Properties: </h3><p>Dynamic Properties allow the user to specify both the name and value of a property.<table id="dynamic-properties"><tr><th>Name</th><th>Value</th><th>Description</th></tr><tr><td id="name">A FlowFile attribute to update</td><td id="value">The value to set it to</td><td>Updates a FlowFile attribute specified by the Dynamic Property's key with the value specified by the Dynamic Property's value<br/><strong>Supports Expression Language: true</strong></td></tr></table></p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>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>See additional details</td><td>This processor may write or remove zero or more attributes as described in additional details</td></tr></table></body></html>
\ No newline at end of file
Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.avro.ConvertAvroToJSON/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.avro.ConvertAvroToJSON/index.html?rev=1719609&r1=1719608&r2=1719609&view=diff
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.avro.ConvertAvroToJSON/index.html (original)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.avro.ConvertAvroToJSON/index.html Sat Dec 12 00:55:22 2015
@@ -1 +1 @@
-<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ConvertAvroToJSON</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Converts a Binary Avro record into a JSON object. This processor provides a direct mapping of an Avro field to a JSON field, such that the resulting JSON will have the same hierarchical structure as the Avro document. Note that the Avro schema information will be lost, as this is not a translation from binary Avro to JSON formatted Avro. The output JSON is encoded the UTF-8 encoding. If an incoming FlowFile contains a stream of multiple Avro records, the resultant FlowFile will contain a JSON Array containing all of the Avro records.</p><h3>Tags: </h3><p>json, avro, binary</p><h3>Properties: </h3><p>This component has no required or optional properties.</p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><
td>A FlowFile is routed to this relationship after it has been converted to JSON</td></tr><tr><td>failure</td><td>A FlowFile is routed to this relationship if it cannot be parsed as Avro or cannot be converted to JSON for any reason</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>mime.type</td><td>Sets the mime type to application/json</td></tr></table></body></html>
\ No newline at end of file
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ConvertAvroToJSON</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Converts a Binary Avro record into a JSON object. This processor provides a direct mapping of an Avro field to a JSON field, such that the resulting JSON will have the same hierarchical structure as the Avro document. Note that the Avro schema information will be lost, as this is not a translation from binary Avro to JSON formatted Avro. The output JSON is encoded the UTF-8 encoding. If an incoming FlowFile contains a stream of multiple Avro records, the resultant FlowFile will contain a JSON Array containing all of the Avro records or a sequence of JSON Objects. If an incoming FlowFile does not contain any records, an empty JSON object is the output. Empty/Single Avro record FlowFile inputs are optionally wrapped in a container as dictated by 'Wrap Single Record'</p
><h3>Tags: </h3><p>avro, convert, json</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>JSON container options</strong></td><td id="default-value">array</td><td id="allowable-values"><ul><li>none</li><li>array</li></ul></td><td id="description">Determines how stream of records is exposed: either as a sequence of single Objects (none) (i.e. writing every Object to a new line), or as an array of Objects (array).</td></tr><tr><td id="name"><strong>Wrap Single Record</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Determines if the resulting output for empty records or a single record should be wrap
ped in a container array as specified by 'JSON container options'</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>A FlowFile is routed to this relationship after it has been converted to JSON</td></tr><tr><td>failure</td><td>A FlowFile is routed to this relationship if it cannot be parsed as Avro or cannot be converted to JSON for any reason</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>mime.type</td><td>Sets the mime type to application/json</td></tr></table></body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.avro.ExtractAvroMetadata/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.avro.ExtractAvroMetadata/index.html?rev=1719609&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.avro.ExtractAvroMetadata/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.avro.ExtractAvroMetadata/index.html Sat Dec 12 00:55:22 2015
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ExtractAvroMetadata</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Extracts metadata from the header of an Avro datafile.</p><h3>Tags: </h3><p>avro, schema, metadata</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>Fingerprint Algorithm</strong></td><td id="default-value">CRC-64-AVRO</td><td id="allowable-values"><ul><li>CRC-64-AVRO</li><li>MD5</li><li>SHA-256</li></ul></td><td id="description">The algorithm used to generate the schema fingerprint. Available choices are based on the Avro recommended practices for fingerprint gen
eration.</td></tr><tr><td id="name">Metadata Keys</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A comma-separated list of keys indicating key/value pairs to extract from the Avro file header. The key 'avro.schema' can be used to extract the full schema in JSON format, and 'avro.codec' can be used to extract the codec name if one exists.</td></tr><tr><td id="name"><strong>Count Items</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If true the number of items in the datafile will be counted and stored in a FlowFile attribute 'item.count'. The counting is done by reading blocks and getting the number of items for each block, thus avoiding de-serializing. The items being counted will be the top-level items in the datafile. For example, with a schema of type record the items will be the records, and for a schema of type Array the items will be the arrays (not the nu
mber of entries in each array).</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>A FlowFile is routed to this relationship after metadata has been extracted.</td></tr><tr><td>failure</td><td>A FlowFile is routed to this relationship if it cannot be parsed as Avro or metadata cannot be extracted for any reason</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>schema.type</td><td>The type of the schema (i.e. record, enum, etc.).</td></tr><tr><td>schema.name</td><td>Contains the name when the type is a record, enum or fixed, otherwise contains the name of the primitive type.</td></tr><tr><td>schema.fingerprint</td><td>The result of the Fingerprint Algorithm as a Hex string.</td></tr><tr><td>item.count</td><td>The total number of items in the datafile, only written if Count Items is set to
true.</td></tr></table></body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.avro.SplitAvro/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.avro.SplitAvro/index.html?rev=1719609&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.avro.SplitAvro/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.avro.SplitAvro/index.html Sat Dec 12 00:55:22 2015
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>SplitAvro</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Splits a binary encoded Avro datafile into smaller files based on the configured Output Size. The Output Strategy determines if the smaller files will be Avro datafiles, or bare Avro records with metadata in the FlowFile attributes. The output will always be binary encoded.</p><h3>Tags: </h3><p>avro, split</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>Split Strategy</strong></td><td id="default-value">Record</td><td id="allowable-values"><ul><li>Record <img src="../../h
tml/images/iconInfo.png" alt="Split at Record boundaries" title="Split at Record boundaries"></img></li></ul></td><td id="description">The strategy for splitting the incoming datafile. The Record strategy will read the incoming datafile by de-serializing each record.</td></tr><tr><td id="name"><strong>Output Size</strong></td><td id="default-value">1</td><td id="allowable-values"></td><td id="description">The number of Avro records to include per split file. In cases where the incoming file has less records than the Output Size, or when the total number of records does not divide evenly by the Output Size, it is possible to get a split file with less records.</td></tr><tr><td id="name"><strong>Output Strategy</strong></td><td id="default-value">Datafile</td><td id="allowable-values"><ul><li>Datafile <img src="../../html/images/iconInfo.png" alt="Avro's object container file format" title="Avro's object container file format"></img></li><li>Bare Record <img src="../../html/images/ico
nInfo.png" alt="Bare Avro records" title="Bare Avro records"></img></li></ul></td><td id="description">Determines the format of the output. Either Avro Datafile, or bare record. Bare record output is only intended for use with systems that already require it, and shouldn't be needed for normal use.</td></tr><tr><td id="name"><strong>Transfer Metadata</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Whether or not to transfer metadata from the parent datafile to the children. If the Output Strategy is Bare Record, then the metadata will be stored as FlowFile attributes, otherwise it will be in the Datafile header.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>failure</td><td>If a FlowFile fails processing for any reason (for example, the FlowFile is not valid Avro), it will be routed to this relationship</td></tr><tr><td>original</
td><td>The original FlowFile that was split. If the FlowFile fails processing, nothing will be sent to this relationship</td></tr><tr><td>split</td><td>All new files split from the original FlowFile will be 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.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=1719609&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.s3.DeleteS3Object/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.s3.DeleteS3Object/index.html Sat Dec 12 00:55:22 2015
@@ -0,0 +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
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=1719609&r1=1719608&r2=1719609&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 Sat Dec 12 00:55:22 2015
@@ -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></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></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></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
Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.s3.PutS3Object/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.s3.PutS3Object/index.html?rev=1719609&r1=1719608&r2=1719609&view=diff
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.s3.PutS3Object/index.html (original)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.s3.PutS3Object/index.html Sat Dec 12 00:55:22 2015
@@ -1 +1 @@
-<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutS3Object</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Puts FlowFiles to an Amazon S3 Bucket</p><h3>Tags: </h3><p>Amazon, S3, AWS, Archive, 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>De
scription</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="default-value"></td><td id="allowable-values"></td><td id="description">No Description Provided.</
td></tr><tr><td id="name"><strong>Storage Class</strong></td><td id="default-value">Standard</td><td id="allowable-values"><ul><li>Standard</li><li>ReducedRedundancy</li></ul></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 <im
g 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">Expiration Time Rule</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">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: tr
ue</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></tabl
e><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 User-Defined Metadata field to add to the S3 Object</td><td id="value">The value of a User-Defined Metadata field to add to the S3 Object</td><td>Allows user-defined metadata to be added to the S3 object as key/value pairs<br/><strong>Supports Expression Language: true</strong></td></tr></table></p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>FlowFiles are routed to success 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><table id="reads-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>filename</td><td>Uses the FlowFile's filenam
e as the filename for the S3 object</td></tr></table><h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>s3.version</td><td>The version of the S3 Object that was put to S3</td></tr><tr><td>s3.etag</td><td>The ETag of the S3 Object</td></tr><tr><td>s3.expiration</td><td>A human-readable form of the expiration date of the S3 object, if one is set</td></tr></table><h3>See Also:</h3><p><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>PutS3Object</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Puts FlowFiles to an Amazon S3 Bucket</p><h3>Tags: </h3><p>Amazon, S3, AWS, Archive, 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>De
scription</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="default-value"></td><td id="allowable-values"></td><td id="description">No Description Provided.</
td></tr><tr><td id="name"><strong>Storage Class</strong></td><td id="default-value">Standard</td><td id="allowable-values"><ul><li>Standard</li><li>ReducedRedundancy</li></ul></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 <im
g 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">Expiration Time Rule</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">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: tr
ue</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><t
d 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>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 User-Defined Metadata field to add to the S3 Object</td><td id="value">The value of a User-Defined Metadata field to add to the S3 Object</td><td>Allows user-defined metadata to be added to the S3 object as key/value pairs<br/><strong>Supports Expression Language: true</strong></td></tr></table></p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>FlowFiles are routed to success 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><table id="reads-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>filename</td><td>Uses the FlowFile's filename as the filename for the S3 object</td></tr></table><h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>s3.bucket</td><
td>The S3 bucket where the Object was put in S3</td></tr><tr><td>s3.key</td><td>The S3 key within where the Object was put in S3</td></tr><tr><td>s3.version</td><td>The version of the S3 Object that was put to S3</td></tr><tr><td>s3.etag</td><td>The ETag of the S3 Object</td></tr><tr><td>s3.expiration</td><td>A human-readable form of the expiration date of the S3 object, if one is set</td></tr><tr><td>s3.uploadId</td><td>The uploadId used to upload the Object to S3</td></tr><tr><td>s3.usermetadata</td><td>A human-readable form of the User Metadata of the S3 object, if any was set</td></tr></table><h3>See Also:</h3><p><a href="../org.apache.nifi.processors.aws.s3.FetchS3Object/index.html">FetchS3Object</a>, <a href="../org.apache.nifi.processors.aws.s3.DeleteS3Object/index.html">DeleteS3Object</a></p></body></html>
\ No newline at end of file