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 2018/07/17 01:35:44 UTC
svn commit: r1836075 [9/39] - in /nifi/site/trunk/docs/nifi-docs: ./
components/org.apache.nifi/nifi-ambari-nar/1.7.1/
components/org.apache.nifi/nifi-ambari-nar/1.7.1/org.apache.nifi.reporting.ambari.AmbariReportingTask/
components/org.apache.nifi/nif...
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-flume-nar/1.7.1/org.apache.nifi.processors.flume.ExecuteFlumeSource/additionalDetails.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-flume-nar/1.7.1/org.apache.nifi.processors.flume.ExecuteFlumeSource/additionalDetails.html?rev=1836075&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-flume-nar/1.7.1/org.apache.nifi.processors.flume.ExecuteFlumeSource/additionalDetails.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-flume-nar/1.7.1/org.apache.nifi.processors.flume.ExecuteFlumeSource/additionalDetails.html Tue Jul 17 01:35:38 2018
@@ -0,0 +1,114 @@
+<!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>ExecuteFlumeSource</title>
+ <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" />
+</head>
+
+<body>
+<h2>Data Model</h2>
+<p>
+ This processor executes an Apache Flume source. Each Flume Event is turned into
+ a FlowFile. The content of the FlowFile is set to the body of the Event and
+ the Event headers become FlowFile attributes.
+</p>
+<h2>Configuration Details</h2>
+<p>
+ This processor is designed to execute arbitrary Flume sources. Most of the details
+ of configuring the source is deferred to Flume's built-in configuration system.
+ For details on the available settings for each source type, refer to the Flume
+ <a href="http://flume.apache.org/FlumeUserGuide.html#flume-sources">User Guide</a>.
+ Configuring the Flume source is a four step process:
+</p>
+<ol>
+ <li>Set the Source Type property to a valid Flume source type.</li>
+ <li>
+ Set the Agent Name property to the name of the agent in your
+ Flume configuration. This is the prefix of the properties in the Flume
+ configuration file. Example: <code>tier1</code>
+ </li>
+ <li>
+ Set the Source Name property to the name of the source in your Flume
+ configuration. If Agent Name is <code>tier1</code>, then the Source Name
+ is the value of the <code>tier1.sources</code> property. Example: <code>src-1</code>
+ </li>
+ <li>
+ Copy and paste the configuration for the source from your Flume configuration
+ file into the Flume Configuration property. Assuming you're using
+ the same Agent Name and Source Name as in the examples above, this will be all
+ of the properties that start with <code>tier1.sources.src-1</code>.
+ Do not copy the <code>tier1.sources.src-1.type</code> or
+ <code>tier1.sources.src-1.channel</code> properties.
+ </li>
+</ol>
+<h2>Usage Example</h2>
+<p>
+ Assuming you had the following existing Flume configuration file:
+</p>
+ <pre>
+a1.sources = r1
+a1.sinks = k1
+a1.channels = c1
+
+a1.sources.r1.type = multiport_syslogtcp
+a1.sources.r1.channels = c1
+a1.sources.r1.host = 0.0.0.0
+a1.sources.r1.ports = 10001 10002 10003
+a1.sources.r1.portHeader = port
+
+a1.sinks.k1.type = logger
+
+a1.channels.c1.type = memory
+a1.channels.c1.capacity = 1000
+a1.channels.c1.transactionCapacity = 100
+
+a1.sources.r1.channels = c1
+a1.sinks.k1.channel = c1</pre>
+<p>
+ Then you'd configure the ExecuteFlumeSource as follows:
+</p>
+<table id="example">
+ <tr>
+ <th>Property</th>
+ <th>Value</th>
+ </tr>
+ <tr>
+ <td>Source Type</td>
+ <td>multiport_syslogtcp</td>
+ </tr>
+ <tr>
+ <td>Agent Name</td>
+ <td>a1</td>
+ </tr>
+ <tr>
+ <td>Source Name</td>
+ <td>r1</td>
+ </tr>
+ <tr>
+ <td>Flume Configuration</td>
+ <td>
+ <code>
+ a1.sources.r1.host = 0.0.0.0<br>
+ a1.sources.r1.ports = 10001 10002 10003<br>
+ a1.sources.r1.portHeader = port
+ </code>
+ </td>
+ </tr>
+</table>
+</body>
+</html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-flume-nar/1.7.1/org.apache.nifi.processors.flume.ExecuteFlumeSource/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-flume-nar/1.7.1/org.apache.nifi.processors.flume.ExecuteFlumeSource/index.html?rev=1836075&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-flume-nar/1.7.1/org.apache.nifi.processors.flume.ExecuteFlumeSource/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-flume-nar/1.7.1/org.apache.nifi.processors.flume.ExecuteFlumeSource/index.html Tue Jul 17 01:35:38 2018
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ExecuteFlumeSource</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;">ExecuteFlumeSource</h1><h2>Description: </h2><p>Execute a Flume source. Each Flume Event is sent to the success relationship as a FlowFile</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>flume, hadoop, get, source</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="nam
e"><strong>Source Type</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The component type name for the source. For some sources, this is a short, symbolic name (e.g. spooldir). For others, it's the fully-qualified name of the Source class. See the Flume User Guide for details.</td></tr><tr><td id="name"><strong>Agent Name</strong></td><td id="default-value">tier1</td><td id="allowable-values"></td><td id="description">The name of the agent used in the Flume source configuration</td></tr><tr><td id="name"><strong>Source Name</strong></td><td id="default-value">src-1</td><td id="allowable-values"></td><td id="description">The name of the source used in the Flume source configuration</td></tr><tr><td id="name"><strong>Flume Configuration</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Flume configuration for the source copied from the flume.properties file</td></tr></table><h3>Relationships: <
/h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td></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><table id="restrictions"><tr><th>Required Permission</th><th>Explanation</th></tr><tr><td>execute code</td><td>Provides operator the ability to execute arbitrary Flume configurations assuming all permissions that NiFi has.</td></tr></table><h3>Input requirement: </h3>This component does not allow 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-gcp-nar/1.7.1/org.apache.nifi.processors.gcp.credentials.service.GCPCredentialsControllerService/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-gcp-nar/1.7.1/org.apache.nifi.processors.gcp.credentials.service.GCPCredentialsControllerService/index.html?rev=1836075&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-gcp-nar/1.7.1/org.apache.nifi.processors.gcp.credentials.service.GCPCredentialsControllerService/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-gcp-nar/1.7.1/org.apache.nifi.processors.gcp.credentials.service.GCPCredentialsControllerService/index.html Tue Jul 17 01:35:38 2018
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GCPCredentialsControllerService</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;">GCPCredentialsControllerService</h1><h2>Description: </h2><p>Defines credentials for Google Cloud Platform processors. Uses Application Default credentials without configuration. Application Default credentials support environmental variable (GOOGLE_APPLICATION_CREDENTIALS) pointing to a credential file, the config generated by `gcloud auth application-default login`, AppEngine/Compute Engine service accounts, etc.</p><h3>Tags: </h3><p>gcp, credentials, provider</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">Use Application Default Credentials</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If true, uses Google Application Default Credentials, which checks the GOOGLE_APPLICATION_CREDENTIALS environment variable for a filepath to a service account JSON key, the config generated by the gcloud sdk, the A
pp Engine service account, and the Compute Engine service account.</td></tr><tr><td id="name">Use Compute Engine Credentials</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If true, uses Google Compute Engine Credentials of the Compute Engine VM Instance which NiFi is running on.</td></tr><tr><td id="name">Service Account JSON File</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Path to a file containing a Service Account key file in JSON format.</td></tr><tr><td id="name">Service Account JSON</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The raw JSON containing a Service Account keyfile.<br/><strong>Sensitive Property: true</strong><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: </h
3>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-gcp-nar/1.7.1/org.apache.nifi.processors.gcp.pubsub.ConsumeGCPubSub/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-gcp-nar/1.7.1/org.apache.nifi.processors.gcp.pubsub.ConsumeGCPubSub/index.html?rev=1836075&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-gcp-nar/1.7.1/org.apache.nifi.processors.gcp.pubsub.ConsumeGCPubSub/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-gcp-nar/1.7.1/org.apache.nifi.processors.gcp.pubsub.ConsumeGCPubSub/index.html Tue Jul 17 01:35:38 2018
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ConsumeGCPubSub</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;">ConsumeGCPubSub</h1><h2>Description: </h2><p>Consumes message from the configured Google Cloud PubSub subscription. If the 'Batch Size' is set, the configured number of messages will be pulled in a single request, else only one message will be pulled.</p><h3>Tags: </h3><p>google, google-cloud, gcp, message, pubsub, consume</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>Project ID</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Google Cloud Project ID</td></tr><tr><td id="name"><strong>GCP Credentials Provider Service</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>GCPCredentialsService<br/><strong>Implementation: </strong><a href="../org.apache.nifi.processors.gcp.credentials.service.GCPCredentialsControllerService/index.html">GCPCredentialsControllerService</a></td><td id="description">The Controller Service used to obtain Google Cloud Platform credentials.</td></tr><tr><td id="name"><strong>Subscription</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Name of the Google Cloud Pub/Sub Subscr
iption<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Batch Size</strong></td><td id="default-value">15</td><td id="allowable-values"></td><td id="description">Indicates the number of messages the cloud service should bundle together in a batch. If not set and left empty, only one message will be used in a batch</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 after a successful Google Cloud Pub/Sub 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>gcp.pubsub.ackId</td><td>Acknowledgement Id of the consumed Google Cloud PubSub message</td></tr><tr><td>gcp.pubsub.messageSize</td><td>Serialized size of the consumed Google Cloud PubSub message</
td></tr><tr><td>gcp.pubsub.attributesCount</td><td>Number of attributes the consumed PubSub message has, if any</td></tr><tr><td>gcp.pubsub.publishTime</td><td>Timestamp value when the message was published</td></tr><tr><td>Dynamic Attributes</td><td>Other than the listed attributes, this processor may write zero or more attributes, if the original Google Cloud Publisher client added any attributes to the message while sending</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 does not allow an incoming relationship.<h3>System Resource Considerations:</h3>None specified.<h3>See Also:</h3><p><a href="../org.apache.nifi.processors.gcp.pubsub.PublishGCPubSub/index.html">PublishGCPubSub</a></p></body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-gcp-nar/1.7.1/org.apache.nifi.processors.gcp.pubsub.PublishGCPubSub/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-gcp-nar/1.7.1/org.apache.nifi.processors.gcp.pubsub.PublishGCPubSub/index.html?rev=1836075&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-gcp-nar/1.7.1/org.apache.nifi.processors.gcp.pubsub.PublishGCPubSub/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-gcp-nar/1.7.1/org.apache.nifi.processors.gcp.pubsub.PublishGCPubSub/index.html Tue Jul 17 01:35:38 2018
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PublishGCPubSub</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;">PublishGCPubSub</h1><h2>Description: </h2><p>Publishes the content of the incoming flowfile to the configured Google Cloud PubSub topic. The processor supports dynamic properties. If any dynamic properties are present, they will be sent along with the message in the form of 'attributes'.</p><h3>Tags: </h3><p>google, google-cloud, gcp, message, pubsub, publish</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>Project ID</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Google Cloud Project ID</td></tr><tr><td id="name"><strong>GCP Credentials Provider Service</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>GCPCredentialsService<br/><strong>Implementation: </strong><a href="../org.apache.nifi.processors.gcp.credentials.service.GCPCredentialsControllerService/index.html">GCPCredentialsControllerService</a></td><td id="description">The Controller Service used to obtain Google Cloud Platform credentials.</td></tr><tr><td id="name"><strong>Topic Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Name
of the Google Cloud PubSub Topic<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Batch Size</strong></td><td id="default-value">15</td><td id="allowable-values"></td><td id="description">Indicates the number of messages the cloud service should bundle together in a batch. If not set and left empty, only one message will be used in a batch</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">Attribute name</td><td id="value">Value to be set to the attribute</td><td>Attributes to be set for the outgoing Google Cloud PubSub message<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="rela
tionships"><tr><th>Name</th><th>Description</th></tr><tr><td>retry</td><td>FlowFiles are routed to this relationship if the Google Cloud Pub/Sub operation fails but attempting the operation again may succeed.</td></tr><tr><td>success</td><td>FlowFiles are routed to this relationship after a successful Google Cloud Pub/Sub operation.</td></tr><tr><td>failure</td><td>FlowFiles are routed to this relationship if the Google Cloud Pub/Sub operation fails.</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>gcp.pubsub.messageId</td><td>ID of the pubsub message published to the configured Google Cloud PubSub topic</td></tr><tr><td>gcp.pubsub.topic</td><td>Name of the Google Cloud PubSub topic the message was published to</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.gcp.pubsub.ConsumeGCPubSub/index.html">ConsumeGCPubSub</a></p></body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-gcp-nar/1.7.1/org.apache.nifi.processors.gcp.storage.DeleteGCSObject/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-gcp-nar/1.7.1/org.apache.nifi.processors.gcp.storage.DeleteGCSObject/index.html?rev=1836075&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-gcp-nar/1.7.1/org.apache.nifi.processors.gcp.storage.DeleteGCSObject/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-gcp-nar/1.7.1/org.apache.nifi.processors.gcp.storage.DeleteGCSObject/index.html Tue Jul 17 01:35:38 2018
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>DeleteGCSObject</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;">DeleteGCSObject</h1><h2>Description: </h2><p>Deletes objects from a Google Cloud Bucket. If attempting to delete a file that does not exist, FlowFile is routed to success.</p><h3>Tags: </h3><p>google cloud, gcs, google, storage, delete</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="properti
es"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>GCP Credentials Provider Service</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>GCPCredentialsService<br/><strong>Implementation: </strong><a href="../org.apache.nifi.processors.gcp.credentials.service.GCPCredentialsControllerService/index.html">GCPCredentialsControllerService</a></td><td id="description">The Controller Service used to obtain Google Cloud Platform credentials.</td></tr><tr><td id="name"><strong>Project ID</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Google Cloud Project ID</td></tr><tr><td id="name"><strong>Number of retries</strong></td><td id="default-value">6</td><td id="allowable-values"></td><td id="description">How many retry attempts should be made before routing to the failure relationship.</td></tr><tr><td id="name">Proxy host</
td><td id="default-value"></td><td id="allowable-values"></td><td id="description">IP or hostname of the proxy to be used</td></tr><tr><td id="name">Proxy port</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Proxy port number</td></tr><tr><td id="name"><strong>Bucket</strong></td><td id="default-value">${gcs.bucket}</td><td id="allowable-values"></td><td id="description">Bucket of the object.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Key</strong></td><td id="default-value">${filename}</td><td id="allowable-values"></td><td id="description">Name of the object.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Generation</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The generation of the object t
o be deleted. If null, will use latest version of the object.<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 are routed to this relationship after a successful Google Cloud Storage operation.</td></tr><tr><td>failure</td><td>FlowFiles are routed to this relationship if the Google Cloud Storage operation fails.</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.<h3>See Also:</h3><p><a href="../org.apache.nifi.processors.gcp.storage.PutGCSObject/index.html">PutGCSObject</a>
, <a href="../org.apache.nifi.processors.gcp.storage.FetchGCSObject/index.html">FetchGCSObject</a>, <a href="../org.apache.nifi.processors.gcp.storage.ListGCSBucket/index.html">ListGCSBucket</a></p></body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-gcp-nar/1.7.1/org.apache.nifi.processors.gcp.storage.FetchGCSObject/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-gcp-nar/1.7.1/org.apache.nifi.processors.gcp.storage.FetchGCSObject/index.html?rev=1836075&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-gcp-nar/1.7.1/org.apache.nifi.processors.gcp.storage.FetchGCSObject/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-gcp-nar/1.7.1/org.apache.nifi.processors.gcp.storage.FetchGCSObject/index.html Tue Jul 17 01:35:38 2018
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>FetchGCSObject</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;">FetchGCSObject</h1><h2>Description: </h2><p>Fetches a file from a Google Cloud Bucket. Designed to be used in tandem with ListGCSBucket.</p><h3>Tags: </h3><p>google cloud, google, storage, gcs, fetch</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>GCP Credentials Provider Service</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>GCPCredentialsService<br/><strong>Implementation: </strong><a href="../org.apache.nifi.processors.gcp.credentials.service.GCPCredentialsControllerService/index.html">GCPCredentialsControllerService</a></td><td id="description">The Controller Service used to obtain Google Cloud Platform credentials.</td></tr><tr><td id="name"><strong>Project ID</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Google Cloud Project ID</td></tr><tr><td id="name"><strong>Number
of retries</strong></td><td id="default-value">6</td><td id="allowable-values"></td><td id="description">How many retry attempts should be made before routing to the failure relationship.</td></tr><tr><td id="name">Proxy host</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">IP or hostname of the proxy to be used</td></tr><tr><td id="name">Proxy port</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Proxy port number</td></tr><tr><td id="name"><strong>Bucket</strong></td><td id="default-value">${gcs.bucket}</td><td id="allowable-values"></td><td id="description">Bucket of the object.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Key</strong></td><td id="default-value">${filename}</td><td id="allowable-values"></td><td id="description">Name of the object.<br/><strong>Supports Expression Language: true (wi
ll be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Object Generation</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The generation of the Object to download. If null, will download latest generation.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Server Side Encryption Key</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">An AES256 Key (encoded in base64) which the object has been encrypted in.<br/><strong>Sensitive Property: true</strong><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 are routed to this relationship after a successful Google
Cloud Storage operation.</td></tr><tr><td>failure</td><td>FlowFiles are routed to this relationship if the Google Cloud Storage operation fails.</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>filename</td><td>The name of the file, parsed if possible from the Content-Disposition response header</td></tr><tr><td>gcs.bucket</td><td>Bucket of the object.</td></tr><tr><td>gcs.key</td><td>Name of the object.</td></tr><tr><td>gcs.size</td><td>Size of the object.</td></tr><tr><td>gcs.cache.control</td><td>Data cache control of the object.</td></tr><tr><td>gcs.component.count</td><td>The number of components which make up the object.</td></tr><tr><td>gcs.content.disposition</td><td>The data content disposition of the object.</td></tr><tr><td>gcs.content.encoding</td><td>The content encoding of the object.</td></tr><tr><td>gcs.content.language</td><td>The content language of
the object.</td></tr><tr><td>mime.type</td><td>The MIME/Content-Type of the object</td></tr><tr><td>gcs.crc32c</td><td>The CRC32C checksum of object's data, encoded in base64 in big-endian order.</td></tr><tr><td>gcs.create.time</td><td>The creation time of the object (milliseconds)</td></tr><tr><td>gcs.update.time</td><td>The last modification time of the object (milliseconds)</td></tr><tr><td>gcs.encryption.algorithm</td><td>The algorithm used to encrypt the object.</td></tr><tr><td>gcs.encryption.sha256</td><td>The SHA256 hash of the key used to encrypt the object</td></tr><tr><td>gcs.etag</td><td>The HTTP 1.1 Entity tag for the object.</td></tr><tr><td>gcs.generated.id</td><td>The service-generated for the object</td></tr><tr><td>gcs.generation</td><td>The data generation of the object.</td></tr><tr><td>gcs.md5</td><td>The MD5 hash of the object's data encoded in base64.</td></tr><tr><td>gcs.media.link</td><td>The media download link to the object.</td></tr><tr><td>gcs.metagene
ration</td><td>The metageneration of the object.</td></tr><tr><td>gcs.owner</td><td>The owner (uploader) of the object.</td></tr><tr><td>gcs.owner.type</td><td>The ACL entity type of the uploader of the object.</td></tr><tr><td>gcs.uri</td><td>The URI of the object as a string.</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.gcp.storage.ListGCSBucket/index.html">ListGCSBucket</a>, <a href="../org.apache.nifi.processors.gcp.storage.PutGCSObject/index.html">PutGCSObject</a>, <a href="../org.apache.nifi.processors.gcp.storage.DeleteGCSObject/index.html">DeleteGCSObject</a></p></body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-gcp-nar/1.7.1/org.apache.nifi.processors.gcp.storage.ListGCSBucket/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-gcp-nar/1.7.1/org.apache.nifi.processors.gcp.storage.ListGCSBucket/index.html?rev=1836075&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-gcp-nar/1.7.1/org.apache.nifi.processors.gcp.storage.ListGCSBucket/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-gcp-nar/1.7.1/org.apache.nifi.processors.gcp.storage.ListGCSBucket/index.html Tue Jul 17 01:35:38 2018
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ListGCSBucket</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;">ListGCSBucket</h1><h2>Description: </h2><p>Retrieves a listing of objects from an GCS bucket. For each object that is listed, creates a FlowFile that represents the object so that it can be fetched in conjunction with FetchGCSObject. This Processor is designed to run on Primary Node only in a cluster. If the primary node changes, the new Primary Node will pick up where the previous node left off without duplicating all of the data.</p><h3>Tags: </h3><p>google cloud, google, storage, gcs, list</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</str
ong>. 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>GCP Credentials Provider Service</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>GCPCredentialsService<br/><strong>Implementation: </strong><a href="../org.apache.nifi.processors.gcp.credentials.service.GCPCredentialsControllerService/index.html">GCPCredentialsControllerService</a></td><td id="description">The Controller Service used to obtain Google Cloud Platform credentials.</td></tr><tr><td id="name"><strong>Project ID</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Google Cloud Project ID</td></tr><tr><td id="name"><strong>Number of retries</strong></td><td id="default-value">6</td><td id="allowable-values"></td><td id="de
scription">How many retry attempts should be made before routing to the failure relationship.</td></tr><tr><td id="name">Proxy host</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">IP or hostname of the proxy to be used</td></tr><tr><td id="name">Proxy port</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Proxy port number</td></tr><tr><td id="name"><strong>Bucket</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Bucket of the object.</td></tr><tr><td id="name">Prefix</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The prefix used to filter the object list. In most cases, it should end with a forward slash ('/').</td></tr><tr><td id="name"><strong>Use Generations</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 to use GCS Generations,
if applicable. If false, only the latest version of each object will be returned.</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 after a successful Google Cloud Storage 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 name of the file</td></tr><tr><td>gcs.bucket</td><td>Bucket of the object.</td></tr><tr><td>gcs.key</td><td>Name of the object.</td></tr><tr><td>gcs.size</td><td>Size of the object.</td></tr><tr><td>gcs.cache.control</td><td>Data cache control of the object.</td></tr><tr><td>gcs.component.count</td><td>The number of components which make up the object.</td></tr><tr><td>gcs.content.disposition</td><td>The data content disposition of the object.</td></tr><tr><td>gcs.content.encoding</td><td>The co
ntent encoding of the object.</td></tr><tr><td>gcs.content.language</td><td>The content language of the object.</td></tr><tr><td>mime.type</td><td>The MIME/Content-Type of the object</td></tr><tr><td>gcs.crc32c</td><td>The CRC32C checksum of object's data, encoded in base64 in big-endian order.</td></tr><tr><td>gcs.create.time</td><td>The creation time of the object (milliseconds)</td></tr><tr><td>gcs.update.time</td><td>The last modification time of the object (milliseconds)</td></tr><tr><td>gcs.encryption.algorithm</td><td>The algorithm used to encrypt the object.</td></tr><tr><td>gcs.encryption.sha256</td><td>The SHA256 hash of the key used to encrypt the object</td></tr><tr><td>gcs.etag</td><td>The HTTP 1.1 Entity tag for the object.</td></tr><tr><td>gcs.generated.id</td><td>The service-generated for the object</td></tr><tr><td>gcs.generation</td><td>The data generation of the object.</td></tr><tr><td>gcs.md5</td><td>The MD5 hash of the object's data encoded in base64.</td></tr>
<tr><td>gcs.media.link</td><td>The media download link to the object.</td></tr><tr><td>gcs.metageneration</td><td>The metageneration of the object.</td></tr><tr><td>gcs.owner</td><td>The owner (uploader) of the object.</td></tr><tr><td>gcs.owner.type</td><td>The ACL entity type of the uploader of the object.</td></tr><tr><td>gcs.uri</td><td>The URI of the object as a string.</td></tr></table><h3>State management: </h3><table id="stateful"><tr><th>Scope</th><th>Description</th></tr><tr><td>CLUSTER</td><td>After performing a listing of keys, the timestamp of the newest key is stored, along with the keys that share that same timestamp. This allows the Processor to list only keys that have been added or modified after this date the next time that the Processor is run. State is stored across the cluster so that this Processor can be run on Primary Node only and if a new Primary Node is selected, the new node can pick up where the previous node left off, without duplicating the data.</td>
</tr></table><h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component does not allow an incoming relationship.<h3>System Resource Considerations:</h3>None specified.<h3>See Also:</h3><p><a href="../org.apache.nifi.processors.gcp.storage.PutGCSObject/index.html">PutGCSObject</a>, <a href="../org.apache.nifi.processors.gcp.storage.DeleteGCSObject/index.html">DeleteGCSObject</a>, <a href="../org.apache.nifi.processors.gcp.storage.FetchGCSObject/index.html">FetchGCSObject</a></p></body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-gcp-nar/1.7.1/org.apache.nifi.processors.gcp.storage.PutGCSObject/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-gcp-nar/1.7.1/org.apache.nifi.processors.gcp.storage.PutGCSObject/index.html?rev=1836075&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-gcp-nar/1.7.1/org.apache.nifi.processors.gcp.storage.PutGCSObject/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-gcp-nar/1.7.1/org.apache.nifi.processors.gcp.storage.PutGCSObject/index.html Tue Jul 17 01:35:38 2018
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutGCSObject</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;">PutGCSObject</h1><h2>Description: </h2><p>Puts flow files to a Google Cloud Bucket.</p><h3>Tags: </h3><p>google, google cloud, gcs, archive, put</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, 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>GCP Credentials Provider Service</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>GCPCredentialsService<br/><strong>Implementation: </strong><a href="../org.apache.nifi.processors.gcp.credentials.service.GCPCredentialsControllerService/index.html">GCPCredentialsControllerService</a></td><td id="description">The Controller Service used to obtain Google Cloud Platform credentials.</td></tr><tr><td id="name"><strong>Project ID</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Google Cloud Project ID</td></tr><tr><td id="name"><strong>Number of retries</strong></td><td id="default-value">6</td><td
id="allowable-values"></td><td id="description">How many retry attempts should be made before routing to the failure relationship.</td></tr><tr><td id="name">Proxy host</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">IP or hostname of the proxy to be used</td></tr><tr><td id="name">Proxy port</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Proxy port number</td></tr><tr><td id="name"><strong>Bucket</strong></td><td id="default-value">${gcs.bucket}</td><td id="allowable-values"></td><td id="description">Bucket of the object.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Key</strong></td><td id="default-value">${filename}</td><td id="allowable-values"></td><td id="description">Name of the object.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable r
egistry)</strong></td></tr><tr><td id="name">Content Type</td><td id="default-value">${mime.type}</td><td id="allowable-values"></td><td id="description">Content Type for the file, i.e. text/plain<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">MD5 Hash</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">MD5 Hash (encoded in Base64) of the file for server-side validation.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">CRC32C Checksum</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">CRC32C Checksum (encoded in Base64, big-Endian order) of the file for server-side validation.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><t
d id="name">Object ACL</td><td id="default-value"></td><td id="allowable-values"><ul><li>All Authenticated Users <img src="../../../../../html/images/iconInfo.png" alt="Gives the bucket or object owner OWNER permission, and gives all authenticated Google account holders READER and WRITER permissions. All other permissions are removed." title="Gives the bucket or object owner OWNER permission, and gives all authenticated Google account holders READER and WRITER permissions. All other permissions are removed."></img></li><li>Authenticated Read <img src="../../../../../html/images/iconInfo.png" alt="Gives the bucket or object owner OWNER permission, and gives all authenticated Google account holders READER permission. All other permissions are removed." title="Gives the bucket or object owner OWNER permission, and gives all authenticated Google account holders READER permission. All other permissions are removed."></img></li><li>Bucket Owner Full Control <img src="../../../../../html/i
mages/iconInfo.png" alt="Gives the object and bucket owners OWNER permission. All other permissions are removed." title="Gives the object and bucket owners OWNER permission. All other permissions are removed."></img></li><li>Bucket Owner Read Only <img src="../../../../../html/images/iconInfo.png" alt="Gives the object owner OWNER permission, and gives the bucket owner READER permission. All other permissions are removed." title="Gives the object owner OWNER permission, and gives the bucket owner READER permission. All other permissions are removed."></img></li><li>Private <img src="../../../../../html/images/iconInfo.png" alt="Gives the bucket or object owner OWNER permission for a bucket or object, and removes all other access permissions." title="Gives the bucket or object owner OWNER permission for a bucket or object, and removes all other access permissions."></img></li><li>Project Private <img src="../../../../../html/images/iconInfo.png" alt="Gives permission to the project t
eam based on their roles. Anyone who is part of the team has READER permission. Project owners and project editors have OWNER permission. This is the default ACL for newly created buckets. This is also the default ACL for newly created objects unless the default object ACL for that bucket has been changed." title="Gives permission to the project team based on their roles. Anyone who is part of the team has READER permission. Project owners and project editors have OWNER permission. This is the default ACL for newly created buckets. This is also the default ACL for newly created objects unless the default object ACL for that bucket has been changed."></img></li><li>Public Read Only <img src="../../../../../html/images/iconInfo.png" alt="Gives the bucket or object owner OWNER permission, and gives all users, both authenticated and anonymous, READER permission. When you apply this to an object, anyone on the Internet can read the object without authenticating." title="Gives the bucket
or object owner OWNER permission, and gives all users, both authenticated and anonymous, READER permission. When you apply this to an object, anyone on the Internet can read the object without authenticating."></img></li></ul></td><td id="description">Access Control to be attached to the object uploaded. Not providing this will revert to bucket defaults.</td></tr><tr><td id="name">Server Side Encryption Key</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">An AES256 Encryption Key (encoded in base64) for server-side encryption of the object.<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Overwrite Object</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 false, the upload to GCS will succeed only if the object
does not exist.</td></tr><tr><td id="name">Content Disposition Type</td><td id="default-value"></td><td id="allowable-values"><ul><li>Inline <img src="../../../../../html/images/iconInfo.png" alt="Indicates that the object should be loaded and rendered within the browser." title="Indicates that the object should be loaded and rendered within the browser."></img></li><li>Attachment <img src="../../../../../html/images/iconInfo.png" alt="Indicates that the object should be saved (using a Save As... dialog) rather than opened directly within the browser" title="Indicates that the object should be saved (using a Save As... dialog) rather than opened directly within the browser"></img></li></ul></td><td id="description">Type of RFC-6266 Content Disposition to be attached to the object</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>Descrip
tion</th></tr><tr><td id="name">The name of a User-Defined Metadata field to add to the GCS Object</td><td id="value">The value of a User-Defined Metadata field to add to the GCS Object</td><td>Allows user-defined metadata to be added to the GCS object as key/value pairs<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>success</td><td>FlowFiles are routed to this relationship after a successful Google Cloud Storage operation.</td></tr><tr><td>failure</td><td>FlowFiles are routed to this relationship if the Google Cloud Storage operation fails.</td></tr></table><h3>Reads Attributes: </h3><table id="reads-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>filename</td><td>Uses the FlowFile's filename as the filename for the GCS object</td></tr><tr><td>mime.type</td><td>Uses the Fl
owFile's MIME type as the content-type for the GCS object</td></tr></table><h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>gcs.bucket</td><td>Bucket of the object.</td></tr><tr><td>gcs.key</td><td>Name of the object.</td></tr><tr><td>gcs.size</td><td>Size of the object.</td></tr><tr><td>gcs.cache.control</td><td>Data cache control of the object.</td></tr><tr><td>gcs.component.count</td><td>The number of components which make up the object.</td></tr><tr><td>gcs.content.disposition</td><td>The data content disposition of the object.</td></tr><tr><td>gcs.content.encoding</td><td>The content encoding of the object.</td></tr><tr><td>gcs.content.language</td><td>The content language of the object.</td></tr><tr><td>mime.type</td><td>The MIME/Content-Type of the object</td></tr><tr><td>gcs.crc32c</td><td>The CRC32C checksum of object's data, encoded in base64 in big-endian order.</td></tr><tr><td>gcs.create.time</td><td>The creatio
n time of the object (milliseconds)</td></tr><tr><td>gcs.update.time</td><td>The last modification time of the object (milliseconds)</td></tr><tr><td>gcs.encryption.algorithm</td><td>The algorithm used to encrypt the object.</td></tr><tr><td>gcs.encryption.sha256</td><td>The SHA256 hash of the key used to encrypt the object</td></tr><tr><td>gcs.etag</td><td>The HTTP 1.1 Entity tag for the object.</td></tr><tr><td>gcs.generated.id</td><td>The service-generated for the object</td></tr><tr><td>gcs.generation</td><td>The data generation of the object.</td></tr><tr><td>gcs.md5</td><td>The MD5 hash of the object's data encoded in base64.</td></tr><tr><td>gcs.media.link</td><td>The media download link to the object.</td></tr><tr><td>gcs.metageneration</td><td>The metageneration of the object.</td></tr><tr><td>gcs.owner</td><td>The owner (uploader) of the object.</td></tr><tr><td>gcs.owner.type</td><td>The ACL entity type of the uploader of the object.</td></tr><tr><td>gcs.uri</td><td>The U
RI of the object as a string.</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.gcp.storage.FetchGCSObject/index.html">FetchGCSObject</a>, <a href="../org.apache.nifi.processors.gcp.storage.DeleteGCSObject/index.html">DeleteGCSObject</a>, <a href="../org.apache.nifi.processors.gcp.storage.ListGCSBucket/index.html">ListGCSBucket</a></p></body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-groovyx-nar/1.7.1/org.apache.nifi.processors.groovyx.ExecuteGroovyScript/SQL.gif
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-groovyx-nar/1.7.1/org.apache.nifi.processors.groovyx.ExecuteGroovyScript/SQL.gif?rev=1836075&view=auto
==============================================================================
Binary file - no diff available.
Propchange: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-groovyx-nar/1.7.1/org.apache.nifi.processors.groovyx.ExecuteGroovyScript/SQL.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-groovyx-nar/1.7.1/org.apache.nifi.processors.groovyx.ExecuteGroovyScript/SQL2.gif
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-groovyx-nar/1.7.1/org.apache.nifi.processors.groovyx.ExecuteGroovyScript/SQL2.gif?rev=1836075&view=auto
==============================================================================
Binary file - no diff available.
Propchange: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-groovyx-nar/1.7.1/org.apache.nifi.processors.groovyx.ExecuteGroovyScript/SQL2.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-groovyx-nar/1.7.1/org.apache.nifi.processors.groovyx.ExecuteGroovyScript/additionalDetails.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-groovyx-nar/1.7.1/org.apache.nifi.processors.groovyx.ExecuteGroovyScript/additionalDetails.html?rev=1836075&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-groovyx-nar/1.7.1/org.apache.nifi.processors.groovyx.ExecuteGroovyScript/additionalDetails.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-groovyx-nar/1.7.1/org.apache.nifi.processors.groovyx.ExecuteGroovyScript/additionalDetails.html Tue Jul 17 01:35:38 2018
@@ -0,0 +1,203 @@
+<!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>Groovy</title>
+ <!--link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /-->
+ <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" />
+</head>
+
+<body>
+<h2>Summary</h2>
+<p>This is a grooviest groovy script :)</p>
+<h2>Script Bindings:</h2>
+<table>
+<tr><th>variable</th><th>type</th><th>description</th></tr>
+<tr>
+ <td>session</td>
+ <td>org.apache.nifi.processor.ProcessSession</td>
+ <td>the session that is used to get, change, and transfer input files</td>
+</tr>
+<tr>
+ <td>context</td>
+ <td>org.apache.nifi.processor.ProcessContext</td>
+ <td>the context (almost unuseful)</td>
+</tr>
+<tr>
+ <td>log</td>
+ <td>org.apache.nifi.logging.ComponentLog</td>
+ <td>the logger for this processor instance</td>
+</tr>
+<tr>
+ <td>REL_SUCCESS</td>
+ <td>org.apache.nifi.processor.Relationship</td>
+ <td>the success relationship</td>
+</tr>
+<tr>
+ <td>REL_FAILURE</td>
+ <td>org.apache.nifi.processor.Relationship</td>
+ <td>the failure relationship</td>
+</tr>
+<tr>
+ <td>CTL</td>
+ <td>java.util.HashMap<String,<a href="https://github.com/apache/nifi/blob/master/nifi-api/src/main/java/org/apache/nifi/controller/ControllerService.java">ControllerService</a>></td>
+ <td>Map populated with controller services defined with `CTL.*` processor properties.
+ <br/>The `CTL.` prefixed properties could be linked to controller service and provides access to this service from a script without additional code.</td>
+</tr>
+<tr>
+ <td>SQL</td>
+ <td>java.util.HashMap<String, <a href="http://docs.groovy-lang.org/latest/html/api/groovy/sql/Sql.html">groovy.sql.Sql</a>></td>
+ <td>Map populated with `groovy.sql.Sql` objects connected to corresponding database defined with `SQL.*` processor properties.
+ <br/>The `SQL.` prefixed properties could be linked only to DBCPSercice.</td>
+</tr>
+<tr>
+ <td>Dynamic processor properties</td>
+ <td>org.apache.nifi.components.PropertyDescriptor</td>
+ <td>All processor properties not started with `CTL.` or `SQL.` are bound to script variables</td>
+</tr>
+</table>
+
+<h2>SQL map details</h2>
+<p>
+<b>Example:</b> if you defined property <code>`SQL.mydb`</code> and linked it to any DBCPService,
+then you can access it from code <code>SQL.mydb.rows('select * from mytable')</code><br/>
+
+<br/>The processor automatically takes connection from dbcp service before executing script and tries to handle transaction:
+<br/> database transactions automatically rolled back on script exception and committed on success.
+<br/>Or you can manage transaction manually.
+<br/>NOTE: Script must not disconnect connection.
+
+<br/><img src="SQL.gif"/>
+<br/><img src="SQL2.gif"/>
+</p>
+
+<h2>SessionFile - flow file extension</h2>
+<p>
+ The (org.apache.nifi.processors.groovyx.flow.SessionFile) is an actual object returned by session in Extended Groovy processor.<br/>
+ This flow file is a container that references session and the real flow file.<br/>
+ This allows to use simplified syntax to work with file attributes and content:
+</p>
+<p><i>set new attribute value</i></p>
+<pre>
+ flowFile.ATTRIBUTE_NAME = ATTRIBUTE_VALUE
+ flowFile.'mime.type' = 'text/xml'
+ flowFile.putAttribute("ATTRIBUTE_NAME", ATTRIBUTE_VALUE)
+ //the same as
+ flowFile = session.putAttribute(flowFile, "ATTRIBUTE_NAME", ATTRIBUTE_VALUE)
+</pre>
+
+<p><i>remove attribute</i></p>
+<pre>
+ flowFile.ATTRIBUTE_NAME = null
+ //equals to
+ flowFile = session.removeAttribute(flowFile, "ATTRIBUTE_NAME")
+</pre>
+
+<p><i>get attribute value</i></p>
+<pre>
+ String a = flowFile.ATTRIBUTE_NAME
+</pre>
+
+<p><i>write content</i></p>
+<pre>
+ flowFile.write("UTF-8", "THE CharSequence to write into flow file replacing current content")
+ flowFile.write("UTF-8"){writer->
+ do something with java.io.Writer...
+ }
+ flowFile.write{outStream->
+ do something with output stream...
+ }
+ flowFile.write{inStream, outStream->
+ do something with input and output streams...
+ }
+</pre>
+
+<p><i>get content</i></p>
+<pre>
+ InputStream i = flowFile.read()
+ def json = new groovy.json.JsonSlurper().parse( flowFile.read() )
+ String text = flowFile.read().getText("UTF-8")
+</pre>
+
+<p><i>transfer flow file to success relation</i></p>
+<pre>
+ REL_SUCCESS << flowFile
+ flowFile.transfer(REL_SUCCESS)
+ //the same as:
+ session.transfer(flowFile, REL_SUCCESS)
+</pre>
+
+<p><i>work with dbcp</i></p>
+<pre>
+ import groovy.sql.Sql
+
+ //define property named `SQL.db` connected to a DBCPConnectionPool controller service
+ //for this case it's an H2 database example
+
+ //read value from the database with prepared statement
+ //and assign into flowfile attribute `db.yesterday`
+ def daysAdd = -1
+ def row = SQL.db.firstRow("select dateadd('DAY', ${daysAdd}, sysdate) as DB_DATE from dual")
+ flowFile.'db.yesterday' = row.DB_DATE
+
+ //to work with BLOBs and CLOBs in the database
+ //use parameter casting using groovy.sql.Sql.BLOB(Stream) and groovy.sql.Sql.CLOB(Reader)
+
+ //write content of the flow file into database blob
+ flowFile.read{ rawIn->
+ def parms = [
+ p_id : flowFile.ID as Long, //get flow file attribute named `ID`
+ p_data : Sql.BLOB( rawIn ), //use input stream as BLOB sql parameter
+ ]
+ SQL.db.executeUpdate(parms, "update mytable set data = :p_data where id = :p_id")
+ }
+</pre>
+
+
+<h2>Handling processor start & stop</h2>
+
+<p>In the extended groovy processor you can catch `start` and `stop` events by providing corresponding static methods:</p>
+<pre>
+ import org.apache.nifi.processor.ProcessContext
+ import java.util.concurrent.atomic.AtomicLong
+
+ class Const{
+ static Date startTime = null;
+ static AtomicLong triggerCount = null;
+ }
+
+ static onStart(ProcessContext context){
+ Const.startTime = new Date()
+ Const.triggerCount = new AtomicLong(0)
+ println "onStart $context ${Const.startTime}"
+ }
+
+ static onStop(ProcessContext context){
+ def alive = (System.currentTimeMillis() - Const.startTime.getTime()) / 1000
+ println "onStop $context executed ${ Const.triggerCount } times during ${ alive } seconds"
+ }
+
+
+ flowFile.'trigger.count' = Const.triggerCount.incrementAndGet()
+ REL_SUCCESS << flowFile
+</pre>
+<br/>
+<br/>
+<br/>
+<br/>
+</body>
+</html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-groovyx-nar/1.7.1/org.apache.nifi.processors.groovyx.ExecuteGroovyScript/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-groovyx-nar/1.7.1/org.apache.nifi.processors.groovyx.ExecuteGroovyScript/index.html?rev=1836075&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-groovyx-nar/1.7.1/org.apache.nifi.processors.groovyx.ExecuteGroovyScript/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-groovyx-nar/1.7.1/org.apache.nifi.processors.groovyx.ExecuteGroovyScript/index.html Tue Jul 17 01:35:38 2018
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ExecuteGroovyScript</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;">ExecuteGroovyScript</h1><h2>Description: </h2><p>Experimental Extended Groovy script processor. The script is responsible for handling the incoming flow file (transfer to SUCCESS or remove, e.g.) as well as any flow files created by the script. If the handling is incomplete or incorrect, the session will be rolled back.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>script, groovy, groovyx</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 opti
onal. 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">Script File</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Path to script file to execute. Only one of Script File or Script Body may be used<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Script Body</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Body of script to execute. Only one of Script File or Script Body may be used</td></tr><tr><td id="name"><strong>Failure strategy</strong></td><td id="default-value">rollback</td><td id="allowable-values"><ul><li>rollback</li><li>transfer to failure</li></ul></td><td id="descrip
tion">What to do with unhandled exceptions. If you want to manage exception by code then keep the default value `rollback`. If `transfer to failure` selected and unhandled exception occurred then all flowFiles received from incoming queues in this session will be transferred to `failure` relationship with additional attributes set: ERROR_MESSAGE and ERROR_STACKTRACE. If `rollback` selected and unhandled exception occurred then all flowFiles received from incoming queues will be penalized and returned. If the processor has no incoming connections then this parameter has no effect.</td></tr><tr><td id="name">Additional classpath</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Classpath list separated by semicolon. You can use masks like `*`, `*.jar` in file name.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr></table><h3>Dynamic Properties: </h3><p>Dynamic Properties allow the user t
o 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 script engine property to update</td><td id="value">The value to set it to</td><td>Updates a script engine property specified by the Dynamic Property's key with the value specified by the Dynamic Property's value. Use `CTL.` to access any controller services.<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>success</td><td>FlowFiles that were successfully processed</td></tr><tr><td>failure</td><td>FlowFiles that failed to 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><table id="restricti
ons"><tr><th>Required Permission</th><th>Explanation</th></tr><tr><td>execute code</td><td>Provides operator the ability to execute arbitrary code assuming all permissions that NiFi has.</td></tr></table><h3>Input requirement: </h3>This component allows an incoming relationship.<h3>System Resource Considerations:</h3>None specified.<h3>See Also:</h3><p><a href="../../../nifi-scripting-nar/1.7.1/org.apache.nifi.processors.script.ExecuteScript/index.html">ExecuteScript</a></p></body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-grpc-nar/1.7.1/org.apache.nifi.processors.grpc.InvokeGRPC/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-grpc-nar/1.7.1/org.apache.nifi.processors.grpc.InvokeGRPC/index.html?rev=1836075&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-grpc-nar/1.7.1/org.apache.nifi.processors.grpc.InvokeGRPC/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-grpc-nar/1.7.1/org.apache.nifi.processors.grpc.InvokeGRPC/index.html Tue Jul 17 01:35:38 2018
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>InvokeGRPC</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;">InvokeGRPC</h1><h2>Description: </h2><p>Sends FlowFiles, optionally with content, to a configurable remote gRPC service endpoint. The remote gRPC service must abide by the service IDL defined in NiFi. gRPC isn't intended to carry large payloads, so this processor should be used only when FlowFile sizes are on the order of megabytes. The default maximum message size is 4MB.</p><h3>Tags: </h3><p>grpc, rpc, client</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 ind
icates 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>Remote gRPC service hostname</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Remote host which will be connected to</td></tr><tr><td id="name"><strong>Remote gRPC service port</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Remote port which will be connected to</td></tr><tr><td id="name">Max Message Size</td><td id="default-value">4MB</td><td id="allowable-values"></td><td id="description">The maximum size of FlowFiles that this processor will allow to be received. The default is 4MB. If FlowFiles exceed this size, you should consider using another transport mechanism as gRPC isn't designed for heavy payloads.</td></tr><tr><td id="name">Use SSL/TLS</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><
li>false</li></ul></td><td id="description">Whether or not to use SSL/TLS to send the contents of the gRPC messages.</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.7.1/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a><br/><a href="../../../nifi-ssl-context-service-nar/1.7.1/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 (https) connections.</td></tr><tr><td id="name">Send FlowFile Content</td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Whether or not to include the FlowFile content in the FlowFileReq
uest to the gRPC service.</td></tr><tr><td id="name">Always Output Response</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Will force a response FlowFile to be generated and routed to the 'Response' relationship regardless of what the server status code received is or if the processor is configured to put the server response body in the request attribute. In the later configuration a request FlowFile with the response body in the attribute and a typical response FlowFile will be emitted to their respective relationships.</td></tr><tr><td id="name">Penalize on "No Retry"</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Enabling this property will penalize FlowFiles that are routed to the "No Retry" relationship.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>Origi
nal</td><td>The original FlowFile will be routed upon success. It will have new attributes detailing the success of the request.</td></tr><tr><td>Failure</td><td>The original FlowFile will be routed on any type of connection failure, timeout or general exception. It will have new attributes detailing the request.</td></tr><tr><td>Retry</td><td>The original FlowFile will be routed on any status code that can be retried. It will have new attributes detailing the request.</td></tr><tr><td>No Retry</td><td>The original FlowFile will be routed on any status code that should NOT be retried. It will have new attributes detailing the request.</td></tr><tr><td>Response</td><td>A Response FlowFile will be routed upon success. If the 'Output Response Regardless' property is true then the response will be sent to this relationship regardless of the status code received.</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>invokegrpc.response.code</td><td>The response code that is returned (0 = ERROR, 1 = SUCCESS, 2 = RETRY)</td></tr><tr><td>invokegrpc.response.body</td><td>The response message that is returned</td></tr><tr><td>invokegrpc.service.host</td><td>The remote gRPC service hostname</td></tr><tr><td>invokegrpc.service.port</td><td>The remote gRPC service port</td></tr><tr><td>invokegrpc.java.exception.class</td><td>The Java exception class raised when the processor fails</td></tr><tr><td>invokegrpc.java.exception.message</td><td>The Java exception message raised when the processor fails</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-grpc-nar/1.7.1/org.apache.nifi.processors.grpc.ListenGRPC/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-grpc-nar/1.7.1/org.apache.nifi.processors.grpc.ListenGRPC/index.html?rev=1836075&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-grpc-nar/1.7.1/org.apache.nifi.processors.grpc.ListenGRPC/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-grpc-nar/1.7.1/org.apache.nifi.processors.grpc.ListenGRPC/index.html Tue Jul 17 01:35:38 2018
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ListenGRPC</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;">ListenGRPC</h1><h2>Description: </h2><p>Starts a gRPC server and listens on the given port to transform the incoming messages into FlowFiles. The message format is defined by the standard gRPC protobuf IDL provided by NiFi. gRPC isn't intended to carry large payloads, so this processor should be used only when FlowFile sizes are on the order of megabytes. The default maximum message size is 4MB.</p><h3>Tags: </h3><p>ingest, grpc, rpc, listen</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>Local gRPC Service Port</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The local port that the gRPC service will listen on.</td></tr><tr><td id="name">Use TLS</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Whether or not to use TLS to send the contents of the gRPC messages.</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.7.1/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 (https) connections.</td></tr><tr><td id="name">Flow Control Window</td><td id="default-value">1MB</td><td id="allowable-values"></td><td id="description">The initial HTTP/2 flow control window for both new streams and overall connection. Flow-control schemes ensure that streams on the same connection do not destructively interfere with each other. The default is 1MB.</td></tr><tr><td id="name"><strong>Authorized DN Pattern</strong></td><td id="default-value">.*</td><td id="allowable-values"></td><td id="description">A Regular Expression to apply against the Distinguished Name of incoming connections. If the Pattern does not match the DN, the connection will be refused.</td></tr><tr><td id="name">Maximum Message Size</td><td id="default-value">4MB</td><td id="allowable-values"></td><td id="description">The maximum size of FlowFiles that this processor will allow to be received. The default is 4MB. If Flo
wFiles exceed this size, you should consider using another transport mechanism as gRPC isn't designed for heavy payloads.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>Success</td><td>The FlowFile was received successfully.</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>listengrpc.remote.user.dn</td><td>The DN of the user who sent the FlowFile to this NiFi</td></tr><tr><td>listengrpc.remote.host</td><td>The IP of the client who sent the FlowFile to this NiFi</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 does not allow 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-hadoop-nar/1.7.1/org.apache.nifi.processors.hadoop.CreateHadoopSequenceFile/additionalDetails.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-hadoop-nar/1.7.1/org.apache.nifi.processors.hadoop.CreateHadoopSequenceFile/additionalDetails.html?rev=1836075&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-hadoop-nar/1.7.1/org.apache.nifi.processors.hadoop.CreateHadoopSequenceFile/additionalDetails.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-hadoop-nar/1.7.1/org.apache.nifi.processors.hadoop.CreateHadoopSequenceFile/additionalDetails.html Tue Jul 17 01:35:38 2018
@@ -0,0 +1,46 @@
+<!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>CreateHadoopSequenceFile</title>
+
+ <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" />
+ </head>
+
+ <body>
+ <!-- Processor Documentation ================================================== -->
+ <h2>Description:</h2>
+ <p>This processor is used to create a Hadoop Sequence File, which essentially is a file of key/value pairs. The key
+ will be a file name and the value will be the flow file content. The processor will take either a merged (a.k.a. packaged) flow
+ file or a singular flow file. Historically, this processor handled the merging by type and size or time prior to creating a
+ SequenceFile output; it no longer does this. If creating a SequenceFile that contains multiple files of the same type is desired,
+ precede this processor with a <code>RouteOnAttribute</code> processor to segregate files of the same type and follow that with a
+ <code>MergeContent</code> processor to bundle up files. If the type of files is not important, just use the
+ <code>MergeContent</code> processor. When using the <code>MergeContent</code> processor, the following Merge Formats are
+ supported by this processor:
+ <ul>
+ <li>TAR</li>
+ <li>ZIP</li>
+ <li>FlowFileStream v3</li>
+ </ul>
+ The created SequenceFile is named the same as the incoming FlowFile with the suffix '.sf'. For incoming FlowFiles that are
+ bundled, the keys in the SequenceFile are the individual file names, the values are the contents of each file.
+ </p>
+ NOTE: The value portion of a key/value pair is loaded into memory. While there is a max size limit of 2GB, this could cause memory
+ issues if there are too many concurrent tasks and the flow file sizes are large.
+</body>
+</html>