Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-distributed-cache-services-nar/1.6.0/org.apache.nifi.distributed.cache.server.map.DistributedMapCacheServer/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-distributed-cache-services-nar/1.6.0/org.apache.nifi.distributed.cache.server.map.DistributedMapCacheServer/index.html?rev=1828578&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-distributed-cache-services-nar/1.6.0/org.apache.nifi.distributed.cache.server.map.DistributedMapCacheServer/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-distributed-cache-services-nar/1.6.0/org.apache.nifi.distributed.cache.server.map.DistributedMapCacheServer/index.html Sat Apr 7 00:33:22 2018 @@ -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.6.0/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 .6.0/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></p></body></html> \ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-druid-nar/1.6.0/org.apache.nifi.controller.druid.DruidTranquilityController/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-druid-nar/1.6.0/org.apache.nifi.controller.druid.DruidTranquilityController/index.html?rev=1828578&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-druid-nar/1.6.0/org.apache.nifi.controller.druid.DruidTranquilityController/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-druid-nar/1.6.0/org.apache.nifi.controller.druid.DruidTranquilityController/index.html Sat Apr 7 00:33:22 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>DruidTranquilityController</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;">DruidTranquilityController</h1><h2>Description: </h2><p>Asynchronously sends flowfiles to Druid Indexing Task using Tranquility API. If aggregation and roll-up of data is required, an Aggregator JSON descriptor needs to be provided.Details on how describe aggregation using JSON can be found at: http://druid.io/docs/latest/querying/aggregations.html</p><h3>Tags: </h3><p>Druid, Timeseries, OLAP, ingest</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>Druid Data Source</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A data source is the Druid equivalent of a database table.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Zookeeper Connection String</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A comma-separated list of host:port pairs, each corresponding to a ZooKeeper server. Ex: localhost:2181<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Zookeeper Retry Base Sleep Time</strong></td><td id="default-value">1000</td><td id="allowable-values"></td><td id="descri ption">When a connection to Zookeeper needs to be retried, this property specifies the amount of time (in milliseconds) to wait at first before retrying.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Zookeeper Retry Max Retries</strong></td><td id="default-value">20</td><td id="allowable-values"></td><td id="description">When a connection to Zookeeper needs to be retried, this property specifies how many times to attempt reconnection.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Zookeeper Retry Sleep Time</strong></td><td id="default-value">30000</td><td id="allowable-values"></td><td id="description">When a connection to Zookeeper needs to be retried, this property specifies the amount of time to sleep (in milliseconds) between retries.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Index Service Path</strong></td><td id="default-value">druid/overlo rd</td><td id="allowable-values"></td><td id="description">Druid Index Service path as defined via the Druid Overlord druid.service property.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Discovery Path</strong></td><td id="default-value">/druid/discovery</td><td id="allowable-values"></td><td id="description">Druid Discovery Path as configured in Druid Common druid.discovery.curator.path property<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Cluster Partitions</strong></td><td id="default-value">1</td><td id="allowable-values"></td><td id="description">The number of partitions in the Druid cluster.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Cluster Replication</strong></td><td id="default-value">1</td><td id="allowable-values"></td><td id="description">The replication factor for the Druid cluster.<br/><strong>Supports Expression Language: true</s trong></td></tr><tr><td id="name"><strong>Dimension Fields</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A comma separated list of field names that will be stored as dimensions on ingest.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Aggregator JSON</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Tranquility-compliant JSON string that defines what aggregators to apply on ingest.Example: [{ "type" : "count", "name" : "count",},{ "name" : "value_sum", "type" : "doubleSum", "fieldName" : "value"},{ "fieldName" : "value", "name" : "value_min", "type" : "doubleMin"},{ "type" : "doubleMax", "name" : "value_max", "fieldName" : "value"}]<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Segment Granularity</strong></td><td id="default-value">TEN_MINUTE</td><td id="allowable-values"><ul><li>NONE</li><li>SECOND</li><l i>MINUTE</li><li>TEN_MINUTE</li><li>HOUR</li><li>DAY</li><li>MONTH</li><li>YEAR</li></ul></td><td id="description">Time unit by which to group and aggregate/rollup events. The value must be at least as large as the value of Query Granularity.</td></tr><tr><td id="name"><strong>Query Granularity</strong></td><td id="default-value">MINUTE</td><td id="allowable-values"><ul><li>NONE</li><li>SECOND</li><li>MINUTE</li><li>FIFTEEN_MINUTE</li><li>THIRTY_MINUTE</li><li>HOUR</li><li>DAY</li><li>MONTH</li><li>YEAR</li></ul></td><td id="description">Time unit by which to group and aggregate/rollup events. The value must be less than or equal to the value of Segment Granularity.</td></tr><tr><td id="name"><strong>Late Event Grace Period</strong></td><td id="default-value">PT10M</td><td id="allowable-values"><ul><li>1 minute <img src="../../../../../html/images/iconInfo.png" alt="1 minute" title="1 minute"></img></li><li>10 minutes <img src="../../../../../html/images/iconInfo.png" alt="10 minute s" title="10 minutes"></img></li><li>60 minutes <img src="../../../../../html/images/iconInfo.png" alt="1 hour" title="1 hour"></img></li></ul></td><td id="description">Grace period to allow late arriving events for real time ingest.</td></tr><tr><td id="name"><strong>Timestamp field</strong></td><td id="default-value">timestamp</td><td id="allowable-values"></td><td id="description">The name of the field that will be used as the timestamp. Should be in ISO8601 format.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Batch Size</strong></td><td id="default-value">2000</td><td id="allowable-values"></td><td id="description">Maximum number of messages to send at once.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Max Pending Batches</strong></td><td id="default-value">5</td><td id="allowable-values"></td><td id="description">Maximum number of batches that may be in flight before service blocks and w aits for one to finish.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Linger (milliseconds)</strong></td><td id="default-value">1000</td><td id="allowable-values"></td><td id="description">Wait this long for batches to collect more messages (up to Batch Size) before sending them. Set to zero to disable waiting. Set to -1 to always wait for complete batches before sending. <br/><strong>Supports Expression Language: true</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-druid-nar/1.6.0/org.apache.nifi.processors.druid.PutDruidRecord/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-druid-nar/1.6.0/org.apache.nifi.processors.druid.PutDruidRecord/index.html?rev=1828578&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-druid-nar/1.6.0/org.apache.nifi.processors.druid.PutDruidRecord/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-druid-nar/1.6.0/org.apache.nifi.processors.druid.PutDruidRecord/index.html Sat Apr 7 00:33:22 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutDruidRecord</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;">PutDruidRecord</h1><h2>Description: </h2><p>Sends records to Druid for Indexing. Leverages Druid Tranquility Controller service.</p><h3>Tags: </h3><p>druid, timeseries, olap, ingest, put, 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.</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>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.6.0/org.apache.nifi.avro.AvroReader/index.html">AvroReader</a><br/><a href="../../../nifi-scripting-nar/1.6.0/org.apache.nifi.record.script.ScriptedReader/index.html">ScriptedReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.6.0/org.apache.nifi.json.JsonPathReader/index.html">JsonPathReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.6.0/org.apache.nifi.grok.GrokReader/index.html">GrokReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.6.0/org.apache.nifi.csv.CSVReader/index.html">CSVReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.6.0/org.apache.nifi.json.JsonTreeReader/index.html">JsonTreeReader</a></td><td id="description">Specifies the Controller Service to use for parsing incoming data and deter mining the data's schema.</td></tr><tr><td id="name"><strong>Record Writer</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>RecordSetWriterFactory<br/><strong>Implementations: </strong><a href="../../../nifi-record-serialization-services-nar/1.6.0/org.apache.nifi.json.JsonRecordSetWriter/index.html">JsonRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.6.0/org.apache.nifi.avro.AvroRecordSetWriter/index.html">AvroRecordSetWriter</a><br/><a href="../../../nifi-scripting-nar/1.6.0/org.apache.nifi.record.script.ScriptedRecordSetWriter/index.html">ScriptedRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.6.0/org.apache.nifi.text.FreeFormTextRecordSetWriter/index.html">FreeFormTextRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.6.0/org.apache.nifi.csv.CSVRecordSetWriter/index.html">CSVRecordSetWriter</a></td><td id="descriptio n">The Record Writer to use in order to serialize the data to outgoing relationships.</td></tr><tr><td id="name"><strong>Tranquility Service</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>DruidTranquilityService<br/><strong>Implementation: </strong><a href="../org.apache.nifi.controller.druid.DruidTranquilityController/index.html">DruidTranquilityController</a></td><td id="description">Tranquility Service to use for sending events to Druid.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>FlowFiles are routed to this relationship when they are successfully processed by Druid</td></tr><tr><td>dropped</td><td>FlowFiles are routed to this relationship when they are outside of the configured time window, timestamp format is invalid, ect...</td></tr><tr><td>failure</td><td>FlowFiles are routed to this relationship when they cannot be parsed or otherwise processed by Druid</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>The number of messages that were sent to Druid for this FlowFile. FlowFiles on the success relationship will have a value of this attribute that indicates the number of records successfully processed by Druid, and the FlowFile content will be only the successful records. This behavior applies to the failure and dropped relationships as well.</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-elasticsearch-5-nar/1.6.0/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.6.0/org.apache.nifi.processors.elasticsearch.DeleteElasticsearch5/index.html?rev=1828578&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-5-nar/1.6.0/org.apache.nifi.processors.elasticsearch.DeleteElasticsearch5/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-5-nar/1.6.0/org.apache.nifi.processors.elasticsearch.DeleteElasticsearch5/index.html Sat Apr 7 00:33:22 2018 @@ -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</strong></td></tr><tr><td id="name"><strong>ElasticSearch Hosts</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">ElasticSearch Hosts, which should be comma separated and colon for hostname/port host1:port,host2:port,.. .. For example testcluster:9300. This processor uses the Transport Client to connect to hosts. The default transport client port is 9300.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">SSL Context Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Implementations: </strong><a href="../../../nifi-ssl-context-service-nar/1.6.0/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a><br/><a href="../../../nifi-ssl-context-service-nar/1.6.0/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</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-valu e"></td><td id="allowable-values"></td><td id="description">Specifies the path to the JAR(s) for the Elasticsearch X-Pack Transport feature. If the Elasticsearch cluster has been secured with the X-Pack plugin, then the X-Pack Transport JARs must also be available to this processor. Note: Do NOT place the X-Pack JARs into NiFi's lib/ directory, doing so will prevent the X-Pack Transport JARs from being loaded.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Username to access the Elasticsearch cluster<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password to access the Elasticsearch cluster<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>ElasticSearch Ping Timeout</strong></td><td id="default-valu e">5s</td><td id="allowable-values"></td><td id="description">The ping timeout used to determine when a node is unreachable. For example, 5s (5 seconds). If non-local recommended is 30s<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Sampler Interval</strong></td><td id="default-value">5s</td><td id="allowable-values"></td><td id="description">How often to sample / ping the nodes listed and connected. For example, 5s (5 seconds). If non-local recommended is 30s.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Document Identifier</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The identifier for the document to be deleted<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Index</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the index to delete the document fr om<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Type</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The type of this document to be deleted<br/><strong>Supports Expression Language: true</strong></td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>retry</td><td>A FlowFile is routed to this relationship if the document cannot be 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>Read s 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.6.0/org.apache.nifi.processors.elasticsearch.FetchElasticsearch5/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-5-nar/1.6.0/org.apache.nifi.processors.elasticsearch.FetchElasticsearch5/index.html?rev=1828578&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-5-nar/1.6.0/org.apache.nifi.processors.elasticsearch.FetchElasticsearch5/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-5-nar/1.6.0/org.apache.nifi.processors.elasticsearch.FetchElasticsearch5/index.html Sat Apr 7 00:33:22 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>FetchElasticsearch5</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">FetchElasticsearch5</h1><h2>Description: </h2><p>Retrieves a document from Elasticsearch using the specified connection properties and the identifier of the document to retrieve. If the cluster has been configured for authorization and/or secure transport (SSL/TLS), and the X-Pack plugin is available, secure connections can be made. This processor supports Elasticsearch 5.x clusters.</p><h3>Tags: </h3><p>elasticsearch, elasticsearch 5, fetch, read, get</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Cluster Name</strong></td><td id="default-value">elasticsearch</td><td id="allowable-values"></td><td id="description">Name of the ES cluster (for example, elasticsearch_brew). Defaults to 'elasticsearch'<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>ElasticSearch Hosts</strong></td><td id="default-value"></td><td id="allowable-values"></td>< td id="description">ElasticSearch Hosts, which should be comma separated and colon for hostname/port host1:port,host2:port,.... For example testcluster:9300. This processor uses the Transport Client to connect to hosts. The default transport client port is 9300.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">SSL Context Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Implementations: </strong><a href="../../../nifi-ssl-context-service-nar/1.6.0/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a><br/><a href="../../../nifi-ssl-context-service-nar/1.6.0/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</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 Elasticsea rch endpoint(s) have been secured with TLS/SSL.</td></tr><tr><td id="name">X-Pack Transport Location</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specifies the path to the JAR(s) for the Elasticsearch X-Pack Transport feature. If the Elasticsearch cluster has been secured with the X-Pack plugin, then the X-Pack Transport JARs must also be available to this processor. Note: Do NOT place the X-Pack JARs into NiFi's lib/ directory, doing so will prevent the X-Pack Transport JARs from being loaded.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Username to access the Elasticsearch cluster<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password to access the Elasticsearch cluster<br/><strong>Sens itive Property: true</strong></td></tr><tr><td id="name"><strong>ElasticSearch Ping Timeout</strong></td><td id="default-value">5s</td><td id="allowable-values"></td><td id="description">The ping timeout used to determine when a node is unreachable. For example, 5s (5 seconds). If non-local recommended is 30s<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Sampler Interval</strong></td><td id="default-value">5s</td><td id="allowable-values"></td><td id="description">How often to sample / ping the nodes listed and connected. For example, 5s (5 seconds). If non-local recommended is 30s.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Document Identifier</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The identifier for the document to be fetched<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Index</strong></td><t d id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the index to read from<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Type</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The type of this document (used by Elasticsearch for indexing and searching)<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Character Set</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">Specifies the character set of the document data.<br/><strong>Supports Expression Language: true</strong></td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>retry</td><td>A FlowFile is routed to this relationship if the document cannot be fetched but attempting the operation again may succeed</td></tr><tr><td>success</td><td>All FlowFiles that are read from Elasticsearch are routed to this relationship</td></tr><tr><td>failure</td><td>All FlowFiles that cannot be read from Elasticsearch are routed to this relationship</td></tr><tr><td>not found</td><td>A FlowFile is routed to this relationship if the specified document does not exist in the Elasticsearch cluster</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>filename</td><td>The filename attributes is set to the document identifier</td></tr><tr><td>es.index</td><td>The Elasticsearch index containing the document</td></tr><tr><td>es.type</td><td>The Elasticsearch document type</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<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.6.0/org.apache.nifi.processors.elasticsearch.PutElasticsearch5/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-5-nar/1.6.0/org.apache.nifi.processors.elasticsearch.PutElasticsearch5/index.html?rev=1828578&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-5-nar/1.6.0/org.apache.nifi.processors.elasticsearch.PutElasticsearch5/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-5-nar/1.6.0/org.apache.nifi.processors.elasticsearch.PutElasticsearch5/index.html Sat Apr 7 00:33:22 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutElasticsearch5</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">PutElasticsearch5</h1><h2>Description: </h2><p>Writes the contents of a FlowFile to Elasticsearch, using the specified parameters such as the index to insert into and the type of the document. If the cluster has been configured for authorization and/or secure transport (SSL/TLS), and the X-Pack plugin is available, secure connections can be made. This processor supports Elasticsearch 5.x clusters.</p><h3>Tags: </h3><p>elasticsearch, elasticsearch 5, insert, update, write, put</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any oth er properties (not in bold) are considered optional. The table also indicates any default values, whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Cluster Name</strong></td><td id="default-value">elasticsearch</td><td id="allowable-values"></td><td id="description">Name of the ES cluster (for example, elasticsearch_brew). Defaults to 'elasticsearch'<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>ElasticSearch Hosts</strong></td><td id="default-value"></td><td id="al lowable-values"></td><td id="description">ElasticSearch Hosts, which should be comma separated and colon for hostname/port host1:port,host2:port,.... For example testcluster:9300. This processor uses the Transport Client to connect to hosts. The default transport client port is 9300.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">SSL Context Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Implementations: </strong><a href="../../../nifi-ssl-context-service-nar/1.6.0/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a><br/><a href="../../../nifi-ssl-context-service-nar/1.6.0/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</a></td><td id="description">The SSL Context Service used to provide client certificate information for TLS/SSL connections. This service only app lies if the Elasticsearch endpoint(s) have been secured with TLS/SSL.</td></tr><tr><td id="name">X-Pack Transport Location</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specifies the path to the JAR(s) for the Elasticsearch X-Pack Transport feature. If the Elasticsearch cluster has been secured with the X-Pack plugin, then the X-Pack Transport JARs must also be available to this processor. Note: Do NOT place the X-Pack JARs into NiFi's lib/ directory, doing so will prevent the X-Pack Transport JARs from being loaded.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Username to access the Elasticsearch cluster<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password to access the Elasticsearch cl uster<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>ElasticSearch Ping Timeout</strong></td><td id="default-value">5s</td><td id="allowable-values"></td><td id="description">The ping timeout used to determine when a node is unreachable. For example, 5s (5 seconds). If non-local recommended is 30s<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Sampler Interval</strong></td><td id="default-value">5s</td><td id="allowable-values"></td><td id="description">How often to sample / ping the nodes listed and connected. For example, 5s (5 seconds). If non-local recommended is 30s.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>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="def ault-value"></td><td id="allowable-values"></td><td id="description">The name of the index to insert into<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Type</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The type of this document (used by Elasticsearch for indexing and searching)<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Character Set</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">Specifies the character set of the document data.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Batch Size</strong></td><td id="default-value">100</td><td id="allowable-values"></td><td id="description">The preferred number of FlowFiles to put to the database in a single transaction<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>In dex 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</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 incom ing 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 Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-client-service-nar/1.6.0/org.apache.nifi.elasticsearch.ElasticSearchClientServiceImpl/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-client-service-nar/1.6.0/org.apache.nifi.elasticsearch.ElasticSearchClientServiceImpl/index.html?rev=1828578&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-client-service-nar/1.6.0/org.apache.nifi.elasticsearch.ElasticSearchClientServiceImpl/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-client-service-nar/1.6.0/org.apache.nifi.elasticsearch.ElasticSearchClientServiceImpl/index.html Sat Apr 7 00:33:22 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ElasticSearchClientServiceImpl</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;">ElasticSearchClientServiceImpl</h1><h2>Description: </h2><p>No description provided.</p><h3>Tags: </h3><p>No tags provided.</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 se nsitive 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>HTTP Hosts</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A comma-separated list of HTTP hosts that host ElasticSearch query nodes.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The username to use with XPack security.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The password to use with XPack security.<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true</stron g></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.6.0/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a><br/><a href="../../../nifi-ssl-context-service-nar/1.6.0/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</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"><strong>Connect timeout</strong></td><td id="default-value">5000</td><td id="allowable-values"></td><td id="description">Controls the amount of time, in milliseconds, before a timeout occurs when trying to connect.</td></tr><tr><td id="name"> <strong>Read timeout</strong></td><td id="default-value">60000</td><td id="allowable-values"></td><td id="description">Controls the amount of time, in milliseconds, before a timeout occurs when waiting for a response.</td></tr><tr><td id="name"><strong>Retry timeout</strong></td><td id="default-value">60000</td><td id="allowable-values"></td><td id="description">Controls the amount of time, in milliseconds, before a timeout occurs when retrying the operation.</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">The charset to use for interpreting the response from ElasticSearch.</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-elasticsearch-nar/1.6.0/org.apache.nifi.processors.elasticsearch.FetchElasticsearch/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-nar/1.6.0/org.apache.nifi.processors.elasticsearch.FetchElasticsearch/index.html?rev=1828578&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-nar/1.6.0/org.apache.nifi.processors.elasticsearch.FetchElasticsearch/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-nar/1.6.0/org.apache.nifi.processors.elasticsearch.FetchElasticsearch/index.html Sat Apr 7 00:33:22 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>FetchElasticsearch</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">FetchElasticsearch</h1><h2>Description: </h2><p>Retrieves a document from Elasticsearch using the specified connection properties and the identifier of the document to retrieve. If the cluster has been configured for authorization and/or secure transport (SSL/TLS) and the Shield plugin is available, secure connections can be made. This processor supports Elasticsearch 2.x clusters.</p><h3>Tags: </h3><p>elasticsearch, fetch, read, get</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Cluster Name</strong></td><td id="default-value">elasticsearch</td><td id="allowable-values"></td><td id="description">Name of the ES cluster (for example, elasticsearch_brew). Defaults to 'elasticsearch'<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>ElasticSearch Hosts</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description"> ElasticSearch Hosts, which should be comma separated and colon for hostname/port host1:port,host2:port,.... For example testcluster:9300. This processor uses the Transport Client to connect to hosts. The default transport client port is 9300.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">SSL Context Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Implementations: </strong><a href="../../../nifi-ssl-context-service-nar/1.6.0/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a><br/><a href="../../../nifi-ssl-context-service-nar/1.6.0/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</a></td><td id="description">The SSL Context Service used to provide client certificate information for TLS/SSL connections. This service only applies if the Elasticsearch endpoint(s) have been secured with TLS/SSL.</td></tr><tr><td id="name">Shield Plugin Filename</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specifies the path to the JAR for the Elasticsearch Shield plugin. If the Elasticsearch cluster has been secured with the Shield plugin, then the Shield plugin JAR must also be available to this processor. Note: Do NOT place the Shield JAR into NiFi's lib/ directory, doing so will prevent the Shield plugin from being loaded.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Username to access the Elasticsearch cluster<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password to access the Elasticsearch cluster<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>ElasticSearch Ping Timeout</strong></td><td id="default-value">5s</td><td id="allowable-values"></td><td id="description">The ping timeout used to determine when a node is unreachable. For example, 5s (5 seconds). If non-local recommended is 30s<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Sampler Interval</strong></td><td id="default-value">5s</td><td id="allowable-values"></td><td id="description">How often to sample / ping the nodes listed and connected. For example, 5s (5 seconds). If non-local recommended is 30s.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Document Identifier</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The identifier for the document to be fetched<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Index</strong>< /td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the index to read from<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Type</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The type of this document (used by Elasticsearch for indexing and searching)<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Character Set</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">Specifies the character set of the document data.<br/><strong>Supports Expression Language: true</strong></td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>retry</td><td>A FlowFile is routed to this relationship if the document cannot be fetched but attempting the operation again may succeed</td></tr><tr><td>success</td><td>All FlowFiles th at are read from Elasticsearch are routed to this relationship</td></tr><tr><td>failure</td><td>All FlowFiles that cannot be read from Elasticsearch are routed to this relationship</td></tr><tr><td>not found</td><td>A FlowFile is routed to this relationship if the specified document does not exist in the Elasticsearch cluster</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>filename</td><td>The filename attributes is set to the document identifier</td></tr><tr><td>es.index</td><td>The Elasticsearch index containing the document</td></tr><tr><td>es.type</td><td>The Elasticsearch document type</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<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-elasticsearch-nar/1.6.0/org.apache.nifi.processors.elasticsearch.FetchElasticsearchHttp/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-nar/1.6.0/org.apache.nifi.processors.elasticsearch.FetchElasticsearchHttp/index.html?rev=1828578&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-nar/1.6.0/org.apache.nifi.processors.elasticsearch.FetchElasticsearchHttp/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-nar/1.6.0/org.apache.nifi.processors.elasticsearch.FetchElasticsearchHttp/index.html Sat Apr 7 00:33:22 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>FetchElasticsearchHttp</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">FetchElasticsearchHttp</h1><h2>Description: </h2><p>Retrieves a document from Elasticsearch using the specified connection properties and the identifier of the document to retrieve. Note that the full body of the document will be read into memory before being written to a Flow File for transfer.</p><h3>Tags: </h3><p>elasticsearch, fetch, read, get, http</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, whether a property sup ports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Elasticsearch URL</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Elasticsearch URL which will be connected to, including scheme (http, e.g.), host, and port. The default port for the REST API is 9200.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">SSL Context Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Imp lementations: </strong><a href="../../../nifi-ssl-context-service-nar/1.6.0/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a><br/><a href="../../../nifi-ssl-context-service-nar/1.6.0/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</a></td><td id="description">The SSL Context Service used to provide client certificate information for TLS/SSL connections. This service only applies if the Elasticsearch endpoint(s) have been secured with TLS/SSL.</td></tr><tr><td id="name">Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Username to access the Elasticsearch cluster<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password to access the Elasticsearch cluster<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Exp ression Language: true</strong></td></tr><tr><td id="name"><strong>Connection Timeout</strong></td><td id="default-value">5 secs</td><td id="allowable-values"></td><td id="description">Max wait time for the connection to the Elasticsearch REST API.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Response Timeout</strong></td><td id="default-value">15 secs</td><td id="allowable-values"></td><td id="description">Max wait time for a response from the Elasticsearch REST API.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Document Identifier</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The identifier of the document to be fetched<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Index</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the index to read from.<br/ ><strong>Supports Expression Language: true</strong></td></tr><tr><td >id="name">Type</td><td id="default-value"></td><td >id="allowable-values"></td><td id="description">The (optional) type of this >document, used by Elasticsearch for indexing and searching. If the property >is empty, the first document matching the identifier across all types will be >retrieved.<br/><strong>Supports Expression Language: >true</strong></td></tr><tr><td id="name">Fields</td><td >id="default-value"></td><td id="allowable-values"></td><td id="description">A >comma-separated list of fields to retrieve from the document. If the Fields >property is left blank, then the entire document's source will be >retrieved.<br/><strong>Supports Expression Language: >true</strong></td></tr></table><h3>Dynamic Properties: </h3><p>Dynamic >Properties allow the user to specify both the name and value of a >property.<table >id="dynamic-properties"><tr><th>Name</th><th>Value</th><th>Description</th></tr><tr><td > id="name">A URL query p arameter</td><td id="value">The value to set it to</td><td>Adds the specified property name/value as a query parameter in the Elasticsearch URL used for processing<br/><strong>Supports Expression Language: true</strong></td></tr></table></p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>retry</td><td>A FlowFile is routed to this relationship if the document cannot be fetched but attempting the operation again may succeed. Note that if the processor has no incoming connections, flow files may still be sent to this relationship based on the processor properties and the results of the fetch operation.</td></tr><tr><td>success</td><td>All FlowFiles that are read from Elasticsearch are routed to this relationship.</td></tr><tr><td>failure</td><td>All FlowFiles that cannot be read from Elasticsearch are routed to this relationship. Note that only incoming flow files will be routed to failure.</td></tr><tr><td>not found</td><td>A FlowFil e is routed to this relationship if the specified document does not exist in the Elasticsearch cluster. Note that if the processor has no incoming connections, flow files may still be sent to this relationship based on the processor properties and the results of the fetch operation.</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>filename</td><td>The filename attribute is set to the document identifier</td></tr><tr><td>es.index</td><td>The Elasticsearch index containing the document</td></tr><tr><td>es.type</td><td>The Elasticsearch document type</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component allows 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-elasticsearch-nar/1.6.0/org.apache.nifi.processors.elasticsearch.PutElasticsearch/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-nar/1.6.0/org.apache.nifi.processors.elasticsearch.PutElasticsearch/index.html?rev=1828578&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-nar/1.6.0/org.apache.nifi.processors.elasticsearch.PutElasticsearch/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-nar/1.6.0/org.apache.nifi.processors.elasticsearch.PutElasticsearch/index.html Sat Apr 7 00:33:22 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutElasticsearch</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">PutElasticsearch</h1><h2>Description: </h2><p>Writes the contents of a FlowFile to Elasticsearch, using the specified parameters such as the index to insert into and the type of the document. If the cluster has been configured for authorization and/or secure transport (SSL/TLS) and the Shield plugin is available, secure connections can be made. This processor supports Elasticsearch 2.x clusters.</p><h3>Tags: </h3><p>elasticsearch, insert, update, write, put</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not i n bold) are considered optional. The table also indicates any default values, whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Cluster Name</strong></td><td id="default-value">elasticsearch</td><td id="allowable-values"></td><td id="description">Name of the ES cluster (for example, elasticsearch_brew). Defaults to 'elasticsearch'<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>ElasticSearch Hosts</strong></td><td id="default-value"></td><td id="allowable-values"></td ><td id="description">ElasticSearch Hosts, which should be comma separated and >colon for hostname/port host1:port,host2:port,.... For example >testcluster:9300. This processor uses the Transport Client to connect to >hosts. The default transport client port is 9300.<br/><strong>Supports >Expression Language: true</strong></td></tr><tr><td id="name">SSL Context >Service</td><td id="default-value"></td><td >id="allowable-values"><strong>Controller Service API: ></strong><br/>SSLContextService<br/><strong>Implementations: </strong><a >href="../../../nifi-ssl-context-service-nar/1.6.0/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a><br/><a > >href="../../../nifi-ssl-context-service-nar/1.6.0/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</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 Elastics earch endpoint(s) have been secured with TLS/SSL.</td></tr><tr><td id="name">Shield Plugin Filename</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specifies the path to the JAR for the Elasticsearch Shield plugin. If the Elasticsearch cluster has been secured with the Shield plugin, then the Shield plugin JAR must also be available to this processor. Note: Do NOT place the Shield JAR into NiFi's lib/ directory, doing so will prevent the Shield plugin from being loaded.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Username to access the Elasticsearch cluster<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password to access the Elasticsearch cluster<br/><strong>Sensitive Property: true</strong ><br/><strong>Supports Expression Language: true</strong></td></tr><tr><td >id="name"><strong>ElasticSearch Ping Timeout</strong></td><td >id="default-value">5s</td><td id="allowable-values"></td><td >id="description">The ping timeout used to determine when a node is >unreachable. For example, 5s (5 seconds). If non-local recommended is >30s<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td >id="name"><strong>Sampler Interval</strong></td><td >id="default-value">5s</td><td id="allowable-values"></td><td >id="description">How often to sample / ping the nodes listed and connected. >For example, 5s (5 seconds). If non-local recommended is >30s.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td >id="name"><strong>Identifier Attribute</strong></td><td >id="default-value"></td><td id="allowable-values"></td><td >id="description">The name of the attribute containing the identifier for each >FlowFile</td></tr><tr><td id="name"><strong>Index</strong></td><td i d="default-value"></td><td id="allowable-values"></td><td id="description">The name of the index to insert into<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Type</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The type of this document (used by Elasticsearch for indexing and searching)<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Character Set</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">Specifies the character set of the document data.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Batch Size</strong></td><td id="default-value">100</td><td id="allowable-values"></td><td id="description">The preferred number of FlowFiles to put to the database in a single transaction<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><str ong>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</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></body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-nar/1.6.0/org.apache.nifi.processors.elasticsearch.PutElasticsearchHttp/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-nar/1.6.0/org.apache.nifi.processors.elasticsearch.PutElasticsearchHttp/index.html?rev=1828578&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-nar/1.6.0/org.apache.nifi.processors.elasticsearch.PutElasticsearchHttp/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-nar/1.6.0/org.apache.nifi.processors.elasticsearch.PutElasticsearchHttp/index.html Sat Apr 7 00:33:22 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutElasticsearchHttp</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;">PutElasticsearchHttp</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.</p><h3>Tags: </h3><p>elasticsearch, insert, update, upsert, delete, write, put, 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 E xpression Language</a>, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Elasticsearch URL</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Elasticsearch URL which will be connected to, including scheme (http, e.g.), host, and port. The default port for the REST API is 9200.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">SSL Context Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Implementations: </strong><a href="../../../nifi-ssl-context-service-nar/1.6.0/o rg.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a><br/><a href="../../../nifi-ssl-context-service-nar/1.6.0/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</a></td><td id="description">The SSL Context Service used to provide client certificate information for TLS/SSL connections. This service only applies if the Elasticsearch endpoint(s) have been secured with TLS/SSL.</td></tr><tr><td id="name">Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Username to access the Elasticsearch cluster<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password to access the Elasticsearch cluster<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Connection Timeout</strong></td><td id="default-value">5 secs</td><td id="allowable-values"></td><td id="description">Max wait time for the connection to the Elasticsearch REST API.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Response Timeout</strong></td><td id="default-value">15 secs</td><td id="allowable-values"></td><td id="description">Max wait time for a response from the Elasticsearch REST API.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Identifier Attribute</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the FlowFile attribute containing the identifier for the document. If the Index Operation is "index", this property may be left empty or evaluate to an empty value, in which case the document's identifier will be auto-generated by Elasticsearch. For all other Index Operations, the attribute must evaluate to a non-empty value.</td></tr><tr><td id="name"> <strong>Index</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the index to insert into<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Type</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The type of this document (used by Elasticsearch for indexing and searching)<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Character Set</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">Specifies the character set of the document data.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Batch Size</strong></td><td id="default-value">100</td><td id="allowable-values"></td><td id="description">The preferred number of flow files to put to the database in a single transaction. Note that the contents of the flow files will be stor ed in memory until the bulk operation is performed. Also the results should be returned in the same order the flow files were received.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Index Operation</strong></td><td id="default-value">index</td><td id="allowable-values"></td><td id="description">The type of the operation used to index (index, update, upsert, delete)<br/><strong>Supports Expression Language: true</strong></td></tr></table><h3>Dynamic Properties: </h3><p>Dynamic Properties allow the user to specify both the name and value of a property.<table id="dynamic-properties"><tr><th>Name</th><th>Value</th><th>Description</th></tr><tr><td id="name">A URL query parameter</td><td id="value">The value to set it to</td><td>Adds the specified property name/value as a query parameter in the Elasticsearch URL used for processing<br/><strong>Supports Expression Language: true</strong></td></tr></table></p><h3>Relationships: </h3><table id="re lationships"><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 s ettings 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-elasticsearch-nar/1.6.0/org.apache.nifi.processors.elasticsearch.PutElasticsearchHttpRecord/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-nar/1.6.0/org.apache.nifi.processors.elasticsearch.PutElasticsearchHttpRecord/index.html?rev=1828578&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-nar/1.6.0/org.apache.nifi.processors.elasticsearch.PutElasticsearchHttpRecord/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-nar/1.6.0/org.apache.nifi.processors.elasticsearch.PutElasticsearchHttpRecord/index.html Sat Apr 7 00:33:22 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutElasticsearchHttpRecord</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;">PutElasticsearchHttpRecord</h1><h2>Description: </h2><p>Writes the records from a FlowFile into to Elasticsearch, using the specified parameters such as the index to insert into and the type of the document, as well as the operation type (index, upsert, delete, etc.). Note: The Bulk API is used to send the records. This means that the entire contents of the incoming flow file are read into memory, and each record is transformed into a JSON document which is added to a single HTTP request body. For very large flow files (files with a large number of records, e.g.), this could cause mem ory usage issues.</p><h3>Tags: </h3><p>elasticsearch, insert, update, upsert, delete, write, put, http, 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, 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>Elasticsearch URL</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Elasticsearch URL which wi ll be connected to, including scheme (http, e.g.), host, and port. The default port for the REST API is 9200.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">SSL Context Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Implementations: </strong><a href="../../../nifi-ssl-context-service-nar/1.6.0/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a><br/><a href="../../../nifi-ssl-context-service-nar/1.6.0/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</a></td><td id="description">The SSL Context Service used to provide client certificate information for TLS/SSL connections. This service only applies if the Elasticsearch endpoint(s) have been secured with TLS/SSL.</td></tr><tr><td id="name">Username</td><td id="default-value"></td><td id="allowable-values"></td><td id= "description">Username to access the Elasticsearch cluster<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password to access the Elasticsearch cluster<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Connection Timeout</strong></td><td id="default-value">5 secs</td><td id="allowable-values"></td><td id="description">Max wait time for the connection to the Elasticsearch REST API.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Response Timeout</strong></td><td id="default-value">15 secs</td><td id="allowable-values"></td><td id="description">Max wait time for a response from the Elasticsearch REST API.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Record Reader</strong></td><td id="de fault-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.6.0/org.apache.nifi.avro.AvroReader/index.html">AvroReader</a><br/><a href="../../../nifi-scripting-nar/1.6.0/org.apache.nifi.record.script.ScriptedReader/index.html">ScriptedReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.6.0/org.apache.nifi.json.JsonPathReader/index.html">JsonPathReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.6.0/org.apache.nifi.grok.GrokReader/index.html">GrokReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.6.0/org.apache.nifi.csv.CSVReader/index.html">CSVReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.6.0/org.apache.nifi.json.JsonTreeReader/index.html">JsonTreeReader</a></td><td id="description">Specifies the Controller Service to use for parsing incoming d ata and determining the data's schema.</td></tr><tr><td id="name">Identifier Record Path</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A RecordPath pointing to a field in the record(s) that contains the identifier for the document. If the Index Operation is "index", this property may be left empty or evaluate to an empty value, in which case the document's identifier will be auto-generated by Elasticsearch. For all other Index Operations, the field's value must be non-empty.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Index</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the index to insert into<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Type</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The type of this document (used by Elasticsearch for indexing a nd searching)<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Index Operation</strong></td><td id="default-value">index</td><td id="allowable-values"></td><td id="description">The type of the operation used to index (index, update, upsert, delete)<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Suppress Null Values</strong></td><td id="default-value">never-suppress</td><td id="allowable-values"><ul><li>Never Suppress <img src="../../../../../html/images/iconInfo.png" alt="Fields that are missing (present in the schema but not in the record), or that have a value of null, will be written out as a null value" title="Fields that are missing (present in the schema but not in the record), or that have a value of null, will be written out as a null value"></img></li><li>Always Suppress <img src="../../../../../html/images/iconInfo.png" alt="Fields that are missing (present in the schema but not in the re cord), or that have a value of null, will not be written out" title="Fields that are missing (present in the schema but not in the record), or that have a value of null, will not be written out"></img></li><li>Suppress Missing Values <img src="../../../../../html/images/iconInfo.png" alt="When a field has a value of null, it will be written out. However, if a field is defined in the schema and not present in the record, the field will not be written out." title="When a field has a value of null, it will be written out. However, if a field is defined in the schema and not present in the record, the field will not be written out."></img></li></ul></td><td id="description">Specifies how the writer should handle a null field</td></tr></table><h3>Dynamic Properties: </h3><p>Dynamic Properties allow the user to specify both the name and value of a property.<table id="dynamic-properties"><tr><th>Name</th><th>Value</th><th>Description</th></tr><tr><td id="name">A URL query parameter</td><td id="value">The value to set it to</td><td>Adds the specified property name/value as a query parameter in the Elasticsearch URL used for processing<br/><strong>Supports Expression Language: true</strong></td></tr></table></p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>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>Sys tem Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file