You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nifi.apache.org by al...@apache.org on 2019/02/22 01:03:50 UTC
svn commit: r1854109 [21/50] - in /nifi/site/trunk/docs/nifi-docs: ./
components/org.apache.nifi/nifi-ambari-nar/1.9.0/
components/org.apache.nifi/nifi-ambari-nar/1.9.0/org.apache.nifi.reporting.ambari.AmbariReportingTask/
components/org.apache.nifi/ni...
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kite-nar/1.9.0/org.apache.nifi.processors.kite.ConvertCSVToAvro/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kite-nar/1.9.0/org.apache.nifi.processors.kite.ConvertCSVToAvro/index.html?rev=1854109&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kite-nar/1.9.0/org.apache.nifi.processors.kite.ConvertCSVToAvro/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kite-nar/1.9.0/org.apache.nifi.processors.kite.ConvertCSVToAvro/index.html Fri Feb 22 01:03:44 2019
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ConvertCSVToAvro</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;">ConvertCSVToAvro</h1><h2>Description: </h2><p>Converts CSV files to Avro according to an Avro Schema</p><h3>Tags: </h3><p>kite, csv, avro</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr>
<td id="name">Hadoop configuration Resources</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A file or comma separated list of files which contains the Hadoop file system configuration. Without this, Hadoop will search the classpath for a 'core-site.xml' and 'hdfs-site.xml' file or will revert to a default configuration.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Record schema</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Outgoing Avro schema for each record created from a CSV row<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">CSV charset</td><td id="default-value">utf8</td><td id="allowable-values"></td><td id="description">Character set for CSV files<br/><strong>Supports Expression Language: true (wil
l be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">CSV delimiter</td><td id="default-value">,</td><td id="allowable-values"></td><td id="description">Delimiter character for CSV records<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">CSV quote character</td><td id="default-value">"</td><td id="allowable-values"></td><td id="description">Quote character for CSV values<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">CSV escape character</td><td id="default-value">\</td><td id="allowable-values"></td><td id="description">Escape character for CSV values<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Use CSV header line</td><td id=
"default-value">false</td><td id="allowable-values"></td><td id="description">Whether to use the first line as a header<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Lines to skip</td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">Number of lines to skip before reading header or data<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Compression type</td><td id="default-value">SNAPPY</td><td id="allowable-values"><ul><li>BZIP2</li><li>DEFLATE</li><li>NONE</li><li>SNAPPY</li><li>LZO</li></ul></td><td id="description">Compression type to use when writting Avro files. Default is Snappy.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Avro content that was converted
successfully from CSV</td></tr><tr><td>failure</td><td>CSV content that could not be processed</td></tr><tr><td>incompatible</td><td>CSV content that could not be converted</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>None specified.</body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kite-nar/1.9.0/org.apache.nifi.processors.kite.ConvertJSONToAvro/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kite-nar/1.9.0/org.apache.nifi.processors.kite.ConvertJSONToAvro/index.html?rev=1854109&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kite-nar/1.9.0/org.apache.nifi.processors.kite.ConvertJSONToAvro/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kite-nar/1.9.0/org.apache.nifi.processors.kite.ConvertJSONToAvro/index.html Fri Feb 22 01:03:44 2019
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ConvertJSONToAvro</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;">ConvertJSONToAvro</h1><h2>Description: </h2><p>Converts JSON files to Avro according to an Avro Schema</p><h3>Tags: </h3><p>kite, json, avro</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr>
<tr><td id="name">Hadoop configuration Resources</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A file or comma separated list of files which contains the Hadoop file system configuration. Without this, Hadoop will search the classpath for a 'core-site.xml' and 'hdfs-site.xml' file or will revert to a default configuration.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Record schema</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Outgoing Avro schema for each record created from a JSON object<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Compression type</td><td id="default-value">SNAPPY</td><td id="allowable-values"><ul><li>BZIP2</li><li>DEFLATE</li><li>NONE</li><li>SNAPPY</li><li>LZO</li></ul></td><td id
="description">Compression type to use when writting Avro files. Default is Snappy.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Avro content that was converted successfully from JSON</td></tr><tr><td>failure</td><td>JSON content that could not be processed</td></tr><tr><td>incompatible</td><td>JSON content that could not be converted</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>None specified.</body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kite-nar/1.9.0/org.apache.nifi.processors.kite.InferAvroSchema/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kite-nar/1.9.0/org.apache.nifi.processors.kite.InferAvroSchema/index.html?rev=1854109&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kite-nar/1.9.0/org.apache.nifi.processors.kite.InferAvroSchema/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kite-nar/1.9.0/org.apache.nifi.processors.kite.InferAvroSchema/index.html Fri Feb 22 01:03:44 2019
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>InferAvroSchema</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">InferAvroSchema</h1><h2>Description: </h2><p>Examines the contents of the incoming FlowFile to infer an Avro schema. The processor will use the Kite SDK to make an attempt to automatically generate an Avro schema from the incoming content. When inferring the schema from JSON data the key names will be used in the resulting Avro schema definition. When inferring from CSV data a "header definition" must be present either as the first line of the incoming data or the "header definition" must be explicitly set in the property "CSV Header Definition". A "header definition" is simply a single comma se
parated line defining the names of each column. The "header definition" is required in order to determine the names that should be given to each field in the resulting Avro definition. When inferring data types the higher order data type is always used if there is ambiguity. For example when examining numerical values the type may be set to "long" instead of "integer" since a long can safely hold the value of any "integer". Only CSV and JSON content is currently supported for automatically inferring an Avro schema. The type of content present in the incoming FlowFile is set by using the property "Input Content Type". The property can either be explicitly set to CSV, JSON, or "use mime.type value" which will examine the value of the mime.type attribute on the incoming FlowFile to determine the type of content present.</p><h3>Tags: </h3><p>kite, avro, infer, schema, csv, json</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>
. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Schema Output Destination</strong></td><td id="default-value">flowfile-content</td><td id="allowable-values"><ul><li>flowfile-attribute</li><li>flowfile-content</li></ul></td><td id="description">Control if Avro schema is written as a new flowfile attribute 'inferred.avro.schema' or written in the flowfile content. Writing to flowfile content will overwrite any existing flowfile content.</td></tr><tr><td id="name"><strong>Input Content Type</strong></td><td id="default-value">use mime.type value</td><td id="allowable-values"><ul><li>use mime.type value</li><li>json</li><li>csv</li></ul></td><td id="description">Con
tent Type of data present in the incoming FlowFile's content. Only "json" or "csv" are supported. If this value is set to "use mime.type value" the incoming Flowfile's attribute "MIME_TYPE" will be used to determine the Content Type.</td></tr><tr><td id="name">CSV Header Definition</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">This property only applies to CSV content type. Comma separated string defining the column names expected in the CSV data. EX: "fname,lname,zip,address". The elements present in this string should be in the same order as the underlying data. Setting this property will cause the value of "Get CSV Header Definition From Data" to be ignored instead using this value.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Get CSV Header Definition From Data</strong></td><td id="default-value">true</td><td id="allowable-value
s"><ul><li>true</li><li>false</li></ul></td><td id="description">This property only applies to CSV content type. If "true" the processor will attempt to read the CSV header definition from the first line of the input data.</td></tr><tr><td id="name"><strong>CSV Header Line Skip Count</strong></td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">This property only applies to CSV content type. Specifies the number of lines that should be skipped when reading the CSV data. Setting this value to 0 is equivalent to saying "the entire contents of the file should be read". If the property "Get CSV Header Definition From Data" is set then the first line of the CSV file will be read in and treated as the CSV header definition. Since this will remove the header line from the data care should be taken to make sure the value of "CSV header Line Skip Count" is set to 0 to ensure no data is skipped.<br/><strong>Supports Expression Language: true (will be evaluated
using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">CSV delimiter</td><td id="default-value">,</td><td id="allowable-values"></td><td id="description">Delimiter character for CSV records<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>CSV Escape String</strong></td><td id="default-value">\</td><td id="allowable-values"></td><td id="description">This property only applies to CSV content type. String that represents an escape sequence in the CSV FlowFile content data.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>CSV Quote String</strong></td><td id="default-value">'</td><td id="allowable-values"></td><td id="description">This property only applies to CSV content type. String that represents a literal quote character in the CSV
FlowFile content data.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Pretty Avro Output</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If true the Avro output will be formatted.</td></tr><tr><td id="name"><strong>Avro Record Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Value to be placed in the Avro record schema "name" field. The value must adhere to the Avro naming rules for fullname. If Expression Language is present then the evaluated value must adhere to the Avro naming rules.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Number Of Records To Analyze</strong></td><td id="default-value">10</td><td id="allowable-values"
></td><td id="description">This property only applies to JSON content type. The number of JSON records that should be examined to determine the Avro schema. The higher the value the better chance kite has of detecting the appropriate type. However the default value of 10 is almost always enough.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Charset</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">Character encoding of CSV data.<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>unsupported content</td><td>The content found in the flowfile content is not of the required format.</td></tr><tr><td>success</td><td>Successfully created Avro
schema from data.</td></tr><tr><td>failure</td><td>Failed to create Avro schema from data.</td></tr><tr><td>original</td><td>Original incoming FlowFile data</td></tr></table><h3>Reads Attributes: </h3><table id="reads-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>mime.type</td><td>If configured by property "Input Content Type" will use this value to determine what sort of content should be inferred from the incoming FlowFile content.</td></tr></table><h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>inferred.avro.schema</td><td>If configured by "Schema output destination" to write to an attribute this will hold the resulting Avro schema from inferring the incoming FlowFile content.</td></tr></table><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 C
onsiderations:</h3>None specified.</body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kite-nar/1.9.0/org.apache.nifi.processors.kite.StoreInKiteDataset/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kite-nar/1.9.0/org.apache.nifi.processors.kite.StoreInKiteDataset/index.html?rev=1854109&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kite-nar/1.9.0/org.apache.nifi.processors.kite.StoreInKiteDataset/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kite-nar/1.9.0/org.apache.nifi.processors.kite.StoreInKiteDataset/index.html Fri Feb 22 01:03:44 2019
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>StoreInKiteDataset</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;">StoreInKiteDataset</h1><h2>Description: </h2><p>Stores Avro records in a Kite dataset</p><h3>Tags: </h3><p>kite, avro, parquet, hadoop, hive, hdfs, hbase</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Descrip
tion</th></tr><tr><td id="name">Hadoop configuration Resources</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A file or comma separated list of files which contains the Hadoop file system configuration. Without this, Hadoop will search the classpath for a 'core-site.xml' and 'hdfs-site.xml' file or will revert to a default configuration.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Target dataset URI</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">URI that identifies a Kite dataset where data will be stored<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Additional Classpath Resources</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A comma-separated list of paths to files
and/or directories that will be added to the classpath. When specifying a directory, all files with in the directory will be added to the classpath, but further sub-directories will not be included.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>FlowFile content has been successfully saved</td></tr><tr><td>incompatible</td><td>FlowFile content is not compatible with the target dataset</td></tr><tr><td>failure</td><td>FlowFile content could not be processed</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>None specified.</body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kudu-nar/1.9.0/org.apache.nifi.processors.kudu.PutKudu/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kudu-nar/1.9.0/org.apache.nifi.processors.kudu.PutKudu/index.html?rev=1854109&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kudu-nar/1.9.0/org.apache.nifi.processors.kudu.PutKudu/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kudu-nar/1.9.0/org.apache.nifi.processors.kudu.PutKudu/index.html Fri Feb 22 01:03:44 2019
@@ -0,0 +1,4 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutKudu</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;">PutKudu</h1><h2>Description: </h2><p>Reads records from an incoming FlowFile using the provided Record Reader, and writes those records to the specified Kudu's table. The schema for the table must be provided in the processor properties or from your source. If any error occurs while reading records from the input, or writing records to Kudu, the FlowFile will be routed to failure</p><h3>Tags: </h3><p>put, database, NoSQL, kudu, HDFS, 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 opt
ional. 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>Kudu Masters</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">List all kudu masters's ip with port (e.g. 7051), comma separated<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</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 Kudu Table to put data into<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.9.0/org.apache.nifi.kerberos.KeytabCredentialsService/index.html">KeytabCredentialsService</a></td><td id="description">Specifies the Kerberos Credentials to use for authentication</td></tr><tr><td id="name"><strong>Skip head line</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Deprecated. Used to ignore header lines, but this should be handled by a RecordReader (e.g. "Treat First Line as Header" property of CSVReader)</td></tr><tr><td id="name"><strong>Record Reader</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>RecordReaderFactory<br/><strong>Implementations: </strong><a href="../../../nifi-record-serialization-services-nar/1.9.0/org.apache.nifi.json.JsonTreeReader
/index.html">JsonTreeReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.9.0/org.apache.nifi.xml.XMLReader/index.html">XMLReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.9.0/org.apache.nifi.json.JsonPathReader/index.html">JsonPathReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.9.0/org.apache.nifi.syslog.Syslog5424Reader/index.html">Syslog5424Reader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.9.0/org.apache.nifi.grok.GrokReader/index.html">GrokReader</a><br/><a href="../../../nifi-scripting-nar/1.9.0/org.apache.nifi.record.script.ScriptedReader/index.html">ScriptedReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.9.0/org.apache.nifi.avro.AvroReader/index.html">AvroReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.9.0/org.apache.nifi.csv.CSVReader/index.html">CSVReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.9.0/org
.apache.nifi.syslog.SyslogReader/index.html">SyslogReader</a></td><td id="description">The service for reading records from incoming flow files.</td></tr><tr><td id="name">Insert Operation</td><td id="default-value">INSERT</td><td id="allowable-values"><ul><li>INSERT</li><li>INSERT_IGNORE</li><li>UPSERT</li></ul></td><td id="description">Specify operationType for this processor. Insert-Ignore will ignore duplicated rows</td></tr><tr><td id="name"><strong>Flush Mode</strong></td><td id="default-value">AUTO_FLUSH_BACKGROUND</td><td id="allowable-values"><ul><li>AUTO_FLUSH_SYNC</li><li>AUTO_FLUSH_BACKGROUND</li><li>MANUAL_FLUSH</li></ul></td><td id="description">Set the new flush mode for a kudu session.
+AUTO_FLUSH_SYNC: the call returns when the operation is persisted, else it throws an exception.
+AUTO_FLUSH_BACKGROUND: the call returns when the operation has been added to the buffer. This call should normally perform only fast in-memory operations but it may have to wait when the buffer is full and there's another buffer being flushed.
+MANUAL_FLUSH: the call returns when the operation has been added to the buffer, else it throws a KuduException if the buffer is full.</td></tr><tr><td id="name"><strong>FlowFiles per Batch</strong></td><td id="default-value">1</td><td id="allowable-values"></td><td id="description">The maximum number of FlowFiles to process in a single execution, between 1 - 100000. Depending on your memory size, and data size per row set an appropriate batch size for the number of FlowFiles to process per client connection setup.Gradually increase this number, only if your FlowFiles typically contain a few records.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Max Records per Batch</strong></td><td id="default-value">100</td><td id="allowable-values"></td><td id="description">The maximum number of Records to process in a single Kudu-client batch, between 1 - 100000. Depending on your memory size, and data
size per row set an appropriate batch size. Gradually increase this number to find out the best one for best performances.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>A FlowFile is routed to this relationship after it has been successfully stored in Kudu</td></tr><tr><td>failure</td><td>A FlowFile is routed to this relationship if it cannot be sent to Kudu</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>record.count</td><td>Number of records written to Kudu</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.</body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-language-translation-nar/1.9.0/org.apache.nifi.processors.yandex.YandexTranslate/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-language-translation-nar/1.9.0/org.apache.nifi.processors.yandex.YandexTranslate/index.html?rev=1854109&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-language-translation-nar/1.9.0/org.apache.nifi.processors.yandex.YandexTranslate/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-language-translation-nar/1.9.0/org.apache.nifi.processors.yandex.YandexTranslate/index.html Fri Feb 22 01:03:44 2019
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>YandexTranslate</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;">YandexTranslate</h1><h2>Description: </h2><p>Translates content and attributes from one language to another</p><h3>Tags: </h3><p>yandex, translate, translation, language</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</t
h><th>Description</th></tr><tr><td id="name"><strong>Yandex API Key</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The API Key that is registered with Yandex</td></tr><tr><td id="name">Input Language</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The language of incoming data. If no language is set, Yandex will attempt to detect the incoming language automatically.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Target Language</strong></td><td id="default-value">en</td><td id="allowable-values"></td><td id="description">The language to translate the text 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>Translate Content</strong></td><td id="default-value">false</td><td id="all
owable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specifies whether or not the content should be translated. If false, only the text specified by user-defined properties will be translated.</td></tr><tr><td id="name"><strong>Character Set</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">Specifies the character set of the data to be translated<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</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">The name of an attribute to set that will contain the translated text of the value</td><td id="value">The value to translate</td><td>User-defined properties are used to translate arbitrary text based on attributes.
<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr></table></p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>translation.failure</td><td>This relationship is used if the translation cannot be performed for some reason other than communications failure</td></tr><tr><td>success</td><td>This relationship is used when the translation is successful</td></tr><tr><td>comms.failure</td><td>This relationship is used when the translation fails due to a problem such as a network failure, and for which the translation should be attempted again</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>yandex.translate.failure.reason</td><td>If the text cannot be translated, this attribute will be set indicating the reason for the failure</td></tr><tr><t
d>language</td><td>When the translation succeeds, if the content was translated, this attribute will be set indicating the new language of the content</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.</body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-livy-nar/1.9.0/org.apache.nifi.controller.livy.LivySessionController/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-livy-nar/1.9.0/org.apache.nifi.controller.livy.LivySessionController/index.html?rev=1854109&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-livy-nar/1.9.0/org.apache.nifi.controller.livy.LivySessionController/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-livy-nar/1.9.0/org.apache.nifi.controller.livy.LivySessionController/index.html Fri Feb 22 01:03:44 2019
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>LivySessionController</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;">LivySessionController</h1><h2>Description: </h2><p>Manages pool of Spark sessions over HTTP</p><h3>Tags: </h3><p>Livy, REST, Spark, 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, 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>Livy Host</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The hostname (or IP address) of the Livy server.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Livy Port</strong></td><td id="default-value">8998</td><td id="allowable-values"></td><td id="description">The port number for the Livy server.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Session Pool Size</strong></td><td id="default-value">2</td><td id="allowable-values"></td><td id="description">Number of sessions to keep open<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Session Type</strong></td><td id="default-value">spark</td><td id="allowable-values"><ul><li>spark</li><li>pysp
ark</li><li>pyspark3</li><li>sparkr</li></ul></td><td id="description">The type of Spark session to start (spark, pyspark, pyspark3, sparkr, e.g.)</td></tr><tr><td id="name"><strong>Session Manager Status Interval</strong></td><td id="default-value">2 sec</td><td id="allowable-values"></td><td id="description">The amount of time to wait between requesting session information updates.<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.9.0/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</a><br/><a href="../../../nifi-ssl-context-service-nar/1.9.0/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextServ
ice</a></td><td id="description">The SSL Context Service used to provide client certificate information for TLS/SSL (https) connections.</td></tr><tr><td id="name"><strong>Connection Timeout</strong></td><td id="default-value">5 secs</td><td id="allowable-values"></td><td id="description">Max wait time for connection to remote service.</td></tr><tr><td id="name">Session JARs</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">JARs to be used in the Spark session.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Session Files</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Files to be used in the Spark session.<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>C
ontroller Service API: </strong><br/>KerberosCredentialsService<br/><strong>Implementation: </strong><a href="../../../nifi-kerberos-credentials-service-nar/1.9.0/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></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-livy-nar/1.9.0/org.apache.nifi.processors.livy.ExecuteSparkInteractive/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-livy-nar/1.9.0/org.apache.nifi.processors.livy.ExecuteSparkInteractive/index.html?rev=1854109&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-livy-nar/1.9.0/org.apache.nifi.processors.livy.ExecuteSparkInteractive/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-livy-nar/1.9.0/org.apache.nifi.processors.livy.ExecuteSparkInteractive/index.html Fri Feb 22 01:03:44 2019
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ExecuteSparkInteractive</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;">ExecuteSparkInteractive</h1><h2>Description: </h2><p>Execute Spark Code over a Livy-managed HTTP session to a live Spark context. Supports cached RDD sharing.</p><h3>Tags: </h3><p>spark, livy, http, execute</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Name</th>
<th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Livy Controller Service</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>LivySessionService<br/><strong>Implementation: </strong><a href="../org.apache.nifi.controller.livy.LivySessionController/index.html">LivySessionController</a></td><td id="description">The controller service to use for Livy-managed session(s).</td></tr><tr><td id="name">Code</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The code to execute in the session. This property can be empty, a constant value, or built from attributes using Expression Language. If this property is specified, it will be used regardless of the content of incoming flowfiles. If this property is empty, the content of the incoming flow file is expected to contain valid code to be issued by the processor to the session. Note that Expression Langua
ge is not evaluated for flow file contents.<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">The character set encoding for the incoming flow file.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Status Check Interval</strong></td><td id="default-value">1 sec</td><td id="allowable-values"></td><td id="description">The amount of time to wait between checking the status of an operation.<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>success</td><td>FlowFiles that a
re successfully processed are sent to this relationship</td></tr><tr><td>wait</td><td>FlowFiles that are waiting on an available Spark session will be sent to this relationship</td></tr><tr><td>failure</td><td>FlowFiles are routed to this relationship when they cannot be parsed</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>None specified.</body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.9.0/org.apache.nifi.lookup.CSVRecordLookupService/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.9.0/org.apache.nifi.lookup.CSVRecordLookupService/index.html?rev=1854109&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.9.0/org.apache.nifi.lookup.CSVRecordLookupService/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.9.0/org.apache.nifi.lookup.CSVRecordLookupService/index.html Fri Feb 22 01:03:44 2019
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>CSVRecordLookupService</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;">CSVRecordLookupService</h1><h2>Description: </h2><p>A reloadable CSV file-based lookup service. When the lookup key is found in the CSV file, the columns are returned as a Record. All returned fields will be strings.</p><h3>Tags: </h3><p>lookup, cache, enrich, join, csv, reloadable, key, value, 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>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>CSV File</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A CSV file that will serve as the data source.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>CSV Format</strong></td><td id="default-value">Default</td><td id="allowable-values"><ul><li>Excel</li><li>MySQL</li><li>TDF</li><li>PostgreSQLCsv</li><li>InformixUnloadCsv</li><li>Default</li><li>RFC4180</li><li>InformixUnload</li><li>PostgreSQLText</li></ul></td><td id="description">Specifies which "format" the CSV data is in.</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">The Character Encoding that is used t
o decode the CSV file.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Lookup Key Column</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The field in the CSV file that will serve as the lookup key. This is the field that will be matched against the property specified in the lookup processor.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Ignore Duplicates</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Ignore duplicate keys for records in the CSV file.</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-lookup-services-nar/1.9.0/org.apache.nifi.lookup.DistributedMapCacheLookupService/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.9.0/org.apache.nifi.lookup.DistributedMapCacheLookupService/index.html?rev=1854109&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.9.0/org.apache.nifi.lookup.DistributedMapCacheLookupService/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.9.0/org.apache.nifi.lookup.DistributedMapCacheLookupService/index.html Fri Feb 22 01:03:44 2019
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>DistributedMapCacheLookupService</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;">DistributedMapCacheLookupService</h1><h2>Description: </h2><p>Allows to choose a distributed map cache client to retrieve the value associated to a key. The coordinates that are passed to the lookup must contain the key 'key'.</p><h3>Tags: </h3><p>lookup, enrich, key, value, map, cache, distributed</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>Distributed Cache Service</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>DistributedMapCacheClient<br/><strong>Implementations: </strong><a href="../../../nifi-distributed-cache-services-nar/1.9.0/org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService/index.html">DistributedMapCacheClientService</a><br/><a href="../../../nifi-redis-nar/1.9.0/org.apache.nifi.redis.service.RedisDistributedMapCacheClientService/index.html">RedisDistributedMapCacheClientService</a><br/><a href="../../../nifi-couchbase-nar/1.9.0/org.apache.nifi.couchbase.CouchbaseMapCacheClient/index.html">CouchbaseMapCacheClient</a><br/><a href="../../../nifi-hbase_2-client-service-nar/1.9.0/org.apache.nifi.hbase.HBase_2_ClientMapCacheService/index.html">HBase_2_ClientMapCacheService</a><br/><a href="../../../nifi-hbase_1_1_2-client-service-nar/1.9.0/org.apache.nif
i.hbase.HBase_1_1_2_ClientMapCacheService/index.html">HBase_1_1_2_ClientMapCacheService</a></td><td id="description">The Controller Service that is used to get the cached values.</td></tr><tr><td id="name"><strong>Character Encoding</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"><ul><li>ISO-8859-1</li><li>UTF-8</li><li>UTF-16</li><li>UTF-16LE</li><li>UTF-16BE</li><li>US-ASCII</li></ul></td><td id="description">Specifies a character encoding to use.</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-lookup-services-nar/1.9.0/org.apache.nifi.lookup.PropertiesFileLookupService/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.9.0/org.apache.nifi.lookup.PropertiesFileLookupService/index.html?rev=1854109&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.9.0/org.apache.nifi.lookup.PropertiesFileLookupService/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.9.0/org.apache.nifi.lookup.PropertiesFileLookupService/index.html Fri Feb 22 01:03:44 2019
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PropertiesFileLookupService</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;">PropertiesFileLookupService</h1><h2>Description: </h2><p>A reloadable properties file-based lookup service</p><h3>Tags: </h3><p>lookup, cache, enrich, join, properties, reloadable, 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, 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>Configuration File</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A configuration file<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-lookup-services-nar/1.9.0/org.apache.nifi.lookup.RestLookupService/additionalDetails.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.9.0/org.apache.nifi.lookup.RestLookupService/additionalDetails.html?rev=1854109&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.9.0/org.apache.nifi.lookup.RestLookupService/additionalDetails.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.9.0/org.apache.nifi.lookup.RestLookupService/additionalDetails.html Fri Feb 22 01:03:44 2019
@@ -0,0 +1,65 @@
+<!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>RestLookupService</title>
+ <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" />
+</head>
+<body>
+ <h2>General</h2>
+ <p>This lookup service has the following optional lookup coordinate keys:</p>
+ <ul>
+ <li>request.method; defaults to 'get', valid values:
+ <ul>
+ <li>delete</li>
+ <li>get</li>
+ <li>post</li>
+ <li>put</li>
+ </ul>
+ </li>
+ <li>body; contains a string representing JSON, XML, etc. to be sent with any
+ of those methods except for "get".</li>
+ <li>mime.type; specifies media type of the request body, required when 'body' is passed.</li>
+ <li>*; any other keys can be configured to pass variables to resolve target URLs. See 'Dynamic URLs' section below.</li>
+ </ul>
+ <p>The record reader is used to consume the response of the REST service call and turn it into one or more records. The record path property
+ is provided to allow for a lookup path to either a nested record or a single point deep in the REST response. Note: a valid schema must be
+ built that encapsulates the REST response accurately in order for this service to work.</p>
+ <h2>Headers</h2>
+ <p>Headers are supported using dynamic properties. Just add a dynamic property and the name will be the header name and the value will be the value for the header. Expression language
+ powered by input from the variable registry is supported.</p>
+ <h2>Dynamic URLs</h2>
+ <p>The URL property supports expression language through the lookup key/value pairs configured on the component using this lookup service (e.g. LookupRecord processor). The configuration specified by the user will be passed
+ through to the expression language engine for evaluation. Note: flowfile attributes will be disregarded here for this property.</p>
+ <p>Ex. URL: <em>http://example.com/service/${user.name}/friend/${friend.id}</em>, combined with example record paths at LookupRecord processor:</p>
+ <ul>
+ <li>user.name => "/example/username"</li>
+ <li>friend.id => "/example/first_friend"</li>
+ </ul>
+ <p>Would dynamically produce an endpoint of <em>http://example.com/service/john.smith/friend/12345</em></p>
+
+ <h3>Using Variable Registry with URLs</h3>
+
+ <p>In addition to the lookup key/value pairs, Variable Registry can be referred from expression languages configured at the URL property.</p>
+ <p>Ex. URL: <em>http://${apiServerHostname}:${apiServerPort}/service/${user.name}/friend/${friend.id}</em>, combined with the previous example record paths, and variable registry:</p>
+ <ul>
+ <li>apiServerHostname => "test.example.com"</li>
+ <li>apiServerPort => "8080"</li>
+ </ul>
+ <p>Would dynamically produce an endpoint of <em>http://test.example.com:8080/service/john.smith/friend/12345</em></p>
+</body>
+</html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.9.0/org.apache.nifi.lookup.RestLookupService/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.9.0/org.apache.nifi.lookup.RestLookupService/index.html?rev=1854109&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.9.0/org.apache.nifi.lookup.RestLookupService/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.9.0/org.apache.nifi.lookup.RestLookupService/index.html Fri Feb 22 01:03:44 2019
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>RestLookupService</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;">RestLookupService</h1><h2>Description: </h2><p>Use a REST service to look up values.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>rest, lookup, json, xml, 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 supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>, and whether a property is considered "sensitive", meaning t
hat 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>URL</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The URL for the REST endpoint. Expression language is evaluated against the lookup key/value pairs, not flowfile attributes.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Record Reader</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>RecordReaderFactory<br/><strong>Implementations: </strong><a href="../../../nifi-record-serialization-services-nar/1.9.0/org.apache.nifi.json.JsonTreeReader/i
ndex.html">JsonTreeReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.9.0/org.apache.nifi.xml.XMLReader/index.html">XMLReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.9.0/org.apache.nifi.json.JsonPathReader/index.html">JsonPathReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.9.0/org.apache.nifi.syslog.Syslog5424Reader/index.html">Syslog5424Reader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.9.0/org.apache.nifi.grok.GrokReader/index.html">GrokReader</a><br/><a href="../../../nifi-scripting-nar/1.9.0/org.apache.nifi.record.script.ScriptedReader/index.html">ScriptedReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.9.0/org.apache.nifi.avro.AvroReader/index.html">AvroReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.9.0/org.apache.nifi.csv.CSVReader/index.html">CSVReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.9.0/org.a
pache.nifi.syslog.SyslogReader/index.html">SyslogReader</a></td><td id="description">The record reader to use for loading the payload and handling it as a record set.</td></tr><tr><td id="name">Record Path</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">An optional record path that can be used to define where in a record to get the real data to merge into the record set to be enriched. See documentation for examples of when this might be useful.<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.9.0/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</a><br/><a href="../../../nifi-ssl-context
-service-nar/1.9.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.</td></tr><tr><td id="name">Proxy Configuration Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>ProxyConfigurationService<br/><strong>Implementation: </strong><a href="../../../nifi-proxy-configuration-nar/1.9.0/org.apache.nifi.proxy.StandardProxyConfigurationService/index.html">StandardProxyConfigurationService</a></td><td id="description">Specifies the Proxy Configuration Controller Service to proxy network requests. If set, it supersedes proxy settings configured per component. Supported proxies: HTTP + AuthN, SOCKS</td></tr><tr><td id="name">Basic Authentication Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The username to be used by the client to
authenticate against the Remote URL. Cannot include control characters (0-31), ':', or DEL (127).<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Basic Authentication Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The password to be used by the client to authenticate against the Remote URL.<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">Use Digest Authentication</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Whether to communicate with the website using Digest Authentication. 'Basic Authentication Username' and 'Basic Authentication Password' are used for authentication.</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">*</td><td id="value">*</td><td>All dynamic properties are added as HTTP headers with the name as the header name and the value as the header value.<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-lookup-services-nar/1.9.0/org.apache.nifi.lookup.SimpleCsvFileLookupService/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.9.0/org.apache.nifi.lookup.SimpleCsvFileLookupService/index.html?rev=1854109&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.9.0/org.apache.nifi.lookup.SimpleCsvFileLookupService/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.9.0/org.apache.nifi.lookup.SimpleCsvFileLookupService/index.html Fri Feb 22 01:03:44 2019
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>SimpleCsvFileLookupService</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;">SimpleCsvFileLookupService</h1><h2>Description: </h2><p>A reloadable CSV file-based lookup service</p><h3>Tags: </h3><p>lookup, cache, enrich, join, csv, reloadable, 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, 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>A
llowable Values</th><th>Description</th></tr><tr><td id="name"><strong>CSV File</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A CSV file.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>CSV Format</strong></td><td id="default-value">Default</td><td id="allowable-values"><ul><li>Excel</li><li>MySQL</li><li>TDF</li><li>PostgreSQLCsv</li><li>InformixUnloadCsv</li><li>Default</li><li>RFC4180</li><li>InformixUnload</li><li>PostgreSQLText</li></ul></td><td id="description">Specifies which "format" the CSV data is in, or specifies if custom formatting should be used.</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">The Character Encoding that is used to decode the CSV file.<br/><strong>Supports Expression Language: true (will be evaluated using variable reg
istry only)</strong></td></tr><tr><td id="name"><strong>Lookup Key Column</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Lookup key column.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Lookup Value Column</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Lookup value column.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Ignore Duplicates</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Ignore duplicate keys for records in the CSV file.</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-lookup-services-nar/1.9.0/org.apache.nifi.lookup.SimpleKeyValueLookupService/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.9.0/org.apache.nifi.lookup.SimpleKeyValueLookupService/index.html?rev=1854109&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.9.0/org.apache.nifi.lookup.SimpleKeyValueLookupService/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.9.0/org.apache.nifi.lookup.SimpleKeyValueLookupService/index.html Fri Feb 22 01:03:44 2019
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>SimpleKeyValueLookupService</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;">SimpleKeyValueLookupService</h1><h2>Description: </h2><p>Allows users to add key/value pairs as User-defined Properties. Each property that is added can be looked up by Property Name. The coordinates that are passed to the lookup must contain the key 'key'.</p><h3>Tags: </h3><p>lookup, enrich, key, value</p><h3>Properties: </h3><p>This component has no required or optional properties.</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-lookup-services-nar/1.9.0/org.apache.nifi.lookup.XMLFileLookupService/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.9.0/org.apache.nifi.lookup.XMLFileLookupService/index.html?rev=1854109&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.9.0/org.apache.nifi.lookup.XMLFileLookupService/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.9.0/org.apache.nifi.lookup.XMLFileLookupService/index.html Fri Feb 22 01:03:44 2019
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>XMLFileLookupService</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;">XMLFileLookupService</h1><h2>Description: </h2><p>A reloadable XML file-based lookup service. This service uses Apache Commons Configuration. Example XML configuration file and how to access specific configuration can be found at http://commons.apache.org/proper/commons-configuration/userguide/howto_hierarchical.html</p><h3>Tags: </h3><p>lookup, cache, enrich, join, xml, reloadable, 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, 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>Configuration File</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A configuration file<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-lookup-services-nar/1.9.0/org.apache.nifi.lookup.maxmind.IPLookupService/additionalDetails.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.9.0/org.apache.nifi.lookup.maxmind.IPLookupService/additionalDetails.html?rev=1854109&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.9.0/org.apache.nifi.lookup.maxmind.IPLookupService/additionalDetails.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.9.0/org.apache.nifi.lookup.maxmind.IPLookupService/additionalDetails.html Fri Feb 22 01:03:44 2019
@@ -0,0 +1,179 @@
+<!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>IPLookupService</title>
+
+ <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" />
+ </head>
+
+ <body>
+ <p>
+ The IPLookupService is powered by a MaxMind database and can return several different types of enrichment information
+ about a given IP address. Below is the schema of the Record that is returned by this service (in Avro Schema format).
+ The schema is for a single record that consists of several fields: <code>geo</code>, <code>isp</code>,
+ <code>domainName</code>, <code>connectionType</code>, and <code>anonymousIp</code>. Each of these fields is nullable
+ and will be populated only if the IP address that is searched for has the relevant information in the MaxMind database
+ and if the Controller Service is configured to return such information. Because each of the fields requires a separate
+ lookup in the database, it is advisable to retrieve only those fields that are of value.
+ </p>
+
+<code>
+<pre>
+{
+ "name": "enrichmentRecord",
+ "namespace": "nifi",
+ "type": "record",
+ "fields": [
+ {
+ "name": "geo",
+ "type": ["null", {
+ "name": "cityGeo",
+ "type": "record",
+ "fields": [
+ { "name": "city", "type": ["null", "string"] },
+ { "name": "accuracy", "type": ["null", "int"], "doc": "The radius, in kilometers, around the given location, where the IP address is believed to be" },
+ { "name": "metroCode", "type": ["null", "int"] },
+ { "name": "timeZone", "type": ["null", "string"] },
+ { "name": "latitude", "type": ["null", "double"] },
+ { "name": "longitude", "type": ["null", "double"] },
+ { "name": "country", "type": ["null", {
+ "type": "record",
+ "name": "country",
+ "fields": [
+ { "name": "name", "type": "string" },
+ { "name": "isoCode", "type": "string" }
+ ]
+ }] },
+ { "name": "subdivisions", "type": {
+ "type": "array",
+ "items": {
+ "type": "record",
+ "name": "subdivision",
+ "fields": [
+ { "name": "name", "type": "string" },
+ { "name": "isoCode", "type": "string" }
+ ]
+ }
+ }
+ },
+ { "name": "continent", "type": ["null", "string"] },
+ { "name": "postalCode", "type": ["null", "string"] }
+ ]
+ }]
+ },
+ {
+ "name": "isp",
+ "type": ["null", {
+ "name": "ispEnrich",
+ "type": "record",
+ "fields": [
+ { "name": "name", "type": ["null", "string"] },
+ { "name": "organization", "type": ["null", "string"] },
+ { "name": "asn", "type": ["null", "int"] },
+ { "name": "asnOrganization", "type": ["null", "string"] }
+ ]
+ }]
+ },
+ {
+ "name": "domainName",
+ "type": ["null", "string"]
+ },
+ {
+ "name": "connectionType",
+ "type": ["null", "string"],
+ "doc": "One of 'Dialup', 'Cable/DSL', 'Corporate', 'Cellular'"
+ },
+ {
+ "name": "anonymousIp",
+ "type": ["null", {
+ "name": "anonymousIpType",
+ "type": "record",
+ "fields": [
+ { "name": "anonymous", "type": "boolean" },
+ { "name": "anonymousVpn", "type": "boolean" },
+ { "name": "hostingProvider", "type": "boolean" },
+ { "name": "publicProxy", "type": "boolean" },
+ { "name": "torExitNode", "type": "boolean" }
+ ]
+ }]
+ }
+ ]
+}
+</pre>
+</code>
+
+
+ <p>
+ While this schema is fairly complex, it is a single record with 5 fields. This makes it quite easy to update
+ an existing schema to allow for this record, by adding a new field to an existing schema and pasting in the schema
+ above as the type.
+ </p>
+
+ <p>
+ For example, suppose that we have an existing schema that is as simple as:
+ </p>
+
+<pre>
+<code>
+<span style="color: #808080;">
+{
+ "name": "ipRecord",
+ "namespace": "nifi",
+ "type": "record",
+ "fields": [
+ { "name": "ip", "type": "string" }
+ ]
+}
+</span>
+</code>
+</pre>
+
+ <p>
+ Now, let's suppose that we want to add a new field named <code>enrichment</code> to the above schema.
+ Further, let's say that we want the new <code>enrichment</code> field to be nullable.
+ We can do so by copying and pasting our enrichment schema from above thus:
+ </p>
+
+<pre>
+<code>
+<span style="color: #808080;">
+{
+ "name": "ipRecord",
+ "namespace": "nifi",
+ "type": "record",
+ "fields": [
+ { "name": "ip", "type": "string" },</span><span style="color: #191970;">
+ { "name": "enrichment", "type": ["null",
+</span>
+
+ <span style="color: #000000"><Paste Enrichment Schema Here></span>
+
+<span style="color: #191970;">
+ ]</span><span style="color: #808080;">
+ }
+ ]
+}
+</span>
+</code>
+</pre>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.9.0/org.apache.nifi.lookup.maxmind.IPLookupService/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.9.0/org.apache.nifi.lookup.maxmind.IPLookupService/index.html?rev=1854109&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.9.0/org.apache.nifi.lookup.maxmind.IPLookupService/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.9.0/org.apache.nifi.lookup.maxmind.IPLookupService/index.html Fri Feb 22 01:03:44 2019
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>IPLookupService</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;">IPLookupService</h1><h2>Description: </h2><p>A lookup service that provides several types of enrichment information for IP addresses. The service is configured by providing a MaxMind Database file and specifying which types of enrichment should be provided for an IP Address or Hostname. Each type of enrichment is a separate lookup, so configuring the service to provide all of the available enrichment data may be slower than returning only a portion of the available enrichments. In order to use this service, a lookup must be performed using key of 'ip' and a value that is a valid IP address or ho
stname. View the Usage of this component and choose to view Additional Details for more information, such as the Schema that pertains to the information that is returned.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>lookup, enrich, ip, geo, ipgeo, maxmind, isp, domain, cellular, anonymous, tor</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>MaxMind Database File</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Path to Maxmind IP Enrichment Database File<br/><strong>Suppo
rts Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Lookup Geo Enrichment</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specifies whether or not information about the geographic information, such as cities, corresponding to the IP address should be returned</td></tr><tr><td id="name"><strong>Lookup ISP</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specifies whether or not information about the Information Service Provider corresponding to the IP address should be returned</td></tr><tr><td id="name"><strong>Lookup Domain Name</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specifies whether or not information about the Domain Name corresponding to the IP add
ress should be returned. If true, the lookup will contain second-level domain information, such as foo.com but will not contain bar.foo.com</td></tr><tr><td id="name"><strong>Lookup Connection Type</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specifies whether or not information about the Connection Type corresponding to the IP address should be returned. If true, the lookup will contain a 'connectionType' field that (if populated) will contain a value of 'Dialup', 'Cable/DSL', 'Corporate', or 'Cellular'</td></tr><tr><td id="name"><strong>Lookup Anonymous IP Information</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specifies whether or not information about whether or not the IP address belongs to an anonymous network should be returned.</td></tr></table><h3>State management: </h3>This component does not stor
e state.<h3>Restricted: </h3>This component is not restricted.<h3>System Resource Considerations:</h3>None specified.</body></html>
\ No newline at end of file