Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-couchbase-nar/1.2.0/org.apache.nifi.processors.couchbase.GetCouchbaseKey/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-couchbase-nar/1.2.0/org.apache.nifi.processors.couchbase.GetCouchbaseKey/index.html?rev=1794596&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-couchbase-nar/1.2.0/org.apache.nifi.processors.couchbase.GetCouchbaseKey/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-couchbase-nar/1.2.0/org.apache.nifi.processors.couchbase.GetCouchbaseKey/index.html Tue May 9 15:27:39 2017 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GetCouchbaseKey</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">GetCouchbaseKey</h1><h2>Description: </h2><p>Get a document from Couchbase Server via Key/Value access. The ID of the document to fetch may be supplied by setting the <Document Id> property. NOTE: if the Document Id property is not set, the contents of the FlowFile will be read to determine the Document Id, which means that the contents of the entire FlowFile will be buffered in memory.</p><h3>Tags: </h3><p>nosql, couchbase, database, get</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 co nsidered 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>Couchbase Cluster Controller Service</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>CouchbaseClusterControllerService<br/><strong>Implementation:</strong><br/><a href="../org.apache.nifi.couchbase.CouchbaseClusterService/index.html">CouchbaseClusterService</a></td><td id="description">A Couchbase Cluster Controller Service which manages connections to a Couchbase cluster.</td></tr><tr><td id="name"><strong>Bucket Name</strong></td><td id="default-value">default</td><td id="allowable-values"></td><td id="description">The name of bucket to access.</td></tr><tr><td id="name"><strong>Document Typ e</strong></td><td id="default-value">Json</td><td id="allowable-values"><ul><li>Json</li><li>Binary</li></ul></td><td id="description">The type of contents.</td></tr><tr><td id="name">Document Id</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A static, fixed Couchbase document id, or an expression to construct the Couchbase document id.<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>retry</td><td>All FlowFiles that cannot written to Couchbase Server but can be retried are routed to this relationship.</td></tr><tr><td>success</td><td>All FlowFiles that are written to Couchbase Server are routed to this relationship.</td></tr><tr><td>failure</td><td>All FlowFiles that cannot written to Couchbase Server and can't be retried are routed to this relationship.</td></tr><tr><td>original</td><td>The original input file will be rou ted to this destination when it has been successfully processed.</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>couchbase.cluster</td><td>Cluster where the document was retrieved from.</td></tr><tr><td>couchbase.bucket</td><td>Bucket where the document was retrieved from.</td></tr><tr><td>couchbase.doc.id</td><td>Id of the document.</td></tr><tr><td>couchbase.doc.cas</td><td>CAS of the document.</td></tr><tr><td>couchbase.doc.expiry</td><td>Expiration of the document.</td></tr><tr><td>couchbase.exception</td><td>If Couchbase related error occurs the CouchbaseException class name will be captured here.</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>See Also:</h3><p></p></body></html> \ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-couchbase-nar/1.2.0/org.apache.nifi.processors.couchbase.PutCouchbaseKey/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-couchbase-nar/1.2.0/org.apache.nifi.processors.couchbase.PutCouchbaseKey/index.html?rev=1794596&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-couchbase-nar/1.2.0/org.apache.nifi.processors.couchbase.PutCouchbaseKey/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-couchbase-nar/1.2.0/org.apache.nifi.processors.couchbase.PutCouchbaseKey/index.html Tue May 9 15:27:39 2017 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutCouchbaseKey</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">PutCouchbaseKey</h1><h2>Description: </h2><p>Put a document to Couchbase Server via Key/Value access.</p><h3>Tags: </h3><p>nosql, couchbase, database, 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, 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>Descripti on</th></tr><tr><td id="name"><strong>Couchbase Cluster Controller Service</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>CouchbaseClusterControllerService<br/><strong>Implementation:</strong><br/><a href="../org.apache.nifi.couchbase.CouchbaseClusterService/index.html">CouchbaseClusterService</a></td><td id="description">A Couchbase Cluster Controller Service which manages connections to a Couchbase cluster.</td></tr><tr><td id="name"><strong>Bucket Name</strong></td><td id="default-value">default</td><td id="allowable-values"></td><td id="description">The name of bucket to access.</td></tr><tr><td id="name"><strong>Document Type</strong></td><td id="default-value">Json</td><td id="allowable-values"><ul><li>Json</li><li>Binary</li></ul></td><td id="description">The type of contents.</td></tr><tr><td id="name">Document Id</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A static, fix ed Couchbase document id, or an expression to construct the Couchbase document id.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Persist To</strong></td><td id="default-value">NONE</td><td id="allowable-values"><ul><li>MASTER</li><li>NONE</li><li>ONE</li><li>TWO</li><li>THREE</li><li>FOUR</li></ul></td><td id="description">Durability constraint about disk persistence.</td></tr><tr><td id="name"><strong>Replicate To</strong></td><td id="default-value">NONE</td><td id="allowable-values"><ul><li>NONE</li><li>ONE</li><li>TWO</li><li>THREE</li></ul></td><td id="description">Durability constraint about replication.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>retry</td><td>All FlowFiles that cannot written to Couchbase Server but can be retried are routed to this relationship.</td></tr><tr><td>success</td><td>All FlowFiles that are written to Couchbase Server are routed to this relationship.</td></tr><tr><td>failure</td><td>All FlowFiles that cannot written to Couchbase Server and can't be retried are routed to this relationship.</td></tr></table><h3>Reads Attributes: </h3><table id="reads-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>uuid</td><td>Used as a document id if 'Document Id' is not specified</td></tr></table><h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>couchbase.cluster</td><td>Cluster where the document was stored.</td></tr><tr><td>couchbase.bucket</td><td>Bucket where the document was stored.</td></tr><tr><td>couchbase.doc.id</td><td>Id of the document.</td></tr><tr><td>couchbase.doc.cas</td><td>CAS of the document.</td></tr><tr><td>couchbase.doc.expiry</td><td>Expiration of the document.</td></tr><tr><td>couchbase.exception</td><td>If Couchbase related error occurs the CouchbaseException class name will be captured here.</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>See Also:</h3><p></p></body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-cybersecurity-nar/1.2.0/org.apache.nifi.processors.cybersecurity.CompareFuzzyHash/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-cybersecurity-nar/1.2.0/org.apache.nifi.processors.cybersecurity.CompareFuzzyHash/index.html?rev=1794596&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-cybersecurity-nar/1.2.0/org.apache.nifi.processors.cybersecurity.CompareFuzzyHash/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-cybersecurity-nar/1.2.0/org.apache.nifi.processors.cybersecurity.CompareFuzzyHash/index.html Tue May 9 15:27:39 2017 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>CompareFuzzyHash</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">CompareFuzzyHash</h1><h2>Description: </h2><p>Compares an attribute containing a Fuzzy Hash against a file containing a list of fuzzy hashes, appending an attribute to the FlowFile in case of a successful match.</p><h3>Tags: </h3><p>hashing, fuzzy-hashing, cyber-security</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>Hash List source file</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Path to the file containing hashes to be validated against</td></tr><tr><td id="name"><strong>Hashing Algorithm</strong></td><td id="default-value"></td><td id="allowable-values"><ul><li>ssdeep <img src="../../../../../html/images/iconInfo.png" alt="Uses ssdeep / SpamSum 'context triggered piecewise hash'." title="Uses ssdeep / SpamSum 'context triggered piecewise hash'."></img></li><li>tlsh <img src="../../../../../html/images/iconInfo.png" alt="Uses TLSH (Trend 'Locality Sensitive Hash'). Note: FlowFile Content must be at least 512 characters long" title="Uses TLSH (Trend 'Locality Sensitive Hash'). Note: FlowFile Content must be at least 512 characters long"></img></li></ul></td><td id="description">The hashing algorithm utilised</td></tr><tr><td id="name"><strong>Hash Attribute Name</strong></td><td id="default-value">fuzzyhash.value</td ><td id="allowable-values"></td><td id="description">The name of the FlowFile >Attribute that should hold the Fuzzy Hash Value</td></tr><tr><td >id="name"><strong>Match threshold</strong></td><td >id="default-value"></td><td id="allowable-values"></td><td >id="description">The similarity score must exceed or be equal to in order >formatch to be considered true. Refer to Additional Information for >differences between TLSH and SSDEEP scores and how they relate to this >property.</td></tr><tr><td id="name"><strong>Matching mode</strong></td><td >id="default-value">single</td><td id="allowable-values"><ul><li>single <img >src="../../../../../html/images/iconInfo.png" alt="Send FlowFile to matched >after the first match above threshold" title="Send FlowFile to matched after >the first match above threshold"></img></li><li>multi-match <img >src="../../../../../html/images/iconInfo.png" alt="Iterate full list of >hashes before deciding to send FlowFile to matched or unmatched" >title="Iterate full list of hashes before deciding to send FlowFile to matched or unmatched"></img></li></ul></td><td id="description">Defines if the Processor should try to match as many entries as possible (multi-match) or if it should stop after the first match (single)</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>failure</td><td>Any FlowFile that cannot be matched, e.g. (lacks the attribute) will be sent to this Relationship.</td></tr><tr><td>not-found</td><td>Any FlowFile that cannot be matched to an existing hash will be sent to this Relationship.</td></tr><tr><td>found</td><td>Any FlowFile that is successfully matched to an existing hash will be sent 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>XXXX.N.match</td><td>The match that resembles the attribute specified by the <Hash Attribut e Name> property. Note that: 'XXX' gets replaced with the <Hash Attribute Name></td></tr><tr><td>XXXX.N.similarity</td><td>The similarity score between this flowfileand its match of the same number N. Note that: 'XXX' gets replaced with the <Hash Attribute Name></td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>See Also:</h3><p><a href="../org.apache.nifi.processors.cybersecurity.FuzzyHashContent/index.html">FuzzyHashContent</a></p></body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-cybersecurity-nar/1.2.0/org.apache.nifi.processors.cybersecurity.FuzzyHashContent/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-cybersecurity-nar/1.2.0/org.apache.nifi.processors.cybersecurity.FuzzyHashContent/index.html?rev=1794596&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-cybersecurity-nar/1.2.0/org.apache.nifi.processors.cybersecurity.FuzzyHashContent/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-cybersecurity-nar/1.2.0/org.apache.nifi.processors.cybersecurity.FuzzyHashContent/index.html Tue May 9 15:27:39 2017 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>FuzzyHashContent</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">FuzzyHashContent</h1><h2>Description: </h2><p>Calculates a fuzzy/locality-sensitive hash value for the Content of a FlowFile and puts that hash value on the FlowFile as an attribute whose name is determined by the <Hash Attribute Name> property.Note: this processor only offers non-cryptographic hash algorithms. And it should be not be seen as a replacement to the HashContent processor.Note: The underlying library loads the entirety of the streamed content into and performs result evaluations in memory. Accordingly, it is important to consider the anticipated profile of content being evalu ated by this processor and the hardware supporting it especially when working against large files.</p><h3>Tags: </h3><p>hashing, fuzzy-hashing, cyber-security</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>Hash Attribute Name</strong></td><td id="default-value">fuzzyhash.value</td><td id="allowable-values"></td><td id="description">The name of the FlowFile Attribute that should hold the Fuzzy Hash Value</td></tr><tr><td id="name"><strong>Hashing Algorithm</strong></td><td id="default-value"></td><td id="allowable-values"><ul><li>ssdeep <img src="../../../../../html/images/iconInfo.png" alt="Uses ssdeep / SpamSum 'context triggered piecewise hash'." title="Uses ssdeep / SpamSum 'context triggered piecewise hash'."></img></li><li>tlsh <img src="../../../../../html/images/iconInfo.png" alt="Uses TLSH (Trend 'Locality Sensitive Hash'). Note: FlowFile Content must be at least 512 characters long" title="Uses TLSH (Trend 'Locality Sensitive Hash'). Note: FlowFile Content must be at least 512 characters long"></img></li></ul></td><td id="description">The hashing algorithm utilised</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Any FlowFile that is successfully hashed will be sent to this Relationship.</td></tr><tr><td>failure</td><td>Any FlowFile that is successfully hashed will be sent 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><Hash Attribute Name></td><td>This Processor adds an attribute whose value is the result of Hashing t he existing FlowFile content. The name of this attribute is specified by the <Hash Attribute Name> property</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>See Also:</h3><p><a href="../org.apache.nifi.processors.cybersecurity.CompareFuzzyHash/index.html">CompareFuzzyHash</a>, <a href="../../../nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.HashContent/index.html">HashContent</a></p></body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-datadog-nar/1.2.0/org.apache.nifi.reporting.datadog.DataDogReportingTask/additionalDetails.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-datadog-nar/1.2.0/org.apache.nifi.reporting.datadog.DataDogReportingTask/additionalDetails.html?rev=1794596&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-datadog-nar/1.2.0/org.apache.nifi.reporting.datadog.DataDogReportingTask/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-datadog-nar/1.2.0/org.apache.nifi.reporting.datadog.DataDogReportingTask/additionalDetails.html Tue May 9 15:27:39 2017 @@ -0,0 +1,53 @@ +<!DOCTYPE html> +<html lang="en"> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + <head> + <meta charset="utf-8" /> + <title>DataDogReportingTask</title> + <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" /> + </head> + + <body> + <h2>DataDogReportingTask</h2> + + <p>This ReportingTask sends the following metrics to DataDog:</p> + <ul> + <li>FlowFilesReceivedLast5Minutes</li> + <li>BytesReceivedLast5Minutes</li> + <li>FlowFilesSentLast5Minutes</li> + <li>BytesSentLast5Minutes</li> + <li>FlowFilesQueued</li> + <li>BytesQueued</li> + <li>BytesReadLast5Minutes</li> + <li>BytesWrittenLast5Minutes</li> + <li>ActiveThreads</li> + <li>TotalTaskDurationSeconds</li> + <li>jvm.uptime</li> + <li>jvm.heap_used</li> + <li>jvm.heap_usage</li> + <li>jvm.non_heap_usage</li> + <li>jvm.thread_states.runnable</li> + <li>jvm.thread_states.blocked</li> + <li>jvm.thread_states.timed_waiting</li> + <li>jvm.thread_states.terminated</li> + <li>jvm.thread_count</li> + <li>jvm.daemon_thread_count</li> + <li>jvm.file_descriptor_usage</li> + <li>jvm.gc.runs</li> + <li>jvm.gc.time</li> + </ul> + </body> +</html> Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-datadog-nar/1.2.0/org.apache.nifi.reporting.datadog.DataDogReportingTask/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-datadog-nar/1.2.0/org.apache.nifi.reporting.datadog.DataDogReportingTask/index.html?rev=1794596&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-datadog-nar/1.2.0/org.apache.nifi.reporting.datadog.DataDogReportingTask/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-datadog-nar/1.2.0/org.apache.nifi.reporting.datadog.DataDogReportingTask/index.html Tue May 9 15:27:39 2017 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>DataDogReportingTask</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">DataDogReportingTask</h1><h2>Description: </h2><p>Publishes metrics from NiFi to datadog. For accurate and informative reporting, components should have unique names.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>reporting, datadog, metrics</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">Ni Fi 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>Metrics prefix</strong></td><td id="default-value">nifi</td><td id="allowable-values"></td><td id="description">Prefix to be added before every metric<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Environment</strong></td><td id="default-value">dev</td><td id="allowable-values"></td><td id="description">Environment, dataflow is running in. This property will be included as metrics tag.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">API key</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Datadog API key. If specified value is 'agent', local Datadog agent will be used.</td></tr><tr><td id="name"><strong>Datadog transport</strong></td><td id="default-value">Datadog HTTP</td><td id="allowable-values"><ul>< li>Datadog Agent <img src="../../../../../html/images/iconInfo.png" alt="Metrics will be sent via locally installed Datadog agent. Datadog agent needs to be installed manually before using this option" title="Metrics will be sent via locally installed Datadog agent. Datadog agent needs to be installed manually before using this option"></img></li><li>Datadog HTTP <img src="../../../../../html/images/iconInfo.png" alt="Metrics will be sent via HTTP transport with no need of Agent installed. Datadog API key needs to be set" title="Metrics will be sent via HTTP transport with no need of Agent installed. Datadog API key needs to be set"></img></li></ul></td><td id="description">Transport through which metrics will be sent to Datadog</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-dbcp-service-nar/1.2.0/org.apache.nifi.dbcp.DBCPConnectionPool/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-dbcp-service-nar/1.2.0/org.apache.nifi.dbcp.DBCPConnectionPool/index.html?rev=1794596&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-dbcp-service-nar/1.2.0/org.apache.nifi.dbcp.DBCPConnectionPool/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-dbcp-service-nar/1.2.0/org.apache.nifi.dbcp.DBCPConnectionPool/index.html Tue May 9 15:27:39 2017 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>DBCPConnectionPool</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">DBCPConnectionPool</h1><h2>Description: </h2><p>Provides Database Connection Pooling Service. Connections can be asked from pool and returned after usage.</p><h3>Tags: </h3><p>dbcp, jdbc, database, connection, pooling, store</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 consider ed "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>Database Connection URL</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A database connection URL used to connect to a database. May contain database system name, host, port, database name and some parameters. The exact syntax of a database connection URL is specified by your DBMS.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Database Driver Class Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Database driver class name<br/><strong>Supports Expression Language: true</strong>< /td></tr><tr><td id="name">Database Driver Location(s)</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Comma-separated list of files/folders and/or URLs containing the driver JAR and its dependencies (if any). For example '/var/tmp/mariadb-java-client-1.1.7.jar'<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Database User</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Database user name<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The password for the database user<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Max Wait Time</strong></td><td id="default-value">500 millis</td><td id="allowable-values"></td><td id="description">The maximum amount of time that t he pool will wait (when there are no available connections) for a connection to be returned before failing, or -1 to wait indefinitely. </td></tr><tr><td id="name"><strong>Max Total Connections</strong></td><td id="default-value">8</td><td id="allowable-values"></td><td id="description">The maximum number of active connections that can be allocated from this pool at the same time, or negative for no limit.</td></tr><tr><td id="name">Validation query</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Validation query used to validate connections before returning them. When connection is invalid, it get's dropped and new valid connection will be returned. Note!! Using validation might have some performance penalty.<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">JDBC property >name</td><td id="value">JDBC property value</td><td>Specifies a property name >and value to be set on the JDBC connection(s). If Expression Language is >used, evaluation will be performed upon the controller service being enabled. >Note that no flow file input (attributes, e.g.) is available for use in >Expression Language constructs for these properties.<br/><strong>Supports >Expression Language: true</strong></td></tr></table></p><h3>State management: ></h3>This component does not store state.<h3>Restricted: </h3>This component >is not restricted.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-distributed-cache-services-nar/1.2.0/org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-distributed-cache-services-nar/1.2.0/org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService/index.html?rev=1794596&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-distributed-cache-services-nar/1.2.0/org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-distributed-cache-services-nar/1.2.0/org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService/index.html Tue May 9 15:27:39 2017 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>DistributedMapCacheClientService</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">DistributedMapCacheClientService</h1><h2>Description: </h2><p>Provides the ability to communicate with a DistributedMapCacheServer. This can be used in order to share a Map between nodes in a NiFi cluster</p><h3>Tags: </h3><p>distributed, cache, state, map, cluster</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>Descript ion</th></tr><tr><td id="name"><strong>Server Hostname</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the server that is running the DistributedMapCacheServer service</td></tr><tr><td id="name"><strong>Server Port</strong></td><td id="default-value">4557</td><td id="allowable-values"></td><td id="description">The port on the remote server that is to be used when communicating with the DistributedMapCacheServer service</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="../../../nifi-ssl-context-service-nar/1.2.0/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td id="description">If specified, indicates the SSL Context Service that is used to communicate with the remote server. If not specified, communications will not be encrypted</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">Specifies how long to wait when communicating with the remote server before determining that there is a communications failure if data cannot be sent or received</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>See Also:</h3><p><a href="../org.apache.nifi.distributed.cache.server.map.DistributedMapCacheServer/index.html">DistributedMapCacheServer</a>, <a href="../../../nifi-ssl-context-service-nar/1.2.0/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></p></body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-distributed-cache-services-nar/1.2.0/org.apache.nifi.distributed.cache.client.DistributedSetCacheClientService/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-distributed-cache-services-nar/1.2.0/org.apache.nifi.distributed.cache.client.DistributedSetCacheClientService/index.html?rev=1794596&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-distributed-cache-services-nar/1.2.0/org.apache.nifi.distributed.cache.client.DistributedSetCacheClientService/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-distributed-cache-services-nar/1.2.0/org.apache.nifi.distributed.cache.client.DistributedSetCacheClientService/index.html Tue May 9 15:27:39 2017 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>DistributedSetCacheClientService</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">DistributedSetCacheClientService</h1><h2>Description: </h2><p>Provides the ability to communicate with a DistributedSetCacheServer. This can be used in order to share a Set between nodes in a NiFi cluster</p><h3>Tags: </h3><p>distributed, cache, state, set, cluster</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>Descript ion</th></tr><tr><td id="name"><strong>Server Hostname</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the server that is running the DistributedSetCacheServer service</td></tr><tr><td id="name"><strong>Server Port</strong></td><td id="default-value">4557</td><td id="allowable-values"></td><td id="description">The port on the remote server that is to be used when communicating with the DistributedSetCacheServer service</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="../../../nifi-ssl-context-service-nar/1.2.0/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td id="description">If specified, indicates the SSL Context Service that is used to communicate with the remote server. If not specified, communications will not be encrypted</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">Specifices how long to wait when communicating with the remote server before determining that there is a communications failure if data cannot be sent or received</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>See Also:</h3><p><a href="../org.apache.nifi.distributed.cache.server.DistributedSetCacheServer/index.html">DistributedSetCacheServer</a>, <a href="../../../nifi-ssl-context-service-nar/1.2.0/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></p></body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-distributed-cache-services-nar/1.2.0/org.apache.nifi.distributed.cache.server.DistributedSetCacheServer/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-distributed-cache-services-nar/1.2.0/org.apache.nifi.distributed.cache.server.DistributedSetCacheServer/index.html?rev=1794596&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-distributed-cache-services-nar/1.2.0/org.apache.nifi.distributed.cache.server.DistributedSetCacheServer/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-distributed-cache-services-nar/1.2.0/org.apache.nifi.distributed.cache.server.DistributedSetCacheServer/index.html Tue May 9 15:27:39 2017 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>DistributedSetCacheServer</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">DistributedSetCacheServer</h1><h2>Description: </h2><p>Provides a set (collection of unique values) cache that can be accessed over a socket. Interaction with this service is typically accomplished via a DistributedSetCacheClient service.</p><h3>Tags: </h3><p>distributed, set, distinct, cache, server</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>Allo wable Values</th><th>Description</th></tr><tr><td id="name"><strong>Port</strong></td><td id="default-value">4557</td><td id="allowable-values"></td><td id="description">The port to listen on for incoming connections</td></tr><tr><td id="name"><strong>Maximum Cache Entries</strong></td><td id="default-value">10000</td><td id="allowable-values"></td><td id="description">The maximum number of cache entries that the cache can hold</td></tr><tr><td id="name"><strong>Eviction Strategy</strong></td><td id="default-value">Least Frequently Used</td><td id="allowable-values"><ul><li>Least Frequently Used</li><li>Least Recently Used</li><li>First In, First Out</li></ul></td><td id="description">Determines which strategy should be used to evict values from the cache to make room for new entries</td></tr><tr><td id="name">Persistence Directory</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">If specified, the cache will be persisted in the given directory; if not specified, the cache will be in-memory only</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="../../../nifi-ssl-context-service-nar/1.2.0/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td id="description">If specified, this service will be used to create an SSL Context that will be used to secure communications; if not specified, communications will not be secure</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-distributed-cache-services-nar/1.2.0/org.apache.nifi.distributed.cache.server.map.DistributedMapCacheServer/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-distributed-cache-services-nar/1.2.0/org.apache.nifi.distributed.cache.server.map.DistributedMapCacheServer/index.html?rev=1794596&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-distributed-cache-services-nar/1.2.0/org.apache.nifi.distributed.cache.server.map.DistributedMapCacheServer/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-distributed-cache-services-nar/1.2.0/org.apache.nifi.distributed.cache.server.map.DistributedMapCacheServer/index.html Tue May 9 15:27:39 2017 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>DistributedMapCacheServer</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">DistributedMapCacheServer</h1><h2>Description: </h2><p>Provides a map (key/value) cache that can be accessed over a socket. Interaction with this service is typically accomplished via a DistributedMapCacheClient service.</p><h3>Tags: </h3><p>distributed, cluster, map, cache, server, key/value</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 Va lues</th><th>Description</th></tr><tr><td id="name"><strong>Port</strong></td><td id="default-value">4557</td><td id="allowable-values"></td><td id="description">The port to listen on for incoming connections</td></tr><tr><td id="name"><strong>Maximum Cache Entries</strong></td><td id="default-value">10000</td><td id="allowable-values"></td><td id="description">The maximum number of cache entries that the cache can hold</td></tr><tr><td id="name"><strong>Eviction Strategy</strong></td><td id="default-value">Least Frequently Used</td><td id="allowable-values"><ul><li>Least Frequently Used</li><li>Least Recently Used</li><li>First In, First Out</li></ul></td><td id="description">Determines which strategy should be used to evict values from the cache to make room for new entries</td></tr><tr><td id="name">Persistence Directory</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">If specified, the cache will be persisted in the given directory; if not spec ified, the cache will be in-memory only</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="../../../nifi-ssl-context-service-nar/1.2.0/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td id="description">If specified, this service will be used to create an SSL Context that will be used to secure communications; if not specified, communications will not be secure</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>See Also:</h3><p><a href="../org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService/index.html">DistributedMapCacheClientService</a>, <a href="../../../nifi-ssl-context-service-nar/1.2.0/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContext Service</a></p></body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-5-nar/1.2.0/org.apache.nifi.processors.elasticsearch.FetchElasticsearch5/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-5-nar/1.2.0/org.apache.nifi.processors.elasticsearch.FetchElasticsearch5/index.html?rev=1794596&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-5-nar/1.2.0/org.apache.nifi.processors.elasticsearch.FetchElasticsearch5/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-5-nar/1.2.0/org.apache.nifi.processors.elasticsearch.FetchElasticsearch5/index.html Tue May 9 15:27:39 2017 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>FetchElasticsearch5</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">FetchElasticsearch5</h1><h2>Description: </h2><p>Retrieves a document from Elasticsearch using the specified connection properties and the identifier of the document to retrieve. If the cluster has been configured for authorization and/or secure transport (SSL/TLS), and the X-Pack plugin is available, secure connections can be made. This processor supports Elasticsearch 5.x clusters.</p><h3>Tags: </h3><p>elasticsearch, elasticsearch 5, fetch, read, get</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>Cluster Name</strong></td><td id="default-value">elasticsearch</td><td id="allowable-values"></td><td id="description">Name of the ES cluster (for example, elasticsearch_brew). Defaults to 'elasticsearch'<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>ElasticSearch Hosts</strong></td><td id="default-value"></td><td id="allowable-values"></td>< td id="description">ElasticSearch Hosts, which should be comma separated and colon for hostname/port host1:port,host2:port,.... For example testcluster:9300. This processor uses the Transport Client to connect to hosts. The default transport client port is 9300.<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="../../../nifi-ssl-context-service-nar/1.2.0/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td id="description">The SSL Context Service used to provide client certificate information for TLS/SSL connections. This service only applies if the Elasticsearch endpoint(s) have been secured with TLS/SSL.</td></tr><tr><td id="name">X-Pack Transport Location</td><td id="default-value"></td><td id="allowable-values"></t d><td id="description">Specifies the path to the JAR(s) for the Elasticsearch X-Pack Transport feature. If the Elasticsearch cluster has been secured with the X-Pack plugin, then the X-Pack Transport JARs must also be available to this processor. Note: Do NOT place the X-Pack JARs into NiFi's lib/ directory, doing so will prevent the X-Pack Transport JARs from being loaded.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Username to access the Elasticsearch cluster<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password to access the Elasticsearch cluster<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>ElasticSearch Ping Timeout</strong></td><td id="default-value">5s</td><td id="allowable-values">< /td><td id="description">The ping timeout used to determine when a node is unreachable. For example, 5s (5 seconds). If non-local recommended is 30s<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Sampler Interval</strong></td><td id="default-value">5s</td><td id="allowable-values"></td><td id="description">How often to sample / ping the nodes listed and connected. For example, 5s (5 seconds). If non-local recommended is 30s.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Document Identifier</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The identifier for the document to be fetched<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Index</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the index to read from<br/><strong>Supports Expression Language: true</s trong></td></tr><tr><td id="name"><strong>Type</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The type of this document (used by Elasticsearch for indexing and searching)<br/><strong>Supports Expression Language: true</strong></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 document data.<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>retry</td><td>A FlowFile is routed to this relationship if the document cannot be fetched but attempting the operation again may succeed</td></tr><tr><td>success</td><td>All FlowFiles that are read from Elasticsearch are routed to this relationship</td></tr><tr><td>failure</td><td>All FlowFiles that cannot be read from Elasticsearch are routed to this relationship</td></tr><tr><td>not found</td><td>A FlowFile is routed to this relationship if the specified document does not exist in the Elasticsearch cluster</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 filename attributes is set to the document identifier</td></tr><tr><td>es.index</td><td>The Elasticsearch index containing the document</td></tr><tr><td>es.type</td><td>The Elasticsearch document type</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-5-nar/1.2.0/org.apache.nifi.processors.elasticsearch.PutElasticsearch5/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-5-nar/1.2.0/org.apache.nifi.processors.elasticsearch.PutElasticsearch5/index.html?rev=1794596&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-5-nar/1.2.0/org.apache.nifi.processors.elasticsearch.PutElasticsearch5/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-5-nar/1.2.0/org.apache.nifi.processors.elasticsearch.PutElasticsearch5/index.html Tue May 9 15:27:39 2017 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutElasticsearch5</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">PutElasticsearch5</h1><h2>Description: </h2><p>Writes the contents of a FlowFile to Elasticsearch, using the specified parameters such as the index to insert into and the type of the document. If the cluster has been configured for authorization and/or secure transport (SSL/TLS), and the X-Pack plugin is available, secure connections can be made. This processor supports Elasticsearch 5.x clusters.</p><h3>Tags: </h3><p>elasticsearch, elasticsearch 5, insert, update, write, put</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any oth er 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>Cluster Name</strong></td><td id="default-value">elasticsearch</td><td id="allowable-values"></td><td id="description">Name of the ES cluster (for example, elasticsearch_brew). Defaults to 'elasticsearch'<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>ElasticSearch Hosts</strong></td><td id="default-value"></td><td id="al lowable-values"></td><td id="description">ElasticSearch Hosts, which should be comma separated and colon for hostname/port host1:port,host2:port,.... For example testcluster:9300. This processor uses the Transport Client to connect to hosts. The default transport client port is 9300.<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="../../../nifi-ssl-context-service-nar/1.2.0/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td id="description">The SSL Context Service used to provide client certificate information for TLS/SSL connections. This service only applies if the Elasticsearch endpoint(s) have been secured with TLS/SSL.</td></tr><tr><td id="name">X-Pack Transport Location</td><td id="default-value"></td><td id= "allowable-values"></td><td id="description">Specifies the path to the JAR(s) for the Elasticsearch X-Pack Transport feature. If the Elasticsearch cluster has been secured with the X-Pack plugin, then the X-Pack Transport JARs must also be available to this processor. Note: Do NOT place the X-Pack JARs into NiFi's lib/ directory, doing so will prevent the X-Pack Transport JARs from being loaded.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Username to access the Elasticsearch cluster<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password to access the Elasticsearch cluster<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>ElasticSearch Ping Timeout</strong></td><td id="default-value">5s</td><td i d="allowable-values"></td><td id="description">The ping timeout used to determine when a node is unreachable. For example, 5s (5 seconds). If non-local recommended is 30s<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Sampler Interval</strong></td><td id="default-value">5s</td><td id="allowable-values"></td><td id="description">How often to sample / ping the nodes listed and connected. For example, 5s (5 seconds). If non-local recommended is 30s.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Identifier Attribute</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the attribute containing the identifier for each FlowFile</td></tr><tr><td id="name"><strong>Index</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the index to insert into<br/><strong>Supports Expression Language: true</strong>< /td></tr><tr><td id="name"><strong>Type</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The type of this document (used by Elasticsearch for indexing and searching)<br/><strong>Supports Expression Language: true</strong></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 document data.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Batch Size</strong></td><td id="default-value">100</td><td id="allowable-values"></td><td id="description">The preferred number of FlowFiles to put to the database in a single transaction<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Index Operation</strong></td><td id="default-value">index</td><td id="allowable-values"></td><td id="description">The type of the operation used to index (index, up date, upsert)<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>retry</td><td>A FlowFile is routed to this relationship if the database cannot be updated but attempting the operation again may succeed</td></tr><tr><td>success</td><td>All FlowFiles that are written to Elasticsearch are routed to this relationship</td></tr><tr><td>failure</td><td>All FlowFiles that cannot be written to Elasticsearch are routed to this relationship</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-nar/1.2.0/org.apache.nifi.processors.elasticsearch.FetchElasticsearch/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-nar/1.2.0/org.apache.nifi.processors.elasticsearch.FetchElasticsearch/index.html?rev=1794596&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-nar/1.2.0/org.apache.nifi.processors.elasticsearch.FetchElasticsearch/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-nar/1.2.0/org.apache.nifi.processors.elasticsearch.FetchElasticsearch/index.html Tue May 9 15:27:39 2017 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>FetchElasticsearch</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">FetchElasticsearch</h1><h2>Description: </h2><p>Retrieves a document from Elasticsearch using the specified connection properties and the identifier of the document to retrieve. If the cluster has been configured for authorization and/or secure transport (SSL/TLS) and the Shield plugin is available, secure connections can be made. This processor supports Elasticsearch 2.x clusters.</p><h3>Tags: </h3><p>elasticsearch, fetch, read, get</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>Cluster Name</strong></td><td id="default-value">elasticsearch</td><td id="allowable-values"></td><td id="description">Name of the ES cluster (for example, elasticsearch_brew). Defaults to 'elasticsearch'<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>ElasticSearch Hosts</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description"> ElasticSearch Hosts, which should be comma separated and colon for hostname/port host1:port,host2:port,.... For example testcluster:9300. This processor uses the Transport Client to connect to hosts. The default transport client port is 9300.<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="../../../nifi-ssl-context-service-nar/1.2.0/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td id="description">The SSL Context Service used to provide client certificate information for TLS/SSL connections. This service only applies if the Elasticsearch endpoint(s) have been secured with TLS/SSL.</td></tr><tr><td id="name">Shield Plugin Filename</td><td id="default-value"></td><td id="allowable-values"></td><td id="description"> Specifies the path to the JAR for the Elasticsearch Shield plugin. If the Elasticsearch cluster has been secured with the Shield plugin, then the Shield plugin JAR must also be available to this processor. Note: Do NOT place the Shield JAR into NiFi's lib/ directory, doing so will prevent the Shield plugin from being loaded.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Username to access the Elasticsearch cluster<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password to access the Elasticsearch cluster<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>ElasticSearch Ping Timeout</strong></td><td id="default-value">5s</td><td id="allowable-val ues"></td><td id="description">The ping timeout used to determine when a node is unreachable. For example, 5s (5 seconds). If non-local recommended is 30s<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Sampler Interval</strong></td><td id="default-value">5s</td><td id="allowable-values"></td><td id="description">How often to sample / ping the nodes listed and connected. For example, 5s (5 seconds). If non-local recommended is 30s.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Document Identifier</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The identifier for the document to be fetched<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Index</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the index to read from<br/><strong>Supports Expression Language: t rue</strong></td></tr><tr><td id="name"><strong>Type</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The type of this document (used by Elasticsearch for indexing and searching)<br/><strong>Supports Expression Language: true</strong></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 document data.<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>retry</td><td>A FlowFile is routed to this relationship if the document cannot be fetched but attempting the operation again may succeed</td></tr><tr><td>success</td><td>All FlowFiles that are read from Elasticsearch are routed to this relationship</td></tr><tr><td>failure</td><td>All FlowFiles that cannot be read from Elasticsearch are routed to this relationship</td></tr><tr><td>not found</td><td>A FlowFile is routed to this relationship if the specified document does not exist in the Elasticsearch cluster</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 filename attributes is set to the document identifier</td></tr><tr><td>es.index</td><td>The Elasticsearch index containing the document</td></tr><tr><td>es.type</td><td>The Elasticsearch document type</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-nar/1.2.0/org.apache.nifi.processors.elasticsearch.FetchElasticsearchHttp/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-nar/1.2.0/org.apache.nifi.processors.elasticsearch.FetchElasticsearchHttp/index.html?rev=1794596&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-nar/1.2.0/org.apache.nifi.processors.elasticsearch.FetchElasticsearchHttp/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-nar/1.2.0/org.apache.nifi.processors.elasticsearch.FetchElasticsearchHttp/index.html Tue May 9 15:27:39 2017 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>FetchElasticsearchHttp</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">FetchElasticsearchHttp</h1><h2>Description: </h2><p>Retrieves a document from Elasticsearch using the specified connection properties and the identifier of the document to retrieve. Note that the full body of the document will be read into memory before being written to a Flow File for transfer.</p><h3>Tags: </h3><p>elasticsearch, fetch, read, get, http</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 sup ports 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>Elasticsearch URL</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Elasticsearch URL which will be connected to, including scheme (http, e.g.), host, and port. The default port for the REST API is 9200.<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>Imp lementation:</strong><br/><a href="../../../nifi-ssl-context-service-nar/1.2.0/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td id="description">The SSL Context Service used to provide client certificate information for TLS/SSL connections. This service only applies if the Elasticsearch endpoint(s) have been secured with TLS/SSL.</td></tr><tr><td id="name">Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Username to access the Elasticsearch cluster<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password to access the Elasticsearch cluster<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Connection Timeout</strong></td><td id="default-value">5 secs</td><td id="allowable-values"></t d><td id="description">Max wait time for the connection to the Elasticsearch REST API.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Response Timeout</strong></td><td id="default-value">15 secs</td><td id="allowable-values"></td><td id="description">Max wait time for a response from the Elasticsearch REST API.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Document Identifier</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The identifier of the document to be fetched<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Index</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the index to read from.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Type</td><td id="default-value"></td><td id="allowable-values"></td><td id="descri ption">The (optional) type of this document, used by Elasticsearch for indexing and searching. If the property is empty, the first document matching the identifier across all types will be retrieved.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Fields</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A comma-separated list of fields to retrieve from the document. If the Fields property is left blank, then the entire document's source will be retrieved.<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>retry</td><td>A FlowFile is routed to this relationship if the document cannot be fetched but attempting the operation again may succeed. Note that if the processor has no incoming connections, flow files may still be sent to this relationship based on the processor properties and the results o f the fetch operation.</td></tr><tr><td>success</td><td>All FlowFiles that are read from Elasticsearch are routed to this relationship.</td></tr><tr><td>failure</td><td>All FlowFiles that cannot be read from Elasticsearch are routed to this relationship. Note that only incoming flow files will be routed to failure.</td></tr><tr><td>not found</td><td>A FlowFile is routed to this relationship if the specified document does not exist in the Elasticsearch cluster. Note that if the processor has no incoming connections, flow files may still be sent to this relationship based on the processor properties and the results of the fetch operation.</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 filename attribute is set to the document identifier</td></tr><tr><td>es.index</td><td>The Elasticsearch index containing the document</td></tr><tr><td>es.type</td> <td>The Elasticsearch document type</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-nar/1.2.0/org.apache.nifi.processors.elasticsearch.PutElasticsearch/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-nar/1.2.0/org.apache.nifi.processors.elasticsearch.PutElasticsearch/index.html?rev=1794596&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-nar/1.2.0/org.apache.nifi.processors.elasticsearch.PutElasticsearch/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-nar/1.2.0/org.apache.nifi.processors.elasticsearch.PutElasticsearch/index.html Tue May 9 15:27:39 2017 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutElasticsearch</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">PutElasticsearch</h1><h2>Description: </h2><p>Writes the contents of a FlowFile to Elasticsearch, using the specified parameters such as the index to insert into and the type of the document. If the cluster has been configured for authorization and/or secure transport (SSL/TLS) and the Shield plugin is available, secure connections can be made. This processor supports Elasticsearch 2.x clusters.</p><h3>Tags: </h3><p>elasticsearch, insert, update, write, put</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not i n 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>Cluster Name</strong></td><td id="default-value">elasticsearch</td><td id="allowable-values"></td><td id="description">Name of the ES cluster (for example, elasticsearch_brew). Defaults to 'elasticsearch'<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>ElasticSearch Hosts</strong></td><td id="default-value"></td><td id="allowable-values"></td ><td id="description">ElasticSearch Hosts, which should be comma separated and >colon for hostname/port host1:port,host2:port,.... For example >testcluster:9300. This processor uses the Transport Client to connect to >hosts. The default transport client port is 9300.<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="../../../nifi-ssl-context-service-nar/1.2.0/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td > id="description">The SSL Context Service used to provide client certificate >information for TLS/SSL connections. This service only applies if the >Elasticsearch endpoint(s) have been secured with TLS/SSL.</td></tr><tr><td >id="name">Shield Plugin Filename</td><td id="default-value"></td><td >id="allowable-values"></td ><td id="description">Specifies the path to the JAR for the Elasticsearch >Shield plugin. If the Elasticsearch cluster has been secured with the Shield >plugin, then the Shield plugin JAR must also be available to this processor. >Note: Do NOT place the Shield JAR into NiFi's lib/ directory, doing so will >prevent the Shield plugin from being loaded.<br/><strong>Supports Expression >Language: true</strong></td></tr><tr><td id="name">Username</td><td >id="default-value"></td><td id="allowable-values"></td><td >id="description">Username to access the Elasticsearch >cluster<br/><strong>Supports Expression Language: >true</strong></td></tr><tr><td id="name">Password</td><td >id="default-value"></td><td id="allowable-values"></td><td >id="description">Password to access the Elasticsearch >cluster<br/><strong>Sensitive Property: true</strong><br/><strong>Supports >Expression Language: true</strong></td></tr><tr><td >id="name"><strong>ElasticSearch Ping Timeout</strong></td><td >id="default-value">5s</td ><td id="allowable-values"></td><td id="description">The ping timeout used to >determine when a node is unreachable. For example, 5s (5 seconds). If >non-local recommended is 30s<br/><strong>Supports Expression Language: >true</strong></td></tr><tr><td id="name"><strong>Sampler >Interval</strong></td><td id="default-value">5s</td><td >id="allowable-values"></td><td id="description">How often to sample / ping >the nodes listed and connected. For example, 5s (5 seconds). If non-local >recommended is 30s.<br/><strong>Supports Expression Language: >true</strong></td></tr><tr><td id="name"><strong>Identifier >Attribute</strong></td><td id="default-value"></td><td >id="allowable-values"></td><td id="description">The name of the attribute >containing the identifier for each FlowFile</td></tr><tr><td >id="name"><strong>Index</strong></td><td id="default-value"></td><td >id="allowable-values"></td><td id="description">The name of the index to >insert into<br/><strong>Supports Expression Language: true</st rong></td></tr><tr><td id="name"><strong>Type</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The type of this document (used by Elasticsearch for indexing and searching)<br/><strong>Supports Expression Language: true</strong></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 document data.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Batch Size</strong></td><td id="default-value">100</td><td id="allowable-values"></td><td id="description">The preferred number of FlowFiles to put to the database in a single transaction<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Index Operation</strong></td><td id="default-value">index</td><td id="allowable-values"></td><td id="description">The type of the operation used to index (ind ex, update, upsert)<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>retry</td><td>A FlowFile is routed to this relationship if the database cannot be updated but attempting the operation again may succeed</td></tr><tr><td>success</td><td>All FlowFiles that are written to Elasticsearch are routed to this relationship</td></tr><tr><td>failure</td><td>All FlowFiles that cannot be written to Elasticsearch are routed to this relationship</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.</body></html> \ No newline at end of file
