Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-couchbase-nar/1.11.2/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.11.2/org.apache.nifi.processors.couchbase.GetCouchbaseKey/index.html?rev=1874204&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-couchbase-nar/1.11.2/org.apache.nifi.processors.couchbase.GetCouchbaseKey/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-couchbase-nar/1.11.2/org.apache.nifi.processors.couchbase.GetCouchbaseKey/index.html Wed Feb 19 18:04:18 2020 @@ -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><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.<br/><strong>Supports Expression Language: true (wil l be evaluated using variable registry only)</strong></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, fixed Couchbase document id, or an expression to construct the Couchbase document id.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Put Value to Attribute</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">If set, the retrieved value will be put into an attribute of the FlowFile instead of a the content of the FlowFile. The attribute key to put to is determined by evaluating value of this property.<br/><strong>Supports Expression Language: true (will be evaluate d using flow file attributes and variable registry)</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 failed to fetch from Couchbase Server but can be retried are routed to this relationship.</td></tr><tr><td>success</td><td>Values retrieved from Couchbase Server are written as outgoing FlowFiles content or put into an attribute of the incoming FlowFile and routed to this relationship.</td></tr><tr><td>failure</td><td>All FlowFiles failed to fetch from Couchbase Server and not retry-able are routed to this relationship.</td></tr><tr><td>original</td><td>The original input FlowFile is routed to this relationship when the value is retrieved from Couchbase Server and routed to 'success'.</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>Cluste r 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>Input requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</h3><table id="system-resource-considerations"><tr><th>Resource</th><th>Description</th></tr><tr><td>MEMORY</td><td>An instance of this component can cause high usage of this system resource. Multiple instances or high concurrency settings may result a degradation of performance.</td ></tr></table></body></html> \ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-couchbase-nar/1.11.2/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.11.2/org.apache.nifi.processors.couchbase.PutCouchbaseKey/index.html?rev=1874204&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-couchbase-nar/1.11.2/org.apache.nifi.processors.couchbase.PutCouchbaseKey/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-couchbase-nar/1.11.2/org.apache.nifi.processors.couchbase.PutCouchbaseKey/index.html Wed Feb 19 18:04:18 2020 @@ -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><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.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></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, fixed Couchbase document id, or an expression to construct the Couchbase document id.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</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 failed to be 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 failed to be written to Couchbase Server and not retry-able 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>Input requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</h3><table id="system-resource-considerations"><tr><th>Resource</th><th>Description</th></tr><tr><td>MEMORY</td><td>An instance of this component can cause high usage of this system resource. Multiple instances or high concurrency settings may result a degradation of performance.</td></tr></table></body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-cybersecurity-nar/1.11.2/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.11.2/org.apache.nifi.processors.cybersecurity.CompareFuzzyHash/index.html?rev=1874204&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-cybersecurity-nar/1.11.2/org.apache.nifi.processors.cybersecurity.CompareFuzzyHash/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-cybersecurity-nar/1.11.2/org.apache.nifi.processors.cybersecurity.CompareFuzzyHash/index.html Wed Feb 19 18:04:18 2020 @@ -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>Input requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</h3>None specified.<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.11.2/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.11.2/org.apache.nifi.processors.cybersecurity.FuzzyHashContent/index.html?rev=1874204&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-cybersecurity-nar/1.11.2/org.apache.nifi.processors.cybersecurity.FuzzyHashContent/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-cybersecurity-nar/1.11.2/org.apache.nifi.processors.cybersecurity.FuzzyHashContent/index.html Wed Feb 19 18:04:18 2020 @@ -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>Input requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</h3>None specified.<h3>See Also:</h3><p><a href="../org.apache.nifi.processors.cybersecurity.CompareFuzzyHash/index.html">CompareFuzzyHash</a>, <a href="../../../nifi-standard-nar/1.11.2/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.11.2/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.11.2/org.apache.nifi.reporting.datadog.DataDogReportingTask/additionalDetails.html?rev=1874204&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-datadog-nar/1.11.2/org.apache.nifi.reporting.datadog.DataDogReportingTask/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-datadog-nar/1.11.2/org.apache.nifi.reporting.datadog.DataDogReportingTask/additionalDetails.html Wed Feb 19 18:04:18 2020 @@ -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.11.2/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.11.2/org.apache.nifi.reporting.datadog.DataDogReportingTask/index.html?rev=1874204&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-datadog-nar/1.11.2/org.apache.nifi.reporting.datadog.DataDogReportingTask/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-datadog-nar/1.11.2/org.apache.nifi.reporting.datadog.DataDogReportingTask/index.html Wed Feb 19 18:04:18 2020 @@ -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 (will be evaluated using variable registry only)</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 (will be evaluated using variable registry only)</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>Data dog 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.<h3>System Resource Consid erations:</h3>None specified.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-dbcp-service-nar/1.11.2/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.11.2/org.apache.nifi.dbcp.DBCPConnectionPool/index.html?rev=1874204&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-dbcp-service-nar/1.11.2/org.apache.nifi.dbcp.DBCPConnectionPool/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-dbcp-service-nar/1.11.2/org.apache.nifi.dbcp.DBCPConnectionPool/index.html Wed Feb 19 18:04:18 2020 @@ -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 (will be evaluated using variable registry only)</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/><st rong>Supports Expression Language: true (will be evaluated using variable registry only)</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 (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Kerberos Credentials Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>KerberosCredentialsService<br/><strong>Implementation: </strong><a href="../../../nifi-kerberos-credentials-service-nar/1.11.2/org.apache.nifi.kerberos.KeytabCredentialsService/index.html">KeytabCredentialsService</a></td><td id="description">Specifies the Kerberos Credentials Controller Service that should be used for authenticating with Kerberos</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 (will be evaluated using variable registry only)</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 (will be evaluated using variable registry only)</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 the pool will wait (when there are no available connections) for a connection to be returned before failing, or -1 to wait indefinitely. <br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong> </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.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></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 (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Minimum Idle Connections</td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">The minimum number of connect ions that can remain idle in the pool, without extra ones being created, or zero to create none.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Max Idle Connections</td><td id="default-value">8</td><td id="allowable-values"></td><td id="description">The maximum number of connections that can remain idle in the pool, without extra ones being released, or negative for no limit.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Max Connection Lifetime</td><td id="default-value">-1</td><td id="allowable-values"></td><td id="description">The maximum lifetime in milliseconds of a connection. After this time is exceeded the connection will fail the next activation, passivation or validation test. A value of zero or less means the connection has an infinite lifetime.<br/><strong>Supports Expression Language: true (will be eval uated using variable registry only)</strong></td></tr><tr><td id="name">Time Between Eviction Runs</td><td id="default-value">-1</td><td id="allowable-values"></td><td id="description">The number of milliseconds to sleep between runs of the idle connection evictor thread. When non-positive, no idle connection evictor thread will be run.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Minimum Evictable Idle Time</td><td id="default-value">30 mins</td><td id="allowable-values"></td><td id="description">The minimum amount of time a connection may sit idle in the pool before it is eligible for eviction.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Soft Minimum Evictable Idle Time</td><td id="default-value">-1</td><td id="allowable-values"></td><td id="description">The minimum amount of time a connection may sit idle in the pool before it is eligible for eviction by the idle connection evictor, with the extra condition that at least a minimum number of idle connections remain in the pool. When the not-soft version of this option is set to a positive value, it is examined first by the idle connection evictor: when idle connections are visited by the evictor, idle time is first compared against it (without considering the number of idle connections in the pool) and then against this soft option, including the minimum idle connections constraint.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</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 J DBC 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 (will be evaluated using variable registry only)</strong></td></tr></table></p><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>System Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-dbcp-service-nar/1.11.2/org.apache.nifi.dbcp.DBCPConnectionPoolLookup/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-dbcp-service-nar/1.11.2/org.apache.nifi.dbcp.DBCPConnectionPoolLookup/index.html?rev=1874204&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-dbcp-service-nar/1.11.2/org.apache.nifi.dbcp.DBCPConnectionPoolLookup/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-dbcp-service-nar/1.11.2/org.apache.nifi.dbcp.DBCPConnectionPoolLookup/index.html Wed Feb 19 18:04:18 2020 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>DBCPConnectionPoolLookup</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;">DBCPConnectionPoolLookup</h1><h2>Description: </h2><p>Provides a DBCPService that can be used to dynamically select another DBCPService. This service requires an attribute named 'database.name' to be passed in when asking for a connection, and will throw an exception if the attribute is missing. The value of 'database.name' will be used to select the DBCPService that has been registered with that name. This will allow multiple DBCPServices to be defined and registered, and then selected dynamically at runtime by tagging flow files with the appropriate 'database.name' attribute.</p><h3>T ags: </h3><p>dbcp, jdbc, database, connection, pooling, store</p><h3>Properties: </h3><p>This component has no required or optional properties.</p><h3>Dynamic Properties: </h3><p>Dynamic Properties allow the user to specify both the name and value of a property.<table id="dynamic-properties"><tr><th>Name</th><th>Value</th><th>Description</th></tr><tr><td id="name">The name to register DBCPService</td><td id="value">The DBCPService</td><td>If 'database.name' attribute contains the name of the dynamic property, then the DBCPService (registered in the value) will be selected.<br/><strong>Supports Expression Language: false</strong></td></tr></table></p><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>System Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-dbcp-service-nar/1.11.2/org.apache.nifi.record.sink.db.DatabaseRecordSink/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-dbcp-service-nar/1.11.2/org.apache.nifi.record.sink.db.DatabaseRecordSink/index.html?rev=1874204&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-dbcp-service-nar/1.11.2/org.apache.nifi.record.sink.db.DatabaseRecordSink/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-dbcp-service-nar/1.11.2/org.apache.nifi.record.sink.db.DatabaseRecordSink/index.html Wed Feb 19 18:04:18 2020 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>DatabaseRecordSink</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;">DatabaseRecordSink</h1><h2>Description: </h2><p>Provides a service to write records using a configured database connection.</p><h3>Tags: </h3><p>db, jdbc, database, connection, record</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>Al lowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Database Connection Pooling Service</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>DBCPService<br/><strong>Implementations: </strong><a href="../org.apache.nifi.dbcp.DBCPConnectionPoolLookup/index.html">DBCPConnectionPoolLookup</a><br/><a href="../../../nifi-hive-nar/1.11.2/org.apache.nifi.dbcp.hive.HiveConnectionPool/index.html">HiveConnectionPool</a><br/><a href="../org.apache.nifi.dbcp.DBCPConnectionPool/index.html">DBCPConnectionPool</a></td><td id="description">The Controller Service that is used to obtain a connection to the database for sending records.</td></tr><tr><td id="name">Catalog Name</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the catalog that the statement should update. This may not apply for the database that you are updating. In this case, leave the field empty<br/><strong>Suppo rts Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Schema Name</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the schema that the table belongs to. This may not apply for the database that you are updating. In this case, leave the field empty<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Table Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the table that the statement should affect.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Translate Field Names</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 Processor will attempt to translate field names into the appropriate column names for the table specified. If false, the field names must match the column names exactly, or the column will not be updated</td></tr><tr><td id="name">Unmatched Field Behavior</td><td id="default-value">Ignore Unmatched Fields</td><td id="allowable-values"><ul><li>Ignore Unmatched Fields <img src="../../../../../html/images/iconInfo.png" alt="Any field in the document that cannot be mapped to a column in the database is ignored" title="Any field in the document that cannot be mapped to a column in the database is ignored"></img></li><li>Fail on Unmatched Fields <img src="../../../../../html/images/iconInfo.png" alt="If the document has any field that cannot be mapped to a column in the database, the FlowFile will be routed to the failure relationship" title="If the document has any field that cannot be mapped to a column in the database, the FlowFile will be routed to the failure relationship"> </img></li></ul></td><td id="description">If an incoming record has a field that does not map to any of the database table's columns, this property specifies how to handle the situation</td></tr><tr><td id="name">Unmatched Column Behavior</td><td id="default-value">Fail on Unmatched Columns</td><td id="allowable-values"><ul><li>Ignore Unmatched Columns <img src="../../../../../html/images/iconInfo.png" alt="Any column in the database that does not have a field in the document will be assumed to not be required. No notification will be logged" title="Any column in the database that does not have a field in the document will be assumed to not be required. No notification will be logged"></img></li><li>Warn on Unmatched Columns <img src="../../../../../html/images/iconInfo.png" alt="Any column in the database that does not have a field in the document will be assumed to not be required. A warning will be logged" title="Any column in the database that does not have a field in the doc ument will be assumed to not be required. A warning will be logged"></img></li><li>Fail on Unmatched Columns <img src="../../../../../html/images/iconInfo.png" alt="A flow will fail if any column in the database that does not have a field in the document. An error will be logged" title="A flow will fail if any column in the database that does not have a field in the document. An error will be logged"></img></li></ul></td><td id="description">If an incoming record does not have a field mapping for all of the database table's columns, this property specifies how to handle the situation</td></tr><tr><td id="name">Quote Column Identifiers</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Enabling this option will cause all column names to be quoted, allowing you to use reserved words as column names in your tables.</td></tr><tr><td id="name">Quote Table Identifiers</td><td id="default-value">false</td><td id=" allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Enabling this option will cause the table name to be quoted to support the use of special characters in the table name.</td></tr><tr><td id="name"><strong>Max Wait Time</strong></td><td id="default-value">0 seconds</td><td id="allowable-values"></td><td id="description">The maximum amount of time allowed for a running SQL statement , zero means there is no limit. Max time less than 1 second will be equal to zero.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>System Resource Considerations:</h3>None specified.</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.11.2/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.11.2/org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService/index.html?rev=1874204&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-distributed-cache-services-nar/1.11.2/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.11.2/org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService/index.html Wed Feb 19 18:04:18 2020 @@ -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>Implementations: </strong><a href="../../../nifi-ssl-context-service-nar/1.11.2/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</a><br/><a href="../../../nifi-ssl-context-service-nar/1.11.2/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></t d><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>System Resource Considerations:</h3>None specified.<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.11.2/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.11.2/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.11.2/org.apache.nifi.distributed.cache.client.DistributedSetCacheClientService/index.html?rev=1874204&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-distributed-cache-services-nar/1.11.2/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.11.2/org.apache.nifi.distributed.cache.client.DistributedSetCacheClientService/index.html Wed Feb 19 18:04:18 2020 @@ -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>Implementations: </strong><a href="../../../nifi-ssl-context-service-nar/1.11.2/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</a><br/><a href="../../../nifi-ssl-context-service-nar/1.11.2/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></t d><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>System Resource Considerations:</h3>None specified.<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.11.2/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.11.2/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.11.2/org.apache.nifi.distributed.cache.server.DistributedSetCacheServer/index.html?rev=1874204&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-distributed-cache-services-nar/1.11.2/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.11.2/org.apache.nifi.distributed.cache.server.DistributedSetCacheServer/index.html Wed Feb 19 18:04:18 2020 @@ -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/>RestrictedSSLContextService<br/><strong>Implementation: </strong><a href="../../../nifi-ssl-context-service-nar/1.11.2/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</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>System Resource Considerations:</h3>None specified.</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.11.2/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.11.2/org.apache.nifi.distributed.cache.server.map.DistributedMapCacheServer/index.html?rev=1874204&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-distributed-cache-services-nar/1.11.2/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.11.2/org.apache.nifi.distributed.cache.server.map.DistributedMapCacheServer/index.html Wed Feb 19 18:04:18 2020 @@ -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/>RestrictedSSLContextService<br/><strong>Implementation: </strong><a href="../../../nifi-ssl-context-service-nar/1.11.2/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</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>System Resource Considerations:</h3>None specified.<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.11.2/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-elasticsearch-5-nar/1.11.2/org.apache.nifi.processors.elasticsearch.DeleteElasticsearch5/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-5-nar/1.11.2/org.apache.nifi.processors.elasticsearch.DeleteElasticsearch5/index.html?rev=1874204&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-5-nar/1.11.2/org.apache.nifi.processors.elasticsearch.DeleteElasticsearch5/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-5-nar/1.11.2/org.apache.nifi.processors.elasticsearch.DeleteElasticsearch5/index.html Wed Feb 19 18:04:18 2020 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>DeleteElasticsearch5</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;">DeleteElasticsearch5</h1><h2>Description: </h2><p>Delete a document from Elasticsearch 5.0 by document id. 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.</p><h3>Tags: </h3><p>elasticsearch, elasticsearch 5, delete, remove</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 (will be evaluated using variable registry only)</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 (will be evaluated using variable registry only)</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>Implementations: </strong><a href="../../../nifi-ssl-context-service-nar/1.11.2/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</a><br/><a href="../../../nifi-ssl-context-service-nar/1.11.2/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 (will be evaluated using variable registry only)</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 (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="d escription">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 (will be evaluated using variable registry only)</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 (will be evaluated using variable registry only)</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 deleted<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</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 delete the document from<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</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 to be deleted<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</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 deleted because or retryable exception like timeout or node not available</td></tr><tr><td>success</td><td>All FlowFile corresponding to the deleted document from Elasticsearch are routed to this relationship</td></tr><tr><td>failure</td><td>All FlowFile corresponding to delete document that failed 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 was not found in elasticsearch</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>es.error.message</td><td>The message attribute in case of error</td></tr><tr><td>filename</td><td>The filename attribute which 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><tr><td>es.rest.status</td><td>The filename attribute with rest status</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</h3>None specified.<h3>See Also:</h3><p><a href="../org.apache.nifi.processors.elasticsearch.FetchElasticsearch5/index.html">FetchElasticsearch5</a>, <a href="../org.apache.nifi.processors.elasticsearch.PutElasticsearch5/index.html">PutElasticsearch5</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.11.2/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.11.2/org.apache.nifi.processors.elasticsearch.FetchElasticsearch5/index.html?rev=1874204&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-5-nar/1.11.2/org.apache.nifi.processors.elasticsearch.FetchElasticsearch5/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-5-nar/1.11.2/org.apache.nifi.processors.elasticsearch.FetchElasticsearch5/index.html Wed Feb 19 18:04:18 2020 @@ -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 (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>ElasticSearch Hosts</strong></td><td id="def ault-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 (will be evaluated using variable registry only)</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>Implementations: </strong><a href="../../../nifi-ssl-context-service-nar/1.11.2/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</a><br/><a href="../../../nifi-ssl-context-service-nar/1.11.2/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 (will be evaluated using variable registry only)</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 (will be evaluated using variable registr y only)</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 (will be evaluated using variable registry only)</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 (will be evaluated using variable registry only)</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 (will be evaluated using flow file attributes and variable registry)</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 (will be evaluated using flow file attributes and variable registry)</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 (will be evaluated using flow file attributes and variable registry)</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 (will be evaluated using flow file attributes and variable registry)</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="write s-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.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</h3>None specified.<h3>See Also:</h3><p><a href="../org.apache.nifi.processors.elasticsearch.DeleteElasticsearch5/index.html">DeleteElasticsearch5</a>, <a href="../org.apache.nifi.processors.elasticsearch.PutElasticsearch5/index.html">PutElasticsearch5</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.11.2/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.11.2/org.apache.nifi.processors.elasticsearch.PutElasticsearch5/index.html?rev=1874204&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-5-nar/1.11.2/org.apache.nifi.processors.elasticsearch.PutElasticsearch5/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-5-nar/1.11.2/org.apache.nifi.processors.elasticsearch.PutElasticsearch5/index.html Wed Feb 19 18:04:18 2020 @@ -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 (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>ElasticSearch Hosts</s trong></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 (will be evaluated using variable registry only)</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>Implementations: </strong><a href="../../../nifi-ssl-context-service-nar/1.11.2/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</a><br/><a href="../../../nifi-ssl-context-service-nar/1.11.2/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td id="description">The SSL Context S ervice 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 (will be evaluated using variable registry only)</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 (will be evaluated using variable registry only)</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 (will be evaluated using variable registry only)</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 (will be evaluated using variable registry onl y)</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 (will be evaluated using flow file attributes and variable registry)</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 (will be evaluated using flow file attributes and variable registry)</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="d escription">Specifies the character set of the document data.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</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 (will be evaluated using variable registry only)</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, update, upsert)<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</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.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</h3><table id="system-resource-considerations"><tr><th>Resource</th><th>Description</th></tr><tr><td>MEMORY</td><td>An instance of this component can cause high usage of this system resource. Multiple instances or high concurrency settings may result a degradation of performance.</td></tr></table><h3>See Also:</h3><p><a href="../org.apache.nifi.processors.elasticsearch.FetchElasticsearch5/index.html">FetchElasticsearch5</a>, <a href="index.html">PutElasticsearch5</a></p></body></html> \ No newline at end of file
