Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.hadoop.FetchHDFS/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.hadoop.FetchHDFS/index.html?rev=1736720&r1=1736719&r2=1736720&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.hadoop.FetchHDFS/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.hadoop.FetchHDFS/index.html Sun Mar 27 04:51:17 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>FetchHDFS</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Retrieves a file from HDFS. The content of the incoming FlowFile is replaced by the content of the file in HDFS. The file in HDFS is left intact without any changes being made to it.</p><h3>Tags: </h3><p>hadoop, hdfs, get, ingest, fetch, source</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">Hadoop Configuration Resources</td><td id="default-value"></td><td id="al lowable-values"></td><td id="description">A file or comma separated list of files which contains the Hadoop file system configuration. Without this, Hadoop will search the classpath for a 'core-site.xml' and 'hdfs-site.xml' file or will revert to a default configuration.</td></tr><tr><td id="name"><strong>HDFS Filename</strong></td><td id="default-value">${path}/${filename}</td><td id="allowable-values"></td><td id="description">The name of the HDFS file to retrieve<br/><strong>Supports Expression Language: true</strong></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.prop erties</td></tr><tr><td id="name">Kerberos Relogin Period</td><td id="default-value">4 hours</td><td id="allowable-values"></td><td id="description">Period of time which should pass before attempting a kerberos relogin</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>FlowFiles will be routed to this relationship once they have been updated with the content of the HDFS file</td></tr><tr><td>comms.failure</td><td>FlowFiles will be routed to this relationship if the content of the HDFS file cannot be retrieve due to a communications failure. This generally indicates that the Fetch should be tried again.</td></tr><tr><td>failure</td><td>FlowFiles will be routed to this relationship if the content of the HDFS file cannot be retrieved and trying again will likely not be helpful. This would occur, for instance, if the file is not found or if there is a permissions issue</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>hdfs.failure.reason</td><td>When a FlowFile is routed to 'failure', this attribute is added indicating why the file could not be fetched from HDFS</td></tr></table><h3>See Also:</h3><p><a href="../org.apache.nifi.processors.hadoop.ListHDFS/index.html">ListHDFS</a>, <a href="../org.apache.nifi.processors.hadoop.GetHDFS/index.html">GetHDFS</a>, <a href="../org.apache.nifi.processors.hadoop.PutHDFS/index.html">PutHDFS</a></p></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>FetchHDFS</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Retrieves a file from HDFS. The content of the incoming FlowFile is replaced by the content of the file in HDFS. The file in HDFS is left intact without any changes being made to it.</p><h3>Tags: </h3><p>hadoop, hdfs, get, ingest, fetch, source</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">Hadoop Configuration Resources</td><td id="default-value"></td><td id="al lowable-values"></td><td id="description">A file or comma separated list of files which contains the Hadoop file system configuration. Without this, Hadoop will search the classpath for a 'core-site.xml' and 'hdfs-site.xml' file or will revert to a default configuration.</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">Kerberos Relogin Period</td><td id="default-value">4 hours</td><td id="allowable-values"></td><td id="description">Period of time which should pass before attempting a kerberos relogin</td></tr><tr><td id="name"><strong>H DFS Filename</strong></td><td id="default-value">${path}/${filename}</td><td id="allowable-values"></td><td id="description">The name of the HDFS file to retrieve<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 will be routed to this relationship once they have been updated with the content of the HDFS file</td></tr><tr><td>comms.failure</td><td>FlowFiles will be routed to this relationship if the content of the HDFS file cannot be retrieve due to a communications failure. This generally indicates that the Fetch should be tried again.</td></tr><tr><td>failure</td><td>FlowFiles will be routed to this relationship if the content of the HDFS file cannot be retrieved and trying again will likely not be helpful. This would occur, for instance, if the file is not found or if there is a permissions issue</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>hdfs.failure.reason</td><td>When a FlowFile is routed to 'failure', this attribute is added indicating why the file could not be fetched from HDFS</td></tr></table><h3>See Also:</h3><p><a href="../org.apache.nifi.processors.hadoop.ListHDFS/index.html">ListHDFS</a>, <a href="../org.apache.nifi.processors.hadoop.GetHDFS/index.html">GetHDFS</a>, <a href="../org.apache.nifi.processors.hadoop.PutHDFS/index.html">PutHDFS</a></p></body></html> \ No newline at end of file
Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.hadoop.ListHDFS/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.hadoop.ListHDFS/index.html?rev=1736720&r1=1736719&r2=1736720&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.hadoop.ListHDFS/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.hadoop.ListHDFS/index.html Sun Mar 27 04:51:17 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ListHDFS</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Retrieves a listing of files from HDFS. For each file that is listed in HDFS, creates a FlowFile that represents the HDFS file so that it can be fetched in conjunction with ListHDFS. This Processor is designed to run on Primary Node only in a cluster. If the primary node changes, the new Primary Node will pick up where the previous node left off without duplicating all of the data. Unlike GetHDFS, this Processor does not delete any data from HDFS.</p><h3>Tags: </h3><p>hadoop, HDFS, get, list, ingest, source, filesystem</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><t h>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name">Hadoop Configuration Resources</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A file or comma separated list of files which contains the Hadoop file system configuration. Without this, Hadoop will search the classpath for a 'core-site.xml' and 'hdfs-site.xml' file or will revert to a default configuration.</td></tr><tr><td id="name">Distributed Cache Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>DistributedMapCacheClient<br/><strong>Implementation:</strong><br/><a href="../org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService/index.html">DistributedMapCacheClientService</a></td><td id="description">Specifies the Controller Service that should be used to maintain state about what has been pulled from HDFS 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>Directory</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The HDFS directory from which files should be read</td></tr><tr><td id="name"><strong>Recurse Subdirectories</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Indicates whether to list files from subdirectories of the HDFS directory</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">Kerberos Relo gin Period</td><td id="default-value">4 hours</td><td id="allowable-values"></td><td id="description">Period of time which should pass before attempting a kerberos relogin</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 transferred to this relationship</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>filename</td><td>The name of the file that was read from HDFS.</td></tr><tr><td>path</td><td>The path is set to the absolute path of the file's directory on HDFS. For example, if the Directory property is set to /tmp, then files picked up from /tmp will have the path attribute set to "./". If the Recurse Subdirectories property is set to true and a file is picked up from /tmp/abc/1/2/3, then the path attribute will be set to "/tmp/abc/1/2/3".</td></tr><tr><td>hdfs.owner </td><td>The user that owns the file in HDFS</td></tr><tr><td>hdfs.group</td><td>The group that owns the file in HDFS</td></tr><tr><td>hdfs.lastModified</td><td>The timestamp of when the file in HDFS was last modified, as milliseconds since midnight Jan 1, 1970 UTC</td></tr><tr><td>hdfs.length</td><td>The number of bytes in the file in HDFS</td></tr><tr><td>hdfs.replication</td><td>The number of HDFS replicas for hte file</td></tr><tr><td>hdfs.permissions</td><td>The permissions for the file in HDFS. This is formatted as 3 characters for the owner, 3 for the group, and 3 for other users. For example rw-rw-r--</td></tr></table><h3>See Also:</h3><p><a href="../org.apache.nifi.processors.hadoop.GetHDFS/index.html">GetHDFS</a>, <a href="../org.apache.nifi.processors.hadoop.FetchHDFS/index.html">FetchHDFS</a>, <a href="../org.apache.nifi.processors.hadoop.PutHDFS/index.html">PutHDFS</a></p></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ListHDFS</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Retrieves a listing of files from HDFS. For each file that is listed in HDFS, creates a FlowFile that represents the HDFS file so that it can be fetched in conjunction with ListHDFS. This Processor is designed to run on Primary Node only in a cluster. If the primary node changes, the new Primary Node will pick up where the previous node left off without duplicating all of the data. Unlike GetHDFS, this Processor does not delete any data from HDFS.</p><h3>Tags: </h3><p>hadoop, HDFS, get, list, ingest, source, filesystem</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><t h>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name">Hadoop Configuration Resources</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A file or comma separated list of files which contains the Hadoop file system configuration. Without this, Hadoop will search the classpath for a 'core-site.xml' and 'hdfs-site.xml' file or will revert to a default configuration.</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">Kerberos Relogin Period</td><td id="default-value">4 hours</ td><td id="allowable-values"></td><td id="description">Period of time which should pass before attempting a kerberos relogin</td></tr><tr><td id="name">Distributed Cache Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>DistributedMapCacheClient<br/><strong>Implementation:</strong><br/><a href="../org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService/index.html">DistributedMapCacheClientService</a></td><td id="description">Specifies the Controller Service that should be used to maintain state about what has been pulled from HDFS 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>Directory</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The HDFS directory from which files should be read</td></tr><tr><td id="name"><strong>Recurse Subdirectories</strong></td><td id="default-value" >true</td><td >id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td >id="description">Indicates whether to list files from subdirectories of the >HDFS directory</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 transferred to this relationship</td></tr></table><h3>Reads >Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table >id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>filename</td><td>The > name of the file that was read from HDFS.</td></tr><tr><td>path</td><td>The >path is set to the absolute path of the file's directory on HDFS. For >example, if the Directory property is set to /tmp, then files picked up from >/tmp will have the path attribute set to "./". If the Recurse Subdirectories >property is set to true and a file is picked up from /tmp/abc/1/2/3, then the >path attribute will be set to "/tmp/abc/1/2/3".</td></tr><tr><td>hdfs.owner </td><td>The user that owns the file in HDFS</td></tr><tr><td>hdfs.group</td><td>The group that owns the file in HDFS</td></tr><tr><td>hdfs.lastModified</td><td>The timestamp of when the file in HDFS was last modified, as milliseconds since midnight Jan 1, 1970 UTC</td></tr><tr><td>hdfs.length</td><td>The number of bytes in the file in HDFS</td></tr><tr><td>hdfs.replication</td><td>The number of HDFS replicas for hte file</td></tr><tr><td>hdfs.permissions</td><td>The permissions for the file in HDFS. This is formatted as 3 characters for the owner, 3 for the group, and 3 for other users. For example rw-rw-r--</td></tr></table><h3>See Also:</h3><p><a href="../org.apache.nifi.processors.hadoop.GetHDFS/index.html">GetHDFS</a>, <a href="../org.apache.nifi.processors.hadoop.FetchHDFS/index.html">FetchHDFS</a>, <a href="../org.apache.nifi.processors.hadoop.PutHDFS/index.html">PutHDFS</a></p></body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.kafka.PutKafka/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.kafka.PutKafka/index.html?rev=1736720&r1=1736719&r2=1736720&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.kafka.PutKafka/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.kafka.PutKafka/index.html Sun Mar 27 04:51:17 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutKafka</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Sends the contents of a FlowFile as a message to Apache Kafka. The messages to send may be individual FlowFiles or may be delimited, using a user-specified delimiter, such as a new-line.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>Apache, Kafka, Put, Send, Message, PubSub</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, 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"><str ong>Known Brokers</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A comma-separated list of known Kafka Brokers in the format <host>:<port></td></tr><tr><td id="name"><strong>Topic Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Kafka Topic of interest<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Partition Strategy</strong></td><td id="default-value">Round Robin</td><td id="allowable-values"><ul><li>Round Robin <img src="../../html/images/iconInfo.png" alt="Messages will be assigned partitions in a round-robin fashion, sending the first message to Partition 1, the next Partition to Partition 2, and so on, wrapping as necessary." title="Messages will be assigned partitions in a round-robin fashion, sending the first message to Partition 1, the next Partition to Partition 2, and so on, wrapping as necessary."></img></li><li>Random <img src="../../html/images/iconInfo.png" alt="Messages will be assigned to random partitions." title="Messages will be assigned to random partitions."></img></li><li>User-Defined <img src="../../html/images/iconInfo.png" alt="The <Partition> property will be used to determine the partition. All messages within the same FlowFile will be assigned to the same partition." title="The <Partition> property will be used to determine the partition. All messages within the same FlowFile will be assigned to the same partition."></img></li></ul></td><td id="description">Specifies how messages should be partitioned when sent to Kafka</td></tr><tr><td id="name">Partition</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specifies which Kafka Partition to add the message to. If using a message delimiter, all messages in the same FlowFile will be sent to the same partition. If a partition is specified but is not valid, then all messages within the sam e FlowFile will use the same partition but it remains undefined which partition is used.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Kafka Key</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Key to use for the Message<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Delivery Guarantee</strong></td><td id="default-value">0</td><td id="allowable-values"><ul><li>Best Effort <img src="../../html/images/iconInfo.png" alt="FlowFile will be routed to success after successfully writing the content to a Kafka node, without waiting for a response. This provides the best performance but may result in data loss." title="FlowFile will be routed to success after successfully writing the content to a Kafka node, without waiting for a response. This provides the best performance but may result in data loss."></img></li><li>Guarantee Single Node Delivery <img src="../../html/image s/iconInfo.png" alt="FlowFile will be routed to success if the message is received by a single Kafka node, whether or not it is replicated. This is faster than <Guarantee Replicated Delivery> but can result in data loss if a Kafka node crashes" title="FlowFile will be routed to success if the message is received by a single Kafka node, whether or not it is replicated. This is faster than <Guarantee Replicated Delivery> but can result in data loss if a Kafka node crashes"></img></li><li>Guarantee Replicated Delivery <img src="../../html/images/iconInfo.png" alt="FlowFile will be routed to failure unless the message is replicated to the appropriate number of Kafka Nodes according to the Topic configuration" title="FlowFile will be routed to failure unless the message is replicated to the appropriate number of Kafka Nodes according to the Topic configuration"></img></li></ul></td><td id="description">Specifies the requirement for guaranteeing that a message is sent to Kafka </td></tr><tr><td id="name">Message Delimiter</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specifies the delimiter to use for splitting apart multiple messages within a single FlowFile. If not specified, the entire content of the FlowFile will be used as a single message. If specified, the contents of the FlowFile will be split on this delimiter and each section sent as a separate Kafka message. Note that if messages are delimited and some messages for a given FlowFile are transferred successfully while others are not, the messages will be split into individual FlowFiles, such that those messages that were successfully sent are routed to the 'success' relationship while other messages are sent to the 'failure' relationship.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Max Buffer Size</strong></td><td id="default-value">5 MB</td><td id="allowable-values"></td><td id="description">The maximum amount o f data to buffer in memory before sending to Kafka</td></tr><tr><td id="name"><strong>Max Record Size</strong></td><td id="default-value">1 MB</td><td id="allowable-values"></td><td id="description">The maximum size that any individual record can be.</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">The amount of time to wait for a response from Kafka before determining that there is a communications error</td></tr><tr><td id="name"><strong>Batch Size</strong></td><td id="default-value">200</td><td id="allowable-values"></td><td id="description">The number of messages to send in one batch. The producer will wait until either this number of messages are ready to send or "Queue Buffering Max Time" is reached.</td></tr><tr><td id="name"><strong>Queue Buffering Max Time</strong></td><td id="default-value">5 secs</td><td id="allowable-values"></td><td id="description">Maximum time to buffer data before sending to Kafka. For example a setting of 100 ms will try to batch together 100 milliseconds' worth of messages to send at once. This will improve throughput but adds message delivery latency due to the buffering.</td></tr><tr><td id="name"><strong>Compression Codec</strong></td><td id="default-value">none</td><td id="allowable-values"><ul><li>None <img src="../../html/images/iconInfo.png" alt="Compression will not be used for any topic." title="Compression will not be used for any topic."></img></li><li>GZIP <img src="../../html/images/iconInfo.png" alt="Compress messages using GZIP" title="Compress messages using GZIP"></img></li><li>Snappy <img src="../../html/images/iconInfo.png" alt="Compress messages using Snappy" title="Compress messages using Snappy"></img></li></ul></td><td id="description">This parameter allows you to specify the compression codec for all data generated by this producer.</td></tr><tr><td id="name"><strong>Client Name</strong></td><td id="default-value">NiFi-mock-processor</td><td id="allowable-values"></td><td id="description">Client Name to use when communicating with Kafka</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 Kafka configuration property.</td><td id="value">The value of a given Kafka configuration property.</td><td>These properties will be added on the Kafka configuration after loading any provided configuration properties. In the event a dynamic property represents a property that was already set as part of the static properties, its value wil be overriden with warning message describing the override. For the list of available Kafka properties please refer to: http://kafka.apache.org/documentation.html#configuration.</td></tr></table></p><h3>Relationships: </h3><table id="relationships"><tr><th>Nam e</th><th>Description</th></tr><tr><td>success</td><td>Any FlowFile that is successfully sent to Kafka will be routed to this Relationship</td></tr><tr><td>failure</td><td>Any FlowFile that cannot be sent to Kafka 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 +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutKafka</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Sends the contents of a FlowFile as a message to Apache Kafka. The messages to send may be individual FlowFiles or may be delimited, using a user-specified delimiter, such as a new-line.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>Apache, Kafka, Put, Send, Message, PubSub</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, 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"><str ong>Known Brokers</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A comma-separated list of known Kafka Brokers in the format <host>:<port></td></tr><tr><td id="name"><strong>Topic Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Kafka Topic of interest<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Partition Strategy</strong></td><td id="default-value">Round Robin</td><td id="allowable-values"><ul><li>Round Robin <img src="../../html/images/iconInfo.png" alt="Messages will be assigned partitions in a round-robin fashion, sending the first message to Partition 1, the next Partition to Partition 2, and so on, wrapping as necessary." title="Messages will be assigned partitions in a round-robin fashion, sending the first message to Partition 1, the next Partition to Partition 2, and so on, wrapping as necessary."></img></li><li>Random <img src="../../html/images/iconInfo.png" alt="Messages will be assigned to random partitions." title="Messages will be assigned to random partitions."></img></li><li>User-Defined <img src="../../html/images/iconInfo.png" alt="The <Partition> property will be used to determine the partition. All messages within the same FlowFile will be assigned to the same partition." title="The <Partition> property will be used to determine the partition. All messages within the same FlowFile will be assigned to the same partition."></img></li></ul></td><td id="description">Specifies how messages should be partitioned when sent to Kafka</td></tr><tr><td id="name">Partition</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specifies which Kafka Partition to add the message to. If using a message delimiter, all messages in the same FlowFile will be sent to the same partition. If a partition is specified but is not valid, then all messages within the sam e FlowFile will use the same partition but it remains undefined which partition is used.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Kafka Key</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Key to use for the Message<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Delivery Guarantee</strong></td><td id="default-value">0</td><td id="allowable-values"><ul><li>Best Effort <img src="../../html/images/iconInfo.png" alt="FlowFile will be routed to success after successfully writing the content to a Kafka node, without waiting for a response. This provides the best performance but may result in data loss." title="FlowFile will be routed to success after successfully writing the content to a Kafka node, without waiting for a response. This provides the best performance but may result in data loss."></img></li><li>Guarantee Single Node Delivery <img src="../../html/image s/iconInfo.png" alt="FlowFile will be routed to success if the message is received by a single Kafka node, whether or not it is replicated. This is faster than <Guarantee Replicated Delivery> but can result in data loss if a Kafka node crashes" title="FlowFile will be routed to success if the message is received by a single Kafka node, whether or not it is replicated. This is faster than <Guarantee Replicated Delivery> but can result in data loss if a Kafka node crashes"></img></li><li>Guarantee Replicated Delivery <img src="../../html/images/iconInfo.png" alt="FlowFile will be routed to failure unless the message is replicated to the appropriate number of Kafka Nodes according to the Topic configuration" title="FlowFile will be routed to failure unless the message is replicated to the appropriate number of Kafka Nodes according to the Topic configuration"></img></li></ul></td><td id="description">Specifies the requirement for guaranteeing that a message is sent to Kafka </td></tr><tr><td id="name">Message Delimiter</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specifies the delimiter to use for splitting apart multiple messages within a single FlowFile. If not specified, the entire content of the FlowFile will be used as a single message. If specified, the contents of the FlowFile will be split on this delimiter and each section sent as a separate Kafka message. Note that if messages are delimited and some messages for a given FlowFile are transferred successfully while others are not, the messages will be split into individual FlowFiles, such that those messages that were successfully sent are routed to the 'success' relationship while other messages are sent to the 'failure' relationship.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Max Buffer Size</strong></td><td id="default-value">5 MB</td><td id="allowable-values"></td><td id="description">The maximum amount o f data to buffer in memory before sending to Kafka</td></tr><tr><td id="name"><strong>Max Record Size</strong></td><td id="default-value">1 MB</td><td id="allowable-values"></td><td id="description">The maximum size that any individual record can be.</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">The amount of time to wait for a response from Kafka before determining that there is a communications error</td></tr><tr><td id="name"><strong>Batch Size</strong></td><td id="default-value">200</td><td id="allowable-values"></td><td id="description">The number of messages to send in one batch. The producer will wait until either this number of messages are ready to send or "Queue Buffering Max Time" is reached. NOTE: This property will be ignored unless the 'Message Delimiter' property is specified.</td></tr><tr><td id="name"><strong>Queue Buffering Max Time</strong></td><td id="d efault-value">5 secs</td><td id="allowable-values"></td><td id="description">Maximum time to buffer data before sending to Kafka. For example a setting of 100 ms will try to batch together 100 milliseconds' worth of messages to send at once. This will improve throughput but adds message delivery latency due to the buffering.</td></tr><tr><td id="name"><strong>Compression Codec</strong></td><td id="default-value">none</td><td id="allowable-values"><ul><li>None <img src="../../html/images/iconInfo.png" alt="Compression will not be used for any topic." title="Compression will not be used for any topic."></img></li><li>GZIP <img src="../../html/images/iconInfo.png" alt="Compress messages using GZIP" title="Compress messages using GZIP"></img></li><li>Snappy <img src="../../html/images/iconInfo.png" alt="Compress messages using Snappy" title="Compress messages using Snappy"></img></li></ul></td><td id="description">This parameter allows you to specify the compression codec for all data g enerated by this producer.</td></tr><tr><td id="name"><strong>Client Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Client Name to use when communicating with Kafka</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 Kafka configuration property.</td><td id="value">The value of a given Kafka configuration property.</td><td>These properties will be added on the Kafka configuration after loading any provided configuration properties. In the event a dynamic property represents a property that was already set as part of the static properties, its value wil be overriden with warning message describing the override. For the list of available Kafka properties please refer to: http://kafka.apache.org/documentation.html#configuration.</td></tr></ table></p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Any FlowFile that is successfully sent to Kafka will be routed to this Relationship</td></tr><tr><td>failure</td><td>Any FlowFile that cannot be sent to Kafka 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 Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.kite.ConvertAvroSchema/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.kite.ConvertAvroSchema/index.html?rev=1736720&r1=1736719&r2=1736720&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.kite.ConvertAvroSchema/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.kite.ConvertAvroSchema/index.html Sun Mar 27 04:51:17 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ConvertAvroSchema</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Convert records from one Avro schema to another, including support for flattening and simple type conversions</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>avro, convert, kite</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>Input Schema</strong></td><td id="default-value"></td><td id="allowable-values"></td>< td id="description">Avro Schema of Input Flowfiles<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Output Schema</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Avro Schema of Output 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">Field name from input schema</td><td id="value">Field name for output schema</td><td>Explicit mappings from input schema to output schema, which supports renaming fields and stepping into nested records on the input schema using notation like parent.id</td></tr></table></p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Avro content that converted succe ssfully</td></tr><tr><td>failure</td><td>Avro content that failed to convert</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.</body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ConvertAvroSchema</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Convert records from one Avro schema to another, including support for flattening and simple type conversions</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>avro, convert, kite</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>Input Schema</strong></td><td id="default-value"></td><td id="allowable-values"></td>< td id="description">Avro Schema of Input Flowfiles<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Output Schema</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Avro Schema of Output Flowfiles<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Locale</td><td id="default-value">default</td><td id="allowable-values"></td><td id="description">Locale to use for scanning data (see https://docs.oracle.com/javase/7/docs/api/java/util/Locale.html)or " default" for JVM default</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">Field name from input schema</td><td id="value">Field name for output schema</td><td>Explicit mappings from input schema to output schema, which supports renaming fiel ds and stepping into nested records on the input schema using notation like parent.id</td></tr></table></p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Avro content that converted successfully</td></tr><tr><td>failure</td><td>Avro content that failed to convert</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.kite.InferAvroSchema/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.kite.InferAvroSchema/index.html?rev=1736720&r1=1736719&r2=1736720&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.kite.InferAvroSchema/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.kite.InferAvroSchema/index.html Sun Mar 27 04:51:17 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>InferAvroSchema</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Examines the contents of the incoming FlowFile to infer an Avro schema. The processor will use the Kite SDK to make an attempt to automatically generate an Avro schema from the incoming content. When inferring the schema from JSON data the key names will be used in the resulting Avro schema definition. When inferring from CSV data a "header definition" must be present either as the first line of the incoming data or the "header definition" must be explicitly set in the property "CSV Header Definition". A "header definition" is simply a single comma separated line defining the names of each column. The "header definition" is required in order to determine the names that should be given to each field in the resulting Avro definition. When inferring data types the higher o rder data type is always used if there is ambiguity. For example when examining numerical values the type may be set to "long" instead of "integer" since a long can safely hold the value of any "integer". Only CSV and JSON content is currently supported for automatically inferring an Avro schema. The type of content present in the incoming FlowFile is set by using the property "Input Content Type". The property can either be explicitly set to CSV, JSON, or "use mime.type value" which will examine the value of the mime.type attribute on the incoming FlowFile to determine the type of content present.</p><h3>Tags: </h3><p>kite, avro, infer, schema, csv, 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>Schema Output Destination</strong></td><td id="default-value">flowfile-content</td><td id="allowable-values"><ul><li>flowfile-attribute</li><li>flowfile-content</li></ul></td><td id="description">Control if Avro schema is written as a new flowfile attribute 'inferred.avro.schema' or written in the flowfile content. Writing to flowfile content will overwrite any existing flowfile content.</td></tr><tr><td id="name"><strong>Input Content Type</strong></td><td id="default-value">use mime.type value</td><td id="allowable-values"><ul><li>use mime.type value</li><li>json</li><li>csv</li></ul></td><td id="description">Content Type of data present in the incoming FlowFile's content. Only "json" or "csv" are supported. If this value is set to "use mime.type value" the incoming Flowfile's attribute "MIME_TYPE" will be used to determine the Content Type .</td></tr><tr><td id="name">CSV Header Definition</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">This property only applies to CSV content type. Comma separated string defining the column names expected in the CSV data. EX: "fname,lname,zip,address". The elements present in this string should be in the same order as the underlying data. Setting this property will cause the value of "Get CSV Header Definition From Data" to be ignored instead using this value.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Get CSV Header Definition From Data</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">This property only applies to CSV content type. If "true" the processor will attempt to read the CSV header definition from the first line of the input data.</td></tr><tr><td id="name"><strong>CSV Header Line Skip Count</strong></td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">This property only applies to CSV content type. Specifies the number of lines that should be skipped when reading the CSV data. Setting this value to 0 is equivalent to saying "the entire contents of the file should be read". If the property "Get CSV Header Definition From Data" is set then the first line of the CSV file will be read in and treated as the CSV header definition. Since this will remove the header line from the data care should be taken to make sure the value of "CSV header Line Skip Count" is set to 0 to ensure no data is skipped.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>CSV Escape String</strong></td><td id="default-value">\</td><td id="allowable-values"></td><td id="description">This property only applies to CSV content type. String that represents an escape sequence in the CSV FlowFile content data.<br/><strong>Supports Expression Languag e: true</strong></td></tr><tr><td id="name"><strong>CSV Quote String</strong></td><td id="default-value">'</td><td id="allowable-values"></td><td id="description">This property only applies to CSV content type. String that represents a literal quote character in the CSV FlowFile content data.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Pretty Avro Output</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If true the Avro output will be formatted.</td></tr><tr><td id="name"><strong>Avro Record Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Value to be placed in the Avro record schema "name" field.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Number Of Records To Analyze</strong></td><td id="default-value">10</td><td id="allowable-values"></td><td id="description ">This property only applies to JSON content type. The number of JSON records that should be examined to determine the Avro schema. The higher the value the better chance kite has of detecting the appropriate type. However the default value of 10 is almost always enough.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Charset</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">Character encoding of CSV data.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>unsupported content</td><td>The content found in the flowfile content is not of the required format.</td></tr><tr><td>success</td><td>Successfully created Avro schema from data.</td></tr><tr><td>failure</td><td>Failed to create Avro schema from data.</td></tr><tr><td>original</td><td>Original incoming FlowFile data</td></tr></table><h3>Reads Attributes: </h3><table id="reads-a ttributes"><tr><th>Name</th><th>Description</th></tr><tr><td>mime.type</td><td>If configured by property "Input Content Type" will use this value to determine what sort of content should be inferred from the incoming FlowFile content.</td></tr></table><h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>inferred.avro.schema</td><td>If configured by "Schema output destination" to write to an attribute this will hold the resulting Avro schema from inferring the incoming FlowFile content.</td></tr></table></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>InferAvroSchema</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Examines the contents of the incoming FlowFile to infer an Avro schema. The processor will use the Kite SDK to make an attempt to automatically generate an Avro schema from the incoming content. When inferring the schema from JSON data the key names will be used in the resulting Avro schema definition. When inferring from CSV data a "header definition" must be present either as the first line of the incoming data or the "header definition" must be explicitly set in the property "CSV Header Definition". A "header definition" is simply a single comma separated line defining the names of each column. The "header definition" is required in order to determine the names that should be given to each field in the resulting Avro definition. When inferring data types the higher o rder data type is always used if there is ambiguity. For example when examining numerical values the type may be set to "long" instead of "integer" since a long can safely hold the value of any "integer". Only CSV and JSON content is currently supported for automatically inferring an Avro schema. The type of content present in the incoming FlowFile is set by using the property "Input Content Type". The property can either be explicitly set to CSV, JSON, or "use mime.type value" which will examine the value of the mime.type attribute on the incoming FlowFile to determine the type of content present.</p><h3>Tags: </h3><p>kite, avro, infer, schema, csv, 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>Schema Output Destination</strong></td><td id="default-value">flowfile-content</td><td id="allowable-values"><ul><li>flowfile-attribute</li><li>flowfile-content</li></ul></td><td id="description">Control if Avro schema is written as a new flowfile attribute 'inferred.avro.schema' or written in the flowfile content. Writing to flowfile content will overwrite any existing flowfile content.</td></tr><tr><td id="name"><strong>Input Content Type</strong></td><td id="default-value">use mime.type value</td><td id="allowable-values"><ul><li>use mime.type value</li><li>json</li><li>csv</li></ul></td><td id="description">Content Type of data present in the incoming FlowFile's content. Only "json" or "csv" are supported. If this value is set to "use mime.type value" the incoming Flowfile's attribute "MIME_TYPE" will be used to determine the Content Type .</td></tr><tr><td id="name">CSV Header Definition</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">This property only applies to CSV content type. Comma separated string defining the column names expected in the CSV data. EX: "fname,lname,zip,address". The elements present in this string should be in the same order as the underlying data. Setting this property will cause the value of "Get CSV Header Definition From Data" to be ignored instead using this value.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Get CSV Header Definition From Data</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">This property only applies to CSV content type. If "true" the processor will attempt to read the CSV header definition from the first line of the input data.</td></tr><tr><td id="name"><strong>CSV Header Line Skip Count</strong></td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">This property only applies to CSV content type. Specifies the number of lines that should be skipped when reading the CSV data. Setting this value to 0 is equivalent to saying "the entire contents of the file should be read". If the property "Get CSV Header Definition From Data" is set then the first line of the CSV file will be read in and treated as the CSV header definition. Since this will remove the header line from the data care should be taken to make sure the value of "CSV header Line Skip Count" is set to 0 to ensure no data is skipped.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">CSV delimiter</td><td id="default-value">,</td><td id="allowable-values"></td><td id="description">Delimiter character for CSV records</td></tr><tr><td id="name"><strong>CSV Escape String</strong></td><td id="default-value">\</td><td id="allowable-values"></td><td id="description">T his property only applies to CSV content type. String that represents an escape sequence in the CSV FlowFile content data.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>CSV Quote String</strong></td><td id="default-value">'</td><td id="allowable-values"></td><td id="description">This property only applies to CSV content type. String that represents a literal quote character in the CSV FlowFile content data.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Pretty Avro Output</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If true the Avro output will be formatted.</td></tr><tr><td id="name"><strong>Avro Record Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Value to be placed in the Avro record schema "name" field.<br/><strong>Supports Expression Language: true</str ong></td></tr><tr><td id="name"><strong>Number Of Records To Analyze</strong></td><td id="default-value">10</td><td id="allowable-values"></td><td id="description">This property only applies to JSON content type. The number of JSON records that should be examined to determine the Avro schema. The higher the value the better chance kite has of detecting the appropriate type. However the default value of 10 is almost always enough.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Charset</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">Character encoding of CSV data.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>unsupported content</td><td>The content found in the flowfile content is not of the required format.</td></tr><tr><td>success</td><td>Successfully created Avro schema from data.</td></tr><tr><td>failure</td><td>Failed to create Avro schema from data.</td></tr><tr><td>original</td><td>Original incoming FlowFile data</td></tr></table><h3>Reads Attributes: </h3><table id="reads-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>mime.type</td><td>If configured by property "Input Content Type" will use this value to determine what sort of content should be inferred from the incoming FlowFile content.</td></tr></table><h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>inferred.avro.schema</td><td>If configured by "Schema output destination" to write to an attribute this will hold the resulting Avro schema from inferring the incoming FlowFile content.</td></tr></table></body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.splunk.GetSplunk/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.splunk.GetSplunk/index.html?rev=1736720&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.splunk.GetSplunk/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.splunk.GetSplunk/index.html Sun Mar 27 04:51:17 2016 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GetSplunk</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Retrieves data from Splunk Enterprise.</p><h3>Tags: </h3><p>get, splunk, logs</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Scheme</strong></td><td id="default-value">https</td><td id="allowable-values"><ul ><li>https</li><li>http</li></ul></td><td id="description">The scheme for >connecting to Splunk.</td></tr><tr><td >id="name"><strong>Hostname</strong></td><td >id="default-value">localhost</td><td id="allowable-values"></td><td >id="description">The ip address or hostname of the Splunk >server.</td></tr><tr><td id="name"><strong>Port</strong></td><td >id="default-value">8089</td><td id="allowable-values"></td><td >id="description">The port of the Splunk server.</td></tr><tr><td >id="name"><strong>Query</strong></td><td id="default-value">search * | head >100</td><td id="allowable-values"></td><td id="description">The query to >execute. Typically beginning with a <search> command followed by a >search clause, such as <search source="tcp:7689"> to search for >messages received on TCP port 7689.</td></tr><tr><td id="name"><strong>Time >Field Strategy</strong></td><td id="default-value">Event Time</td><td >id="allowable-values"><ul><li>Event Time <img >src="../../html/images/iconInfo.png" alt="Search based on the time of the event which may be different than when the event was indexed." title="Search based on the time of the event which may be different than when the event was indexed."></img></li><li>Index Time <img src="../../html/images/iconInfo.png" alt="Search based on the time the event was indexed in Splunk." title="Search based on the time the event was indexed in Splunk."></img></li></ul></td><td id="description">Indicates whether to search by the time attached to the event, or by the time the event was indexed in Splunk.</td></tr><tr><td id="name"><strong>Time Range Strategy</strong></td><td id="default-value">Provided</td><td id="allowable-values"><ul><li>Managed from Beginning <img src="../../html/images/iconInfo.png" alt="The processor will manage the date ranges of the query starting from the beginning of time." title="The processor will manage the date ranges of the query starting from the beginning of time."></img></li><li>Managed from Current <img sr c="../../html/images/iconInfo.png" alt="The processor will manage the date ranges of the query starting from the current time." title="The processor will manage the date ranges of the query starting from the current time."></img></li><li>Provided <img src="../../html/images/iconInfo.png" alt="The the time range provided through the Earliest Time and Latest Time properties will be used." title="The the time range provided through the Earliest Time and Latest Time properties will be used."></img></li></ul></td><td id="description">Indicates how to apply time ranges to each execution of the query. Selecting a managed option allows the processor to apply a time range from the last execution time to the current execution time. When using <Managed from Beginning>, an earliest time will not be applied on the first execution, and thus all records searched. When using <Managed from Current> the earliest time of the first execution will be the initial execution time. When using &l t;Provided>, the time range will come from the Earliest Time and Latest Time properties, or no time range will be applied if these properties are left blank.</td></tr><tr><td id="name">Earliest Time</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The value to use for the earliest time when querying. Only used with a Time Range Strategy of Provided. See Splunk's documentation on Search Time Modifiers for guidance in populating this field.</td></tr><tr><td id="name">Latest Time</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The value to use for the latest time when querying. Only used with a Time Range Strategy of Provided. See Splunk's documentation on Search Time Modifiers for guidance in populating this field.</td></tr><tr><td id="name"><strong>Time Zone</strong></td><td id="default-value">UTC</td><td id="allowable-values"><ul><li>Africa/Abidjan</li><li>Africa/Accra</li><li>Africa/Addis_Ababa</li><li>Africa /Algiers</li><li>Africa/Asmara</li><li>Africa/Asmera</li><li>Africa/Bamako</li><li>Africa/Bangui</li><li>Africa/Banjul</li><li>Africa/Bissau</li><li>Africa/Blantyre</li><li>Africa/Brazzaville</li><li>Africa/Bujumbura</li><li>Africa/Cairo</li><li>Africa/Casablanca</li><li>Africa/Ceuta</li><li>Africa/Conakry</li><li>Africa/Dakar</li><li>Africa/Dar_es_Salaam</li><li>Africa/Djibouti</li><li>Africa/Douala</li><li>Africa/El_Aaiun</li><li>Africa/Freetown</li><li>Africa/Gaborone</li><li>Africa/Harare</li><li>Africa/Johannesburg</li><li>Africa/Juba</li><li>Africa/Kampala</li><li>Africa/Khartoum</li><li>Africa/Kigali</li><li>Africa/Kinshasa</li><li>Africa/Lagos</li><li>Africa/Libreville</li><li>Africa/Lome</li><li>Africa/Luanda</li><li>Africa/Lubumbashi</li><li>Africa/Lusaka</li><li>Africa/Malabo</li><li>Africa/Maputo</li><li>Africa/Maseru</li><li>Africa/Mbabane</li><li>Africa/Mogadishu</li><li>Africa/Monrovia</li><li>Africa/Nairobi</li><li>Africa/Ndjamena</li><li>Africa/Niamey</li><li>Africa /Nouakchott</li><li>Africa/Ouagadougou</li><li>Africa/Porto-Novo</li><li>Africa/Sao_Tome</li><li>Africa/Timbuktu</li><li>Africa/Tripoli</li><li>Africa/Tunis</li><li>Africa/Windhoek</li><li>America/Adak</li><li>America/Anchorage</li><li>America/Anguilla</li><li>America/Antigua</li><li>America/Araguaina</li><li>America/Argentina/Buenos_Aires</li><li>America/Argentina/Catamarca</li><li>America/Argentina/ComodRivadavia</li><li>America/Argentina/Cordoba</li><li>America/Argentina/Jujuy</li><li>America/Argentina/La_Rioja</li><li>America/Argentina/Mendoza</li><li>America/Argentina/Rio_Gallegos</li><li>America/Argentina/Salta</li><li>America/Argentina/San_Juan</li><li>America/Argentina/San_Luis</li><li>America/Argentina/Tucuman</li><li>America/Argentina/Ushuaia</li><li>America/Aruba</li><li>America/Asuncion</li><li>America/Atikokan</li><li>America/Atka</li><li>America/Bahia</li><li>America/Bahia_Banderas</li><li>America/Barbados</li><li>America/Belem</li><li>America/Belize</li><li>America/Bl anc-Sablon</li><li>America/Boa_Vista</li><li>America/Bogota</li><li>America/Boise</li><li>America/Buenos_Aires</li><li>America/Cambridge_Bay</li><li>America/Campo_Grande</li><li>America/Cancun</li><li>America/Caracas</li><li>America/Catamarca</li><li>America/Cayenne</li><li>America/Cayman</li><li>America/Chicago</li><li>America/Chihuahua</li><li>America/Coral_Harbour</li><li>America/Cordoba</li><li>America/Costa_Rica</li><li>America/Creston</li><li>America/Cuiaba</li><li>America/Curacao</li><li>America/Danmarkshavn</li><li>America/Dawson</li><li>America/Dawson_Creek</li><li>America/Denver</li><li>America/Detroit</li><li>America/Dominica</li><li>America/Edmonton</li><li>America/Eirunepe</li><li>America/El_Salvador</li><li>America/Ensenada</li><li>America/Fort_Nelson</li><li>America/Fort_Wayne</li><li>America/Fortaleza</li><li>America/Glace_Bay</li><li>America/Godthab</li><li>America/Goose_Bay</li><li>America/Grand_Turk</li><li>America/Grenada</li><li>America/Guadeloupe</li><li>Americ a/Guatemala</li><li>America/Guayaquil</li><li>America/Guyana</li><li>America/Halifax</li><li>America/Havana</li><li>America/Hermosillo</li><li>America/Indiana/Indianapolis</li><li>America/Indiana/Knox</li><li>America/Indiana/Marengo</li><li>America/Indiana/Petersburg</li><li>America/Indiana/Tell_City</li><li>America/Indiana/Vevay</li><li>America/Indiana/Vincennes</li><li>America/Indiana/Winamac</li><li>America/Indianapolis</li><li>America/Inuvik</li><li>America/Iqaluit</li><li>America/Jamaica</li><li>America/Jujuy</li><li>America/Juneau</li><li>America/Kentucky/Louisville</li><li>America/Kentucky/Monticello</li><li>America/Knox_IN</li><li>America/Kralendijk</li><li>America/La_Paz</li><li>America/Lima</li><li>America/Los_Angeles</li><li>America/Louisville</li><li>America/Lower_Princes</li><li>America/Maceio</li><li>America/Managua</li><li>America/Manaus</li><li>America/Marigot</li><li>America/Martinique</li><li>America/Matamoros</li><li>America/Mazatlan</li><li>America/Mendoza</li><l i>America/Menominee</li><li>America/Merida</li><li>America/Metlakatla</li><li>America/Mexico_City</li><li>America/Miquelon</li><li>America/Moncton</li><li>America/Monterrey</li><li>America/Montevideo</li><li>America/Montreal</li><li>America/Montserrat</li><li>America/Nassau</li><li>America/New_York</li><li>America/Nipigon</li><li>America/Nome</li><li>America/Noronha</li><li>America/North_Dakota/Beulah</li><li>America/North_Dakota/Center</li><li>America/North_Dakota/New_Salem</li><li>America/Ojinaga</li><li>America/Panama</li><li>America/Pangnirtung</li><li>America/Paramaribo</li><li>America/Phoenix</li><li>America/Port-au-Prince</li><li>America/Port_of_Spain</li><li>America/Porto_Acre</li><li>America/Porto_Velho</li><li>America/Puerto_Rico</li><li>America/Rainy_River</li><li>America/Rankin_Inlet</li><li>America/Recife</li><li>America/Regina</li><li>America/Resolute</li><li>America/Rio_Branco</li><li>America/Rosario</li><li>America/Santa_Isabel</li><li>America/Santarem</li><li>Americ a/Santiago</li><li>America/Santo_Domingo</li><li>America/Sao_Paulo</li><li>America/Scoresbysund</li><li>America/Shiprock</li><li>America/Sitka</li><li>America/St_Barthelemy</li><li>America/St_Johns</li><li>America/St_Kitts</li><li>America/St_Lucia</li><li>America/St_Thomas</li><li>America/St_Vincent</li><li>America/Swift_Current</li><li>America/Tegucigalpa</li><li>America/Thule</li><li>America/Thunder_Bay</li><li>America/Tijuana</li><li>America/Toronto</li><li>America/Tortola</li><li>America/Vancouver</li><li>America/Virgin</li><li>America/Whitehorse</li><li>America/Winnipeg</li><li>America/Yakutat</li><li>America/Yellowknife</li><li>Antarctica/Casey</li><li>Antarctica/Davis</li><li>Antarctica/DumontDUrville</li><li>Antarctica/Macquarie</li><li>Antarctica/Mawson</li><li>Antarctica/McMurdo</li><li>Antarctica/Palmer</li><li>Antarctica/Rothera</li><li>Antarctica/South_Pole</li><li>Antarctica/Syowa</li><li>Antarctica/Troll</li><li>Antarctica/Vostok</li><li>Arctic/Longyearbyen</li><li>As ia/Aden</li><li>Asia/Almaty</li><li>Asia/Amman</li><li>Asia/Anadyr</li><li>Asia/Aqtau</li><li>Asia/Aqtobe</li><li>Asia/Ashgabat</li><li>Asia/Ashkhabad</li><li>Asia/Baghdad</li><li>Asia/Bahrain</li><li>Asia/Baku</li><li>Asia/Bangkok</li><li>Asia/Beirut</li><li>Asia/Bishkek</li><li>Asia/Brunei</li><li>Asia/Calcutta</li><li>Asia/Chita</li><li>Asia/Choibalsan</li><li>Asia/Chongqing</li><li>Asia/Chungking</li><li>Asia/Colombo</li><li>Asia/Dacca</li><li>Asia/Damascus</li><li>Asia/Dhaka</li><li>Asia/Dili</li><li>Asia/Dubai</li><li>Asia/Dushanbe</li><li>Asia/Gaza</li><li>Asia/Harbin</li><li>Asia/Hebron</li><li>Asia/Ho_Chi_Minh</li><li>Asia/Hong_Kong</li><li>Asia/Hovd</li><li>Asia/Irkutsk</li><li>Asia/Istanbul</li><li>Asia/Jakarta</li><li>Asia/Jayapura</li><li>Asia/Jerusalem</li><li>Asia/Kabul</li><li>Asia/Kamchatka</li><li>Asia/Karachi</li><li>Asia/Kashgar</li><li>Asia/Kathmandu</li><li>Asia/Katmandu</li><li>Asia/Khandyga</li><li>Asia/Kolkata</li><li>Asia/Krasnoyarsk</li><li>Asia/Kuala_Lump ur</li><li>Asia/Kuching</li><li>Asia/Kuwait</li><li>Asia/Macao</li><li>Asia/Macau</li><li>Asia/Magadan</li><li>Asia/Makassar</li><li>Asia/Manila</li><li>Asia/Muscat</li><li>Asia/Nicosia</li><li>Asia/Novokuznetsk</li><li>Asia/Novosibirsk</li><li>Asia/Omsk</li><li>Asia/Oral</li><li>Asia/Phnom_Penh</li><li>Asia/Pontianak</li><li>Asia/Pyongyang</li><li>Asia/Qatar</li><li>Asia/Qyzylorda</li><li>Asia/Rangoon</li><li>Asia/Riyadh</li><li>Asia/Saigon</li><li>Asia/Sakhalin</li><li>Asia/Samarkand</li><li>Asia/Seoul</li><li>Asia/Shanghai</li><li>Asia/Singapore</li><li>Asia/Srednekolymsk</li><li>Asia/Taipei</li><li>Asia/Tashkent</li><li>Asia/Tbilisi</li><li>Asia/Tehran</li><li>Asia/Tel_Aviv</li><li>Asia/Thimbu</li><li>Asia/Thimphu</li><li>Asia/Tokyo</li><li>Asia/Ujung_Pandang</li><li>Asia/Ulaanbaatar</li><li>Asia/Ulan_Bator</li><li>Asia/Urumqi</li><li>Asia/Ust-Nera</li><li>Asia/Vientiane</li><li>Asia/Vladivostok</li><li>Asia/Yakutsk</li><li>Asia/Yekaterinburg</li><li>Asia/Yerevan</li><li>Atlanti c/Azores</li><li>Atlantic/Bermuda</li><li>Atlantic/Canary</li><li>Atlantic/Cape_Verde</li><li>Atlantic/Faeroe</li><li>Atlantic/Faroe</li><li>Atlantic/Jan_Mayen</li><li>Atlantic/Madeira</li><li>Atlantic/Reykjavik</li><li>Atlantic/South_Georgia</li><li>Atlantic/St_Helena</li><li>Atlantic/Stanley</li><li>Australia/ACT</li><li>Australia/Adelaide</li><li>Australia/Brisbane</li><li>Australia/Broken_Hill</li><li>Australia/Canberra</li><li>Australia/Currie</li><li>Australia/Darwin</li><li>Australia/Eucla</li><li>Australia/Hobart</li><li>Australia/LHI</li><li>Australia/Lindeman</li><li>Australia/Lord_Howe</li><li>Australia/Melbourne</li><li>Australia/NSW</li><li>Australia/North</li><li>Australia/Perth</li><li>Australia/Queensland</li><li>Australia/South</li><li>Australia/Sydney</li><li>Australia/Tasmania</li><li>Australia/Victoria</li><li>Australia/West</li><li>Australia/Yancowinna</li><li>Brazil/Acre</li><li>Brazil/DeNoronha</li><li>Brazil/East</li><li>Brazil/West</li><li>CET</li><li>CST6CD T</li><li>Canada/Atlantic</li><li>Canada/Central</li><li>Canada/East-Saskatchewan</li><li>Canada/Eastern</li><li>Canada/Mountain</li><li>Canada/Newfoundland</li><li>Canada/Pacific</li><li>Canada/Saskatchewan</li><li>Canada/Yukon</li><li>Chile/Continental</li><li>Chile/EasterIsland</li><li>Cuba</li><li>EET</li><li>EST5EDT</li><li>Egypt</li><li>Eire</li><li>Etc/GMT</li><li>Etc/GMT+0</li><li>Etc/GMT+1</li><li>Etc/GMT+10</li><li>Etc/GMT+11</li><li>Etc/GMT+12</li><li>Etc/GMT+2</li><li>Etc/GMT+3</li><li>Etc/GMT+4</li><li>Etc/GMT+5</li><li>Etc/GMT+6</li><li>Etc/GMT+7</li><li>Etc/GMT+8</li><li>Etc/GMT+9</li><li>Etc/GMT-0</li><li>Etc/GMT-1</li><li>Etc/GMT-10</li><li>Etc/GMT-11</li><li>Etc/GMT-12</li><li>Etc/GMT-13</li><li>Etc/GMT-14</li><li>Etc/GMT-2</li><li>Etc/GMT-3</li><li>Etc/GMT-4</li><li>Etc/GMT-5</li><li>Etc/GMT-6</li><li>Etc/GMT-7</li><li>Etc/GMT-8</li><li>Etc/GMT-9</li><li>Etc/GMT0</li><li>Etc/Greenwich</li><li>Etc/UCT</li><li>Etc/UTC</li><li>Etc/Universal</li><li>Etc/Zulu</li><li>E urope/Amsterdam</li><li>Europe/Andorra</li><li>Europe/Athens</li><li>Europe/Belfast</li><li>Europe/Belgrade</li><li>Europe/Berlin</li><li>Europe/Bratislava</li><li>Europe/Brussels</li><li>Europe/Bucharest</li><li>Europe/Budapest</li><li>Europe/Busingen</li><li>Europe/Chisinau</li><li>Europe/Copenhagen</li><li>Europe/Dublin</li><li>Europe/Gibraltar</li><li>Europe/Guernsey</li><li>Europe/Helsinki</li><li>Europe/Isle_of_Man</li><li>Europe/Istanbul</li><li>Europe/Jersey</li><li>Europe/Kaliningrad</li><li>Europe/Kiev</li><li>Europe/Lisbon</li><li>Europe/Ljubljana</li><li>Europe/London</li><li>Europe/Luxembourg</li><li>Europe/Madrid</li><li>Europe/Malta</li><li>Europe/Mariehamn</li><li>Europe/Minsk</li><li>Europe/Monaco</li><li>Europe/Moscow</li><li>Europe/Nicosia</li><li>Europe/Oslo</li><li>Europe/Paris</li><li>Europe/Podgorica</li><li>Europe/Prague</li><li>Europe/Riga</li><li>Europe/Rome</li><li>Europe/Samara</li><li>Europe/San_Marino</li><li>Europe/Sarajevo</li><li>Europe/Simferopol</l i><li>Europe/Skopje</li><li>Europe/Sofia</li><li>Europe/Stockholm</li><li>Europe/Tallinn</li><li>Europe/Tirane</li><li>Europe/Tiraspol</li><li>Europe/Uzhgorod</li><li>Europe/Vaduz</li><li>Europe/Vatican</li><li>Europe/Vienna</li><li>Europe/Vilnius</li><li>Europe/Volgograd</li><li>Europe/Warsaw</li><li>Europe/Zagreb</li><li>Europe/Zaporozhye</li><li>Europe/Zurich</li><li>GB</li><li>GB-Eire</li><li>GMT</li><li>GMT0</li><li>Greenwich</li><li>Hongkong</li><li>Iceland</li><li>Indian/Antananarivo</li><li>Indian/Chagos</li><li>Indian/Christmas</li><li>Indian/Cocos</li><li>Indian/Comoro</li><li>Indian/Kerguelen</li><li>Indian/Mahe</li><li>Indian/Maldives</li><li>Indian/Mauritius</li><li>Indian/Mayotte</li><li>Indian/Reunion</li><li>Iran</li><li>Israel</li><li>Jamaica</li><li>Japan</li><li>Kwajalein</li><li>Libya</li><li>MET</li><li>MST7MDT</li><li>Mexico/BajaNorte</li><li>Mexico/BajaSur</li><li>Mexico/General</li><li>NZ</li><li>NZ-CHAT</li><li>Navajo</li><li>PRC</li><li>PST8PDT</li><li>Paci fic/Apia</li><li>Pacific/Auckland</li><li>Pacific/Bougainville</li><li>Pacific/Chatham</li><li>Pacific/Chuuk</li><li>Pacific/Easter</li><li>Pacific/Efate</li><li>Pacific/Enderbury</li><li>Pacific/Fakaofo</li><li>Pacific/Fiji</li><li>Pacific/Funafuti</li><li>Pacific/Galapagos</li><li>Pacific/Gambier</li><li>Pacific/Guadalcanal</li><li>Pacific/Guam</li><li>Pacific/Honolulu</li><li>Pacific/Johnston</li><li>Pacific/Kiritimati</li><li>Pacific/Kosrae</li><li>Pacific/Kwajalein</li><li>Pacific/Majuro</li><li>Pacific/Marquesas</li><li>Pacific/Midway</li><li>Pacific/Nauru</li><li>Pacific/Niue</li><li>Pacific/Norfolk</li><li>Pacific/Noumea</li><li>Pacific/Pago_Pago</li><li>Pacific/Palau</li><li>Pacific/Pitcairn</li><li>Pacific/Pohnpei</li><li>Pacific/Ponape</li><li>Pacific/Port_Moresby</li><li>Pacific/Rarotonga</li><li>Pacific/Saipan</li><li>Pacific/Samoa</li><li>Pacific/Tahiti</li><li>Pacific/Tarawa</li><li>Pacific/Tongatapu</li><li>Pacific/Truk</li><li>Pacific/Wake</li><li>Pacific/Wallis</li ><li>Pacific/Yap</li><li>Poland</li><li>Portugal</li><li>ROK</li><li>Singapore</li><li>SystemV/AST4</li><li>SystemV/AST4ADT</li><li>SystemV/CST6</li><li>SystemV/CST6CDT</li><li>SystemV/EST5</li><li>SystemV/EST5EDT</li><li>SystemV/HST10</li><li>SystemV/MST7</li><li>SystemV/MST7MDT</li><li>SystemV/PST8</li><li>SystemV/PST8PDT</li><li>SystemV/YST9</li><li>SystemV/YST9YDT</li><li>Turkey</li><li>UCT</li><li>US/Alaska</li><li>US/Aleutian</li><li>US/Arizona</li><li>US/Central</li><li>US/East-Indiana</li><li>US/Eastern</li><li>US/Hawaii</li><li>US/Indiana-Starke</li><li>US/Michigan</li><li>US/Mountain</li><li>US/Pacific</li><li>US/Pacific-New</li><li>US/Samoa</li><li>UTC</li><li>Universal</li><li>W-SU</li><li>WET</li><li>Zulu</li><li>EST</li><li>HST</li><li>MST</li><li>ACT</li><li>AET</li><li>AGT</li><li>ART</li><li>AST</li><li>BET</li><li>BST</li><li>CAT</li><li>CNT</li><li>CST</li><li>CTT</li><li>EAT</li><li>ECT</li><li>IET</li><li>IST</li><li>JST</li><li>MIT</li><li>NET</li><li>NST</li>< li>PLT</li><li>PNT</li><li>PRT</li><li>PST</li><li>SST</li><li>VST</li></ul></td><td id="description">The Time Zone to use for formatting dates when performing a search. Only used with Managed time strategies.</td></tr><tr><td id="name">Application</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Splunk Application to query.</td></tr><tr><td id="name">Owner</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The owner to pass to Splunk.</td></tr><tr><td id="name">Token</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The token to pass to Splunk.</td></tr><tr><td id="name">Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The username to authenticate to Splunk.</td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The password to authenticate to Splunk.<br/><strong>Sensiti ve Property: true</strong></td></tr><tr><td id="name">Security Protocol</td><td id="default-value">TLSv1_2</td><td id="allowable-values"><ul><li>TLSv1_2</li><li>TLSv1_1</li><li>TLSv1</li><li>SSLv3</li></ul></td><td id="description">The security protocol to use for communicating with Splunk.</td></tr><tr><td id="name"><strong>Output Mode</strong></td><td id="default-value">JSON</td><td id="allowable-values"><ul><li>ATOM</li><li>CSV</li><li>JSON</li><li>JSON_COLS</li><li>JSON_ROWS</li><li>RAW</li><li>XML</li></ul></td><td id="description">The output mode for the results.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Results retrieved from Splunk are sent out 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>splunk.query</td><td>The query that performed to produce th e FlowFile.</td></tr><tr><td>splunk.earliest.time</td><td>The value of the earliest time that was used when performing the query.</td></tr><tr><td>splunk.latest.time</td><td>The value of the latest time that was used when performing the query.</td></tr></table></body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.splunk.PutSplunk/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.splunk.PutSplunk/index.html?rev=1736720&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.splunk.PutSplunk/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.splunk.PutSplunk/index.html Sun Mar 27 04:51:17 2016 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutSplunk</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Sends logs to Splunk Enterprise over TCP, TCP + TLS/SSL, or UDP. If a Message Delimiter is provided, then this processor will read messages from the incoming FlowFile based on the delimiter, and send each message to Splunk. If a Message Delimiter is not provided then the content of the FlowFile will be sent directly to Splunk as if it were a single message.</p><h3>Tags: </h3><p>splunk, logs, tcp, udp</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>Hostname</strong></td><td id="default-value">localhost</td><td id="allowable-values"></td><td id="description">The ip address or hostname of the destination.</td></tr><tr><td id="name"><strong>Port</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The port on the destination.</td></tr><tr><td id="name"><strong>Max Size of Socket Send Buffer</strong></td><td id="default-value">1 MB</td><td id="allowable-values"></td><td id="description">The maximum size of the socket send buffer that should be used. This is a suggestion to the Operating System to indicate how big the socket buffer should be. If this value is set too low, the buffer may fill up before the data can be read, and incoming data will be dropped.</td></tr><tr><td id="name"><strong>Character Set</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description ">Specifies the character set of the data being sent.</td></tr><tr><td id="name">Timeout</td><td id="default-value">10 seconds</td><td id="allowable-values"></td><td id="description">The timeout for connecting to and communicating with the destination. Does not apply to UDP</td></tr><tr><td id="name"><strong>Idle Connection Expiration</strong></td><td id="default-value">5 seconds</td><td id="allowable-values"></td><td id="description">The amount of time a connection should be held open without being used before closing the connection.</td></tr><tr><td id="name"><strong>Protocol</strong></td><td id="default-value">TCP</td><td id="allowable-values"><ul><li>TCP</li><li>UDP</li></ul></td><td id="description">The protocol for communication.</td></tr><tr><td id="name">Message Delimiter</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specifies the delimiter to use for splitting apart multiple messages within a single FlowFile. If not specified, the entir e content of the FlowFile will be used as a single message. If specified, the contents of the FlowFile will be split on this delimiter and each section sent as a separate message. Note that if messages are delimited and some messages for a given FlowFile are transferred successfully while others are not, the messages will be split into individual FlowFiles, such that those messages that were successfully sent are routed to the 'success' relationship while other messages are sent to the 'failure' relationship.<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">The Controller Service to use in order to obtain an SSL Context. If this property is set, m essages will be sent over a secure connection.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>FlowFiles that are sent successfully to the destination are sent out this relationship.</td></tr><tr><td>failure</td><td>FlowFiles that failed to send to the destination are sent out 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
