Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.jms.processors.ConsumeJMS/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.jms.processors.ConsumeJMS/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.jms.processors.ConsumeJMS/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.jms.processors.ConsumeJMS/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ConsumeJMS</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Consumes JMS Message of type BytesMessage or TextMessage transforming its content to a FlowFile and transitioning it to 'success' relationship.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>jms, get, message, receive, 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, 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">User Name</td><td > id="default-value"></td><td id="allowable-values"></td><td > id="description">User Name used for authentication and > authorization.</td></tr><tr><td id="name">Password</td><td > id="default-value"></td><td id="allowable-values"></td><td > id="description">Password used for authentication and > authorization.<br/><strong>Sensitive Property: > true</strong></td></tr><tr><td id="name"><strong>Destination > Name</strong></td><td id="default-value"></td><td > id="allowable-values"></td><td id="description">The name of the JMS > Destination. Usually provided by the administrator (e.g., > 'topic://myTopic').<br/><strong>Supports Expression Language: > true</strong></td></tr><tr><td id="name"><strong>Destination > Type</strong></td><td id="default-value">QUEUE</td><td id="allowable-valu es"><ul><li>QUEUE</li><li>TOPIC</li></ul></td><td id="description">The type of the JMS Destination. Could be one of 'QUEUE' or 'TOPIC'. Usually provided by the administrator. Defaults to 'TOPIC</td></tr><tr><td id="name"><strong>Session Cache size</strong></td><td id="default-value">1</td><td id="allowable-values"></td><td id="description">The maximum limit for the number of cached Sessions.</td></tr><tr><td id="name"><strong>Connection Factory Service</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>JMSConnectionFactoryProviderDefinition<br/><strong>Implementation:</strong><br/><a href="../org.apache.nifi.jms.cf.JMSConnectionFactoryProvider/index.html">JMSConnectionFactoryProvider</a></td><td id="description">The Controller Service that is used to obtain ConnectionFactory</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All FlowFiles th at are received from the JMS Destination are routed to this relationship</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>See Also:</h3><p><a href="../org.apache.nifi.jms.processors.PublishJMS/index.html">PublishJMS</a>, <a href="../org.apache.nifi.jms.cf.JMSConnectionFactoryProvider/index.html">JMSConnectionFactoryProvider</a></p></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ConsumeJMS</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Consumes JMS Message of type BytesMessage or TextMessage transforming its content to a FlowFile and transitioning it to 'success' relationship. JMS attributes such as headers and properties will be copied as FlowFile attributes.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>jms, get, message, receive, 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, 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 ente ring 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>Connection Factory Service</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>JMSConnectionFactoryProviderDefinition<br/><strong>Implementation:</strong><br/><a href="../org.apache.nifi.jms.cf.JMSConnectionFactoryProvider/index.html">JMSConnectionFactoryProvider</a></td><td id="description">The Controller Service that is used to obtain ConnectionFactory</td></tr><tr><td id="name"><strong>Destination Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the JMS Destination. Usually provided by the administrator (e.g., 'topic://myTopic' or 'myTopic').<br/><strong>Suppo rts Expression Language: true</strong></td></tr><tr><td id="name"><strong>Destination Type</strong></td><td id="default-value">QUEUE</td><td id="allowable-values"><ul><li>QUEUE</li><li>TOPIC</li></ul></td><td id="description">The type of the JMS Destination. Could be one of 'QUEUE' or 'TOPIC'. Usually provided by the administrator. Defaults to 'TOPIC</td></tr><tr><td id="name">User Name</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">User Name used for authentication and authorization.</td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password used for authentication and authorization.<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>Session Cache size</strong></td><td id="default-value">1</td><td id="allowable-values"></td><td id="description">The maximum limit for the number of cached Sessions.</td></tr><tr><td id="name"><strong>Acknowledgement Mode</strong></td><td id="default-value">2</td><td id="allowable-values"><ul><li>AUTO_ACKNOWLEDGE (1) <img src="../../html/images/iconInfo.png" alt="Automatically acknowledges a client's receipt of a message, regardless if NiFi session has been commited. Can result in data loss in the event where NiFi abruptly stopped before session was commited." title="Automatically acknowledges a client's receipt of a message, regardless if NiFi session has been commited. Can result in data loss in the event where NiFi abruptly stopped before session was commited."></img></li><li>CLIENT_ACKNOWLEDGE (2) <img src="../../html/images/iconInfo.png" alt="(DEFAULT) Manually acknowledges a client's receipt of a message after NiFi Session was commited, thus ensuring no data loss" title="(DEFAULT) Manually acknowledges a client's receipt of a message after NiFi Session was commited, thus ensuring no data loss"></img></li><li>DUPS_OK_ACKNOWLEDGE (3) <img src="../../html/images/iconInfo.png" alt="This acknow ledgment mode instructs the session to lazily acknowledge the delivery of messages. May result in both data duplication and data loss while achieving the best throughput." title="This acknowledgment mode instructs the session to lazily acknowledge the delivery of messages. May result in both data duplication and data loss while achieving the best throughput."></img></li></ul></td><td id="description">The JMS Acknowledgement Mode. Using Auto Acknowledge can cause messages to be lost on restart of NiFi but may provide better performance than Client Acknowledge.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All FlowFiles that are received from the JMS Destination 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 processor has no state management.<h3>Restricted: </h3><h3>See Also:</h3><p ><a >href="../org.apache.nifi.jms.processors.PublishJMS/index.html">PublishJMS</a>, > <a >href="../org.apache.nifi.jms.cf.JMSConnectionFactoryProvider/index.html">JMSConnectionFactoryProvider</a></p></body></html> \ No newline at end of file
Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.jms.processors.PublishJMS/additionalDetails.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.jms.processors.PublishJMS/additionalDetails.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.jms.processors.PublishJMS/additionalDetails.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.jms.processors.PublishJMS/additionalDetails.html Tue Nov 29 12:33:21 2016 @@ -30,9 +30,9 @@ Once message is constructed it is sent to a pre-configured JMS Destination. Standard <a href="http://docs.spring.io/spring-integration/api/org/springframework/integration/jms/JmsHeaders.html";>JMS Headers</a> will be extracted from the FlowFile and set on <i>javax.jms.Message</i> as JMS headers while other - FlowFile attributes will be set as properties of <i>javax.jms.Message</i>. Upon success the incoming FlowFile is transfered + FlowFile attributes will be set as properties of <i>javax.jms.Message</i>. Upon success the incoming FlowFile is transferred to the <i>success</i> Relationship and upon failure FlowFile is - penalized and transfered to the <i>failure</i> Relationship. + penalized and transferred to the <i>failure</i> Relationship. </p> <h2>Configuration Details</h2> <p> Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.jms.processors.PublishJMS/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.jms.processors.PublishJMS/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.jms.processors.PublishJMS/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.jms.processors.PublishJMS/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PublishJMS</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Creates a JMS Message from the contents of a FlowFile and sends it to a JMS Destination (queue or topic) as JMS BytesMessage.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>jms, put, message, send, 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, 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 f or 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">User Name</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">User Name used for authentication and authorization.</td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password used for authentication and authorization.<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>Destination Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the JMS Destination. Usually provided by the administrator (e.g., 'topic://myTopic').<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Destination Type</strong></td><td id="default-value">QUEUE</td><td id="allowable-values"><ul><li>QUEUE</li ><li>TOPIC</li></ul></td><td id="description">The type of the JMS Destination. >Could be one of 'QUEUE' or 'TOPIC'. Usually provided by the administrator. >Defaults to 'TOPIC</td></tr><tr><td id="name"><strong>Session Cache >size</strong></td><td id="default-value">1</td><td >id="allowable-values"></td><td id="description">The maximum limit for the >number of cached Sessions.</td></tr><tr><td id="name"><strong>Connection >Factory Service</strong></td><td id="default-value"></td><td >id="allowable-values"><strong>Controller Service API: ></strong><br/>JMSConnectionFactoryProviderDefinition<br/><strong>Implementation:</strong><br/><a > >href="../org.apache.nifi.jms.cf.JMSConnectionFactoryProvider/index.html">JMSConnectionFactoryProvider</a></td><td > id="description">The Controller Service that is used to obtain >ConnectionFactory</td></tr></table><h3>Relationships: </h3><table >id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All > FlowFiles that are sent to the JM S destination are routed to this relationship</td></tr><tr><td>failure</td><td>All FlowFiles that cannot be sent to JMS destination are routed to this relationship</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>See Also:</h3><p><a href="../org.apache.nifi.jms.processors.ConsumeJMS/index.html">ConsumeJMS</a>, <a href="../org.apache.nifi.jms.cf.JMSConnectionFactoryProvider/index.html">JMSConnectionFactoryProvider</a></p></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PublishJMS</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Creates a JMS Message from the contents of a FlowFile and sends it to a JMS Destination (queue or topic) as JMS BytesMessage. FlowFile attributes will be added as JMS headers and/or properties to the outgoing JMS message.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>jms, put, message, send, 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, 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 val ue 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>Connection Factory Service</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>JMSConnectionFactoryProviderDefinition<br/><strong>Implementation:</strong><br/><a href="../org.apache.nifi.jms.cf.JMSConnectionFactoryProvider/index.html">JMSConnectionFactoryProvider</a></td><td id="description">The Controller Service that is used to obtain ConnectionFactory</td></tr><tr><td id="name"><strong>Destination Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the JMS Destination. Usually provided by the administrator (e.g., 'topic://myTopic' or 'myTopic').<br/><strong>Supports Expres sion Language: true</strong></td></tr><tr><td id="name"><strong>Destination Type</strong></td><td id="default-value">QUEUE</td><td id="allowable-values"><ul><li>QUEUE</li><li>TOPIC</li></ul></td><td id="description">The type of the JMS Destination. Could be one of 'QUEUE' or 'TOPIC'. Usually provided by the administrator. Defaults to 'TOPIC</td></tr><tr><td id="name">User Name</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">User Name used for authentication and authorization.</td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password used for authentication and authorization.<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>Session Cache size</strong></td><td id="default-value">1</td><td id="allowable-values"></td><td id="description">The maximum limit for the number of cached Sessions.</td></tr></table><h3>Relationships: </h3><table id="relations hips"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All FlowFiles that are sent to the JMS destination are routed to this relationship</td></tr><tr><td>failure</td><td>All FlowFiles that cannot be sent to JMS destination 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 processor has no state management.<h3>Restricted: </h3><h3>See Also:</h3><p><a href="../org.apache.nifi.jms.processors.ConsumeJMS/index.html">ConsumeJMS</a>, <a href="../org.apache.nifi.jms.cf.JMSConnectionFactoryProvider/index.html">JMSConnectionFactoryProvider</a></p></body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.GeoEnrichIP/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.GeoEnrichIP/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.GeoEnrichIP/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.GeoEnrichIP/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GeoEnrichIP</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Looks up geolocation information for an IP address and adds the geo information to FlowFile attributes. The geo data is provided as a MaxMind database. The attribute that contains the IP address to lookup is provided by the 'IP Address Attribute' property. If the name of the attribute provided is 'X', then the the attributes added by enrichment will take the form X.geo.<fieldName></p><h3>Tags: </h3><p>geo, enrich, ip, maxmind</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>Geo Database File</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Path to Maxmind Geo Enrichment Database File</td></tr><tr><td id="name"><strong>IP Address Attribute</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of an attribute whose value is a dotted decimal IP address for which enrichment should occur</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>not found</td><td>Where to route flow files after unsuccessfully enriching attributes because no geo data was found</td></tr><tr><td>found</td><td>Where to route flow files after successfully enriching attributes with geo data</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>X.geo.lookup.micros</td><td>The number of microseconds that the geo l ookup took</td></tr><tr><td>X.geo.city</td><td>The city identified for the IP address</td></tr><tr><td>X.geo.latitude</td><td>The latitude identified for this IP address</td></tr><tr><td>X.geo.longitude</td><td>The longitude identified for this IP address</td></tr><tr><td>X.geo.subdivision.N</td><td>Each subdivision that is identified for this IP address is added with a one-up number appended to the attribute name, starting with 0</td></tr><tr><td>X.geo.subdivision.isocode.N</td><td>The ISO code for the subdivision that is identified by X.geo.subdivision.N</td></tr><tr><td>X.geo.country</td><td>The country identified for this IP address</td></tr><tr><td>X.geo.country.isocode</td><td>The ISO Code for the country identified</td></tr><tr><td>X.geo.postalcode</td><td>The postal code for the country identified</td></tr></table></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GeoEnrichIP</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Looks up geolocation information for an IP address and adds the geo information to FlowFile attributes. The geo data is provided as a MaxMind database. The attribute that contains the IP address to lookup is provided by the 'IP Address Attribute' property. If the name of the attribute provided is 'X', then the the attributes added by enrichment will take the form X.geo.<fieldName></p><h3>Tags: </h3><p>geo, enrich, ip, maxmind</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>Geo Database File</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Path to Maxmind Geo Enrichment Database File</td></tr><tr><td id="name"><strong>IP Address Attribute</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of an attribute whose value is a dotted decimal IP address for which enrichment should occur</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>not found</td><td>Where to route flow files after unsuccessfully enriching attributes because no geo data was found</td></tr><tr><td>found</td><td>Where to route flow files after successfully enriching attributes with geo data</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>X.geo.lookup.micros</td><td>The number of microseconds that the geo l ookup took</td></tr><tr><td>X.geo.city</td><td>The city identified for the IP address</td></tr><tr><td>X.geo.latitude</td><td>The latitude identified for this IP address</td></tr><tr><td>X.geo.longitude</td><td>The longitude identified for this IP address</td></tr><tr><td>X.geo.subdivision.N</td><td>Each subdivision that is identified for this IP address is added with a one-up number appended to the attribute name, starting with 0</td></tr><tr><td>X.geo.subdivision.isocode.N</td><td>The ISO code for the subdivision that is identified by X.geo.subdivision.N</td></tr><tr><td>X.geo.country</td><td>The country identified for this IP address</td></tr><tr><td>X.geo.country.isocode</td><td>The ISO Code for the country identified</td></tr><tr><td>X.geo.postalcode</td><td>The postal code for the country identified</td></tr></table><h3>State management: </h3>This processor has no state management.<h3>Restricted: </h3></body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.attributes.UpdateAttribute/additionalDetails.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.attributes.UpdateAttribute/additionalDetails.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.attributes.UpdateAttribute/additionalDetails.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.attributes.UpdateAttribute/additionalDetails.html Tue Nov 29 12:33:21 2016 @@ -194,7 +194,7 @@ <p> Deleting attributes is a simple as providing a regular expression for attribute names to be deleted. This can be a simple regular expression that will - match a single attribute or more complex regular expression to match a group of similarly named attributes or even seveal individual attribute names. + match a single attribute or more complex regular expression to match a group of similarly named attributes or even several individual attribute names. </p> <ul> <li><strong>lastUser</strong> - will delete an attribute with the name "lastUser". Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.attributes.UpdateAttribute/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.attributes.UpdateAttribute/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.attributes.UpdateAttribute/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.attributes.UpdateAttribute/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>UpdateAttribute</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Updates the Attributes for a FlowFile by using the Attribute Expression Language and/or deletes the attributes based on a regular expression</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>attributes, modification, update, delete, Attribute Expression Language</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name">Delete Attrib utes Expression</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Regular expression for attributes to be deleted from flowfiles.<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 FlowFile attribute to update</td><td id="value">The value to set it to</td><td>Updates a FlowFile attribute specified by the Dynamic Property's key with the value specified by the Dynamic Property's value<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>success</td><td>All FlowFiles are routed to this relationship</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>See additional details</td><td>This processor may write or remove zero or more attributes as described in additional details</td></tr></table></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>UpdateAttribute</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Updates the Attributes for a FlowFile by using the Attribute Expression Language and/or deletes the attributes based on a regular expression</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>attributes, modification, update, delete, Attribute Expression Language</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name">Delete Attrib utes Expression</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Regular expression for attributes to be deleted from flowfiles.<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 FlowFile attribute to update</td><td id="value">The value to set it to</td><td>Updates a FlowFile attribute specified by the Dynamic Property's key with the value specified by the Dynamic Property's value<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>success</td><td>All FlowFiles are routed to this relationship</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>See additional details</td><td>This processor may write or remove zero or more attributes as described in additional details</td></tr></table><h3>State management: </h3>This processor has no state management.<h3>Restricted: </h3></body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.avro.ConvertAvroToJSON/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.avro.ConvertAvroToJSON/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.avro.ConvertAvroToJSON/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.avro.ConvertAvroToJSON/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ConvertAvroToJSON</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Converts a Binary Avro record into a JSON object. This processor provides a direct mapping of an Avro field to a JSON field, such that the resulting JSON will have the same hierarchical structure as the Avro document. Note that the Avro schema information will be lost, as this is not a translation from binary Avro to JSON formatted Avro. The output JSON is encoded the UTF-8 encoding. If an incoming FlowFile contains a stream of multiple Avro records, the resultant FlowFile will contain a JSON Array containing all of the Avro records or a sequence of JSON Objects. If an incoming FlowFile does not contain any records, an empty JSON object is the output. Empty/Single Avro record FlowFile inputs are optionally wrapped in a container as dictated by 'Wrap Single Record'</p ><h3>Tags: </h3><p>avro, convert, json</p><h3>Properties: </h3><p>In the list >below, the names of required properties appear in <strong>bold</strong>. Any >other properties (not in bold) are considered optional. The table also >indicates any default values.</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>JSON container >options</strong></td><td id="default-value">array</td><td >id="allowable-values"><ul><li>none</li><li>array</li></ul></td><td >id="description">Determines how stream of records is exposed: either as a >sequence of single Objects (none) (i.e. writing every Object to a new line), >or as an array of Objects (array).</td></tr><tr><td id="name"><strong>Wrap >Single Record</strong></td><td id="default-value">false</td><td >id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td >id="description">Determines if the resulting output for empty records or a >single record should be wrap ped in a container array as specified by 'JSON container options'</td></tr><tr><td id="name">Avro schema</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">If the Avro records do not contain the schema (datum only), it must be specified here.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>A FlowFile is routed to this relationship after it has been converted to JSON</td></tr><tr><td>failure</td><td>A FlowFile is routed to this relationship if it cannot be parsed as Avro or cannot be converted to JSON for any reason</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>mime.type</td><td>Sets the mime type to application/json</td></tr></table></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ConvertAvroToJSON</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Converts a Binary Avro record into a JSON object. This processor provides a direct mapping of an Avro field to a JSON field, such that the resulting JSON will have the same hierarchical structure as the Avro document. Note that the Avro schema information will be lost, as this is not a translation from binary Avro to JSON formatted Avro. The output JSON is encoded the UTF-8 encoding. If an incoming FlowFile contains a stream of multiple Avro records, the resultant FlowFile will contain a JSON Array containing all of the Avro records or a sequence of JSON Objects. If an incoming FlowFile does not contain any records, an empty JSON object is the output. Empty/Single Avro record FlowFile inputs are optionally wrapped in a container as dictated by 'Wrap Single Record'</p ><h3>Tags: </h3><p>avro, convert, json</p><h3>Properties: </h3><p>In the list >below, the names of required properties appear in <strong>bold</strong>. Any >other properties (not in bold) are considered optional. The table also >indicates any default values.</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>JSON container >options</strong></td><td id="default-value">array</td><td >id="allowable-values"><ul><li>none</li><li>array</li></ul></td><td >id="description">Determines how stream of records is exposed: either as a >sequence of single Objects (none) (i.e. writing every Object to a new line), >or as an array of Objects (array).</td></tr><tr><td id="name"><strong>Wrap >Single Record</strong></td><td id="default-value">false</td><td >id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td >id="description">Determines if the resulting output for empty records or a >single record should be wrap ped in a container array as specified by 'JSON container options'</td></tr><tr><td id="name">Avro schema</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">If the Avro records do not contain the schema (datum only), it must be specified here.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>A FlowFile is routed to this relationship after it has been converted to JSON</td></tr><tr><td>failure</td><td>A FlowFile is routed to this relationship if it cannot be parsed as Avro or cannot be converted to JSON for any reason</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>mime.type</td><td>Sets the mime type to application/json</td></tr></table><h3>State management: </h3>This processor has no state management.<h3>Restricted: </h3></body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.avro.ExtractAvroMetadata/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.avro.ExtractAvroMetadata/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.avro.ExtractAvroMetadata/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.avro.ExtractAvroMetadata/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ExtractAvroMetadata</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Extracts metadata from the header of an Avro datafile.</p><h3>Tags: </h3><p>avro, schema, metadata</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>Fingerprint Algorithm</strong></td><td id="default-value">CRC-64-AVRO</td><td id="allowable-values"><ul><li>CRC-64-AVRO</li><li>MD5</li><li>SHA-256</li></ul></td><td id="description">The algorithm used to generate the schema fingerprint. Available choices are based on the Avro recommended practices for fingerprint gen eration.</td></tr><tr><td id="name">Metadata Keys</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A comma-separated list of keys indicating key/value pairs to extract from the Avro file header. The key 'avro.schema' can be used to extract the full schema in JSON format, and 'avro.codec' can be used to extract the codec name if one exists.</td></tr><tr><td id="name"><strong>Count Items</strong></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 the number of items in the datafile will be counted and stored in a FlowFile attribute 'item.count'. The counting is done by reading blocks and getting the number of items for each block, thus avoiding de-serializing. The items being counted will be the top-level items in the datafile. For example, with a schema of type record the items will be the records, and for a schema of type Array the items will be the arrays (not the nu mber of entries in each array).</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>A FlowFile is routed to this relationship after metadata has been extracted.</td></tr><tr><td>failure</td><td>A FlowFile is routed to this relationship if it cannot be parsed as Avro or metadata cannot be extracted for any reason</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>schema.type</td><td>The type of the schema (i.e. record, enum, etc.).</td></tr><tr><td>schema.name</td><td>Contains the name when the type is a record, enum or fixed, otherwise contains the name of the primitive type.</td></tr><tr><td>schema.fingerprint</td><td>The result of the Fingerprint Algorithm as a Hex string.</td></tr><tr><td>item.count</td><td>The total number of items in the datafile, only written if Count Items is set to true.</td></tr></table></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ExtractAvroMetadata</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Extracts metadata from the header of an Avro datafile.</p><h3>Tags: </h3><p>avro, schema, metadata</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>Fingerprint Algorithm</strong></td><td id="default-value">CRC-64-AVRO</td><td id="allowable-values"><ul><li>CRC-64-AVRO</li><li>MD5</li><li>SHA-256</li></ul></td><td id="description">The algorithm used to generate the schema fingerprint. Available choices are based on the Avro recommended practices for fingerprint gen eration.</td></tr><tr><td id="name">Metadata Keys</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A comma-separated list of keys indicating key/value pairs to extract from the Avro file header. The key 'avro.schema' can be used to extract the full schema in JSON format, and 'avro.codec' can be used to extract the codec name if one exists.</td></tr><tr><td id="name"><strong>Count Items</strong></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 the number of items in the datafile will be counted and stored in a FlowFile attribute 'item.count'. The counting is done by reading blocks and getting the number of items for each block, thus avoiding de-serializing. The items being counted will be the top-level items in the datafile. For example, with a schema of type record the items will be the records, and for a schema of type Array the items will be the arrays (not the nu mber of entries in each array).</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>A FlowFile is routed to this relationship after metadata has been extracted.</td></tr><tr><td>failure</td><td>A FlowFile is routed to this relationship if it cannot be parsed as Avro or metadata cannot be extracted for any reason</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>schema.type</td><td>The type of the schema (i.e. record, enum, etc.).</td></tr><tr><td>schema.name</td><td>Contains the name when the type is a record, enum or fixed, otherwise contains the name of the primitive type.</td></tr><tr><td>schema.fingerprint</td><td>The result of the Fingerprint Algorithm as a Hex string.</td></tr><tr><td>item.count</td><td>The total number of items in the datafile, only written if Count Items is set to true.</td></tr></table><h3>State management: </h3>This processor has no state management.<h3>Restricted: </h3></body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.avro.SplitAvro/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.avro.SplitAvro/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.avro.SplitAvro/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.avro.SplitAvro/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>SplitAvro</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Splits a binary encoded Avro datafile into smaller files based on the configured Output Size. The Output Strategy determines if the smaller files will be Avro datafiles, or bare Avro records with metadata in the FlowFile attributes. The output will always be binary encoded.</p><h3>Tags: </h3><p>avro, split</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>Split Strategy</strong></td><td id="default-value">Record</td><td id="allowable-values"><ul><li>Record <img src="../../h tml/images/iconInfo.png" alt="Split at Record boundaries" title="Split at Record boundaries"></img></li></ul></td><td id="description">The strategy for splitting the incoming datafile. The Record strategy will read the incoming datafile by de-serializing each record.</td></tr><tr><td id="name"><strong>Output Size</strong></td><td id="default-value">1</td><td id="allowable-values"></td><td id="description">The number of Avro records to include per split file. In cases where the incoming file has less records than the Output Size, or when the total number of records does not divide evenly by the Output Size, it is possible to get a split file with less records.</td></tr><tr><td id="name"><strong>Output Strategy</strong></td><td id="default-value">Datafile</td><td id="allowable-values"><ul><li>Datafile <img src="../../html/images/iconInfo.png" alt="Avro's object container file format" title="Avro's object container file format"></img></li><li>Bare Record <img src="../../html/images/ico nInfo.png" alt="Bare Avro records" title="Bare Avro records"></img></li></ul></td><td id="description">Determines the format of the output. Either Avro Datafile, or bare record. Bare record output is only intended for use with systems that already require it, and shouldn't be needed for normal use.</td></tr><tr><td id="name"><strong>Transfer Metadata</strong></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 transfer metadata from the parent datafile to the children. If the Output Strategy is Bare Record, then the metadata will be stored as FlowFile attributes, otherwise it will be in the Datafile header.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>failure</td><td>If a FlowFile fails processing for any reason (for example, the FlowFile is not valid Avro), it will be routed to this relationship</td></tr><tr><td>original</ td><td>The original FlowFile that was split. If the FlowFile fails processing, nothing will be sent to this relationship</td></tr><tr><td>split</td><td>All new files split from the original FlowFile will be routed to this relationship</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.</body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>SplitAvro</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Splits a binary encoded Avro datafile into smaller files based on the configured Output Size. The Output Strategy determines if the smaller files will be Avro datafiles, or bare Avro records with metadata in the FlowFile attributes. The output will always be binary encoded.</p><h3>Tags: </h3><p>avro, split</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>Split Strategy</strong></td><td id="default-value">Record</td><td id="allowable-values"><ul><li>Record <img src="../../h tml/images/iconInfo.png" alt="Split at Record boundaries" title="Split at Record boundaries"></img></li></ul></td><td id="description">The strategy for splitting the incoming datafile. The Record strategy will read the incoming datafile by de-serializing each record.</td></tr><tr><td id="name"><strong>Output Size</strong></td><td id="default-value">1</td><td id="allowable-values"></td><td id="description">The number of Avro records to include per split file. In cases where the incoming file has less records than the Output Size, or when the total number of records does not divide evenly by the Output Size, it is possible to get a split file with less records.</td></tr><tr><td id="name"><strong>Output Strategy</strong></td><td id="default-value">Datafile</td><td id="allowable-values"><ul><li>Datafile <img src="../../html/images/iconInfo.png" alt="Avro's object container file format" title="Avro's object container file format"></img></li><li>Bare Record <img src="../../html/images/ico nInfo.png" alt="Bare Avro records" title="Bare Avro records"></img></li></ul></td><td id="description">Determines the format of the output. Either Avro Datafile, or bare record. Bare record output is only intended for use with systems that already require it, and shouldn't be needed for normal use.</td></tr><tr><td id="name"><strong>Transfer Metadata</strong></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 transfer metadata from the parent datafile to the children. If the Output Strategy is Bare Record, then the metadata will be stored as FlowFile attributes, otherwise it will be in the Datafile header.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>failure</td><td>If a FlowFile fails processing for any reason (for example, the FlowFile is not valid Avro), it will be routed to this relationship</td></tr><tr><td>original</ td><td>The original FlowFile that was split. If the FlowFile fails processing, nothing will be sent to this relationship</td></tr><tr><td>split</td><td>All new files split from the original FlowFile will be routed to this relationship</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>fragment.identifier</td><td>All split FlowFiles produced from the same parent FlowFile will have the same randomly generated UUID added for this attribute</td></tr><tr><td>fragment.index</td><td>A one-up number that indicates the ordering of the split FlowFiles that were created from a single parent FlowFile</td></tr><tr><td>fragment.count</td><td>The number of split FlowFiles generated from the parent FlowFile</td></tr><tr><td>segment.original.filename </td><td>The filename of the parent FlowFile</td></tr></table><h3>State management: </h3>This processor has no state management.<h3>Restr icted: </h3></body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.cloudwatch.PutCloudWatchMetric/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.cloudwatch.PutCloudWatchMetric/index.html?rev=1771896&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.cloudwatch.PutCloudWatchMetric/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.cloudwatch.PutCloudWatchMetric/index.html Tue Nov 29 12:33:21 2016 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutCloudWatchMetric</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Publishes metrics to Amazon CloudWatch</p><h3>Tags: </h3><p>amazon, aws, cloudwatch, metrics, put, 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, 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>A llowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Namespace</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The namespace for the metric data for CloudWatch<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>MetricName</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the metric<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Value</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The value for the metric. Must be a double<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Timestamp</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. If not specified, the default value is set to the time the metric data was received<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Unit</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The unit of the metric. (e.g Seconds, Bytes, Megabytes, Percent, Count, Kilobytes/Second, Terabits/Second, Count/Second) For details see http://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Region</strong></td><td id="default-value">us-west-2</td><td id="allowable-values"><ul><li>us-gov-west-1 <img src="../../html/images/iconInfo.png" alt="us-gov-west-1" title="us-gov-west-1"></img></li><li>us-east-1 <img src="../../html/images/iconInfo.png" alt="us-east-1" title="us-east-1"></img></li><li>us-west-1 <img src="../../html/images/iconInfo.png" alt="us-west-1" title="us-west-1"></img></li><li>us-west-2 <img src="../../html/images/iconInfo.png" alt="us-west-2" title="us-w est-2"></img></li><li>eu-west-1 <img src="../../html/images/iconInfo.png" alt="eu-west-1" title="eu-west-1"></img></li><li>eu-central-1 <img src="../../html/images/iconInfo.png" alt="eu-central-1" title="eu-central-1"></img></li><li>ap-southeast-1 <img src="../../html/images/iconInfo.png" alt="ap-southeast-1" title="ap-southeast-1"></img></li><li>ap-southeast-2 <img src="../../html/images/iconInfo.png" alt="ap-southeast-2" title="ap-southeast-2"></img></li><li>ap-northeast-1 <img src="../../html/images/iconInfo.png" alt="ap-northeast-1" title="ap-northeast-1"></img></li><li>ap-northeast-2 <img src="../../html/images/iconInfo.png" alt="ap-northeast-2" title="ap-northeast-2"></img></li><li>sa-east-1 <img src="../../html/images/iconInfo.png" alt="sa-east-1" title="sa-east-1"></img></li><li>cn-north-1 <img src="../../html/images/iconInfo.png" alt="cn-north-1" title="cn-north-1"></img></li></ul></td><td id="description">No Description Provided.</td></tr><tr><td id="name">Access Key</td>< td id="default-value"></td><td id="allowable-values"></td><td id="description">No Description Provided.<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Secret Key</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">No Description Provided.<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Credentials File</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Path to a file containing AWS access key and secret key in properties file format.</td></tr><tr><td id="name">AWS Credentials Provider service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>AWSCredentialsProviderService<br/><strong>Implementation:</strong><br/><a href="../org.apache.nifi.processors.aws.credentials.provider.service.AWSCredentialsProviderCo ntrollerService/index.html">AWSCredentialsProviderControllerService</a></td><td id="description">The Controller Service that is used to obtain aws credentials provider</td></tr><tr><td id="name"><strong>Communications Timeout</strong></td><td id="default-value">30 secs</td><td id="allowable-values"></td><td id="description">No Description Provided.</td></tr><tr><td id="name">SSL Context Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Implementation:</strong><br/><a href="../org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td id="description">Specifies an optional SSL Context Service that, if provided, will be used to create connections</td></tr><tr><td id="name">Endpoint Override URL</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Endpoint URL to use instead of the AWS default including scheme, host, port, and p ath. The AWS libraries select an endpoint URL based on the AWS region, but this property overrides the selected endpoint URL, allowing use with other S3-compatible endpoints.</td></tr><tr><td id="name">Proxy Host</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Proxy host name or IP<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Proxy Host Port</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Proxy host port<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>success</td><td>FlowFiles are routed to success relationship</td></tr><tr><td>failure</td><td>FlowFiles are routed to failure relationship</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This processor has no state management .<h3>Restricted: </h3></body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.credentials.provider.service.AWSCredentialsProviderControllerService/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.credentials.provider.service.AWSCredentialsProviderControllerService/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.credentials.provider.service.AWSCredentialsProviderControllerService/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.credentials.provider.service.AWSCredentialsProviderControllerService/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>AWSCredentialsProviderControllerService</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Defines credentials for Amazon Web Services processors. Uses default credentials without configuration. Default credentials support EC2 instance profile/role, default user profile, environment variables, etc. Additional options include access key / secret key pairs, credentials file, named profile, and assume role credentials.</p><h3>Tags: </h3><p>aws, credentials, provider</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">Use 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 the Default Credential chain, including EC2 instance profiles or roles, environment variables, default user credentials, etc.</td></tr><tr><td id="name">Access Key</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">No Description Provided.<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Secret Key</td><td id="default-value"></td><td id="allowable-values"></td><td i d="description">No Description Provided.<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Credentials File</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Path to a file containing AWS access key and secret key in properties file format.</td></tr><tr><td id="name">Profile Name</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The AWS profile name for credentials from the profile configuration file.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Use Anonymous 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 Anonymous credentials</td></tr><tr><td id="name">Assume Role ARN</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The AWS Role ARN for cross account access. This is used in conjunction with role name and session timeout</td></tr><tr><td id="name">Assume Role Session Name</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The AWS Role Name for cross account access. This is used in conjunction with role ARN and session time out</td></tr><tr><td id="name">Session Time</td><td id="default-value">3600</td><td id="allowable-values"></td><td id="description">Session time for role based session (between 900 and 3600 seconds). This is used in conjunction with role ARN and name</td></tr><tr><td id="name">Assume Role External ID</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">External ID for cross-account access. This is used in conjunction with role arn, role name, and optional session time out</td></tr></table></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>AWSCredentialsProviderControllerService</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Defines credentials for Amazon Web Services processors. Uses default credentials without configuration. Default credentials support EC2 instance profile/role, default user profile, environment variables, etc. Additional options include access key / secret key pairs, credentials file, named profile, and assume role credentials.</p><h3>Tags: </h3><p>aws, credentials, provider</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">Use 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 the Default Credential chain, including EC2 instance profiles or roles, environment variables, default user credentials, etc.</td></tr><tr><td id="name">Access Key</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">No Description Provided.<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Secret Key</td><td id="default-value"></td><td id="allowable-values"></td><td i d="description">No Description Provided.<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Credentials File</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Path to a file containing AWS access key and secret key in properties file format.</td></tr><tr><td id="name">Profile Name</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The AWS profile name for credentials from the profile configuration file.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Use Anonymous 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 Anonymous credentials</td></tr><tr><td id="name">Assume Role ARN</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The AWS Role ARN for cross account access. This is used in conjunction with role name and session timeout</td></tr><tr><td id="name">Assume Role Session Name</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The AWS Role Name for cross account access. This is used in conjunction with role ARN and session time out</td></tr><tr><td id="name">Session Time</td><td id="default-value">3600</td><td id="allowable-values"></td><td id="description">Session time for role based session (between 900 and 3600 seconds). This is used in conjunction with role ARN and name</td></tr><tr><td id="name">Assume Role External ID</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">External ID for cross-account access. This is used in conjunction with role arn, role name, and optional session time out</td></tr><tr><td id="name">Assume Role Proxy Host</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Proxy host for cross-account access, if needed within your environment. This will configure a proxy to request for temporary access keys into another AWS account</td></tr><tr><td id="name">Assume Role Proxy Port</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Proxy pot for cross-account access, if needed within your environment. This will configure a proxy to request for temporary access keys into another AWS account</td></tr></table><h3>State management: </h3>This processor has no state management.<h3>Restricted: </h3></body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.dynamodb.DeleteDynamoDB/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.dynamodb.DeleteDynamoDB/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.dynamodb.DeleteDynamoDB/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.aws.dynamodb.DeleteDynamoDB/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>DeleteDynamoDB</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Deletes a document from DynamoDB based on hash and range key. The key can be string or number. The request requires all the primary keys for the operation (hash or hash and range key)</p><h3>Tags: </h3><p>Amazon, DynamoDB, AWS, 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>Table Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The DynamoDB table name</td></tr><tr><td id="name"><strong>Hash Key Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The hash key name of the item</td></tr><tr><td id="name">Range Key Name</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The range key name of the item</td></tr><tr><td id="name"><strong>Hash Key Value</strong></td><td id="default-value">${dynamodb.item.hash.key.value}</td><td id="allowable-values"></td><td id="description">The hash key value of the item<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Range Key Value</td><td id="default-value">${dynam odb.item.range.key.value}</td><td id="allowable-values"></td><td id="description">No Description Provided.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Hash Key Value Type</strong></td><td id="default-value">string</td><td id="allowable-values"><ul><li>string</li><li>number</li></ul></td><td id="description">The hash key value type of the item</td></tr><tr><td id="name"><strong>Range Key Value Type</strong></td><td id="default-value">string</td><td id="allowable-values"><ul><li>string</li><li>number</li></ul></td><td id="description">The range key value type of the item</td></tr><tr><td id="name">Batch items for each request (between 1 and 50)</td><td id="default-value">1</td><td id="allowable-values"></td><td id="description">The items to be retrieved in one batch</td></tr><tr><td id="name"><strong>Region</strong></td><td id="default-value">us-west-2</td><td id="allowable-values"><ul><li>us-gov-west-1 <img src="../../html/images/iconInf o.png" alt="us-gov-west-1" title="us-gov-west-1"></img></li><li>us-east-1 <img src="../../html/images/iconInfo.png" alt="us-east-1" title="us-east-1"></img></li><li>us-west-1 <img src="../../html/images/iconInfo.png" alt="us-west-1" title="us-west-1"></img></li><li>us-west-2 <img src="../../html/images/iconInfo.png" alt="us-west-2" title="us-west-2"></img></li><li>eu-west-1 <img src="../../html/images/iconInfo.png" alt="eu-west-1" title="eu-west-1"></img></li><li>eu-central-1 <img src="../../html/images/iconInfo.png" alt="eu-central-1" title="eu-central-1"></img></li><li>ap-southeast-1 <img src="../../html/images/iconInfo.png" alt="ap-southeast-1" title="ap-southeast-1"></img></li><li>ap-southeast-2 <img src="../../html/images/iconInfo.png" alt="ap-southeast-2" title="ap-southeast-2"></img></li><li>ap-northeast-1 <img src="../../html/images/iconInfo.png" alt="ap-northeast-1" title="ap-northeast-1"></img></li><li>ap-northeast-2 <img src="../../html/images/iconInfo.png" alt="ap-northe ast-2" title="ap-northeast-2"></img></li><li>sa-east-1 <img src="../../html/images/iconInfo.png" alt="sa-east-1" title="sa-east-1"></img></li><li>cn-north-1 <img src="../../html/images/iconInfo.png" alt="cn-north-1" title="cn-north-1"></img></li></ul></td><td id="description">No Description Provided.</td></tr><tr><td id="name">Access Key</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">No Description Provided.<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Secret Key</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">No Description Provided.<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Credentials File</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Path to a file containing AWS access key and secret key in properties file format.</td></tr><tr><td id="name">AWS Credentials Provider service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>AWSCredentialsProviderService<br/><strong>Implementation:</strong><br/><a href="../org.apache.nifi.processors.aws.credentials.provider.service.AWSCredentialsProviderControllerService/index.html">AWSCredentialsProviderControllerService</a></td><td id="description">The Controller Service that is used to obtain aws credentials provider</td></tr><tr><td id="name"><strong>Communications Timeout</strong></td><td id="default-value">30 secs</td><td id="allowable-values"></td><td id="description">No Description Provided.</td></tr><tr><td id="name">SSL Context Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Implementation:</strong><br/><a href="../org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextSer vice</a></td><td id="description">Specifies an optional SSL Context Service that, if provided, will be used to create connections</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>unprocessed</td><td>FlowFiles are routed to unprocessed relationship when DynamoDB is not able to process all the items in the request. Typical reasons are insufficient table throughput capacity and exceeding the maximum bytes per request. Unprocessed FlowFiles can be retried with a new request.</td></tr><tr><td>success</td><td>FlowFiles are routed to success relationship</td></tr><tr><td>failure</td><td>FlowFiles are routed to failure relationship</td></tr></table><h3>Reads Attributes: </h3><table id="reads-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td> dynamodb.item.hash.key.value</td><td>Items hash key value</td></tr><tr><td> dynamodb.item.range.key.value</td><td>Items range key value</td></tr></table><h3>Writes Attribu tes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>dynamodb.key.error.unprocessed</td><td>Dynamo db unprocessed keys</td></tr><tr><td>dynmodb.range.key.value.error</td><td>Dynamod db range key error</td></tr><tr><td>dynamodb.key.error.not.found</td><td>Dynamo db key not found</td></tr><tr><td>dynamodb.error.exception.message</td><td>Dynamo db exception message</td></tr><tr><td>dynamodb.error.code</td><td>Dynamo db error code</td></tr><tr><td>dynamodb.error.message</td><td>Dynamo db error message</td></tr><tr><td>dynamodb.error.type</td><td>Dynamo db error type</td></tr><tr><td>dynamodb.error.service</td><td>Dynamo db error service</td></tr><tr><td>dynamodb.error.retryable</td><td>Dynamo db error is retryable</td></tr><tr><td>dynamodb.error.request.id</td><td>Dynamo db error request id</td></tr><tr><td>dynamodb.error.status.code</td><td>Dynamo db status code</td></tr></table><h3>See Also:</h3><p><a href="../org.apache.nifi.processors.aws.dynamod b.GetDynamoDB/index.html">GetDynamoDB</a>, <a href="../org.apache.nifi.processors.aws.dynamodb.PutDynamoDB/index.html">PutDynamoDB</a></p></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>DeleteDynamoDB</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Deletes a document from DynamoDB based on hash and range key. The key can be string or number. The request requires all the primary keys for the operation (hash or hash and range key)</p><h3>Tags: </h3><p>Amazon, DynamoDB, AWS, 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>Table Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The DynamoDB table name</td></tr><tr><td id="name"><strong>Hash Key Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The hash key name of the item</td></tr><tr><td id="name">Range Key Name</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The range key name of the item</td></tr><tr><td id="name"><strong>Hash Key Value</strong></td><td id="default-value">${dynamodb.item.hash.key.value}</td><td id="allowable-values"></td><td id="description">The hash key value of the item<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Range Key Value</td><td id="default-value">${dynam odb.item.range.key.value}</td><td id="allowable-values"></td><td id="description">No Description Provided.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Hash Key Value Type</strong></td><td id="default-value">string</td><td id="allowable-values"><ul><li>string</li><li>number</li></ul></td><td id="description">The hash key value type of the item</td></tr><tr><td id="name"><strong>Range Key Value Type</strong></td><td id="default-value">string</td><td id="allowable-values"><ul><li>string</li><li>number</li></ul></td><td id="description">The range key value type of the item</td></tr><tr><td id="name">Batch items for each request (between 1 and 50)</td><td id="default-value">1</td><td id="allowable-values"></td><td id="description">The items to be retrieved in one batch</td></tr><tr><td id="name"><strong>Region</strong></td><td id="default-value">us-west-2</td><td id="allowable-values"><ul><li>us-gov-west-1 <img src="../../html/images/iconInf o.png" alt="us-gov-west-1" title="us-gov-west-1"></img></li><li>us-east-1 <img src="../../html/images/iconInfo.png" alt="us-east-1" title="us-east-1"></img></li><li>us-west-1 <img src="../../html/images/iconInfo.png" alt="us-west-1" title="us-west-1"></img></li><li>us-west-2 <img src="../../html/images/iconInfo.png" alt="us-west-2" title="us-west-2"></img></li><li>eu-west-1 <img src="../../html/images/iconInfo.png" alt="eu-west-1" title="eu-west-1"></img></li><li>eu-central-1 <img src="../../html/images/iconInfo.png" alt="eu-central-1" title="eu-central-1"></img></li><li>ap-southeast-1 <img src="../../html/images/iconInfo.png" alt="ap-southeast-1" title="ap-southeast-1"></img></li><li>ap-southeast-2 <img src="../../html/images/iconInfo.png" alt="ap-southeast-2" title="ap-southeast-2"></img></li><li>ap-northeast-1 <img src="../../html/images/iconInfo.png" alt="ap-northeast-1" title="ap-northeast-1"></img></li><li>ap-northeast-2 <img src="../../html/images/iconInfo.png" alt="ap-northe ast-2" title="ap-northeast-2"></img></li><li>sa-east-1 <img src="../../html/images/iconInfo.png" alt="sa-east-1" title="sa-east-1"></img></li><li>cn-north-1 <img src="../../html/images/iconInfo.png" alt="cn-north-1" title="cn-north-1"></img></li></ul></td><td id="description">No Description Provided.</td></tr><tr><td id="name">Access Key</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">No Description Provided.<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Secret Key</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">No Description Provided.<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Credentials File</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Path to a file containing AWS access key and secret key in properties file format.</td></tr><tr><td id="name">AWS Credentials Provider service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>AWSCredentialsProviderService<br/><strong>Implementation:</strong><br/><a href="../org.apache.nifi.processors.aws.credentials.provider.service.AWSCredentialsProviderControllerService/index.html">AWSCredentialsProviderControllerService</a></td><td id="description">The Controller Service that is used to obtain aws credentials provider</td></tr><tr><td id="name"><strong>Communications Timeout</strong></td><td id="default-value">30 secs</td><td id="allowable-values"></td><td id="description">No Description Provided.</td></tr><tr><td id="name">SSL Context Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Implementation:</strong><br/><a href="../org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextSer vice</a></td><td id="description">Specifies an optional SSL Context Service that, if provided, will be used to create connections</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>unprocessed</td><td>FlowFiles are routed to unprocessed relationship when DynamoDB is not able to process all the items in the request. Typical reasons are insufficient table throughput capacity and exceeding the maximum bytes per request. Unprocessed FlowFiles can be retried with a new request.</td></tr><tr><td>success</td><td>FlowFiles are routed to success relationship</td></tr><tr><td>failure</td><td>FlowFiles are routed to failure relationship</td></tr></table><h3>Reads Attributes: </h3><table id="reads-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td> dynamodb.item.hash.key.value</td><td>Items hash key value</td></tr><tr><td> dynamodb.item.range.key.value</td><td>Items range key value</td></tr></table><h3>Writes Attribu tes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>dynamodb.key.error.unprocessed</td><td>Dynamo db unprocessed keys</td></tr><tr><td>dynmodb.range.key.value.error</td><td>Dynamod db range key error</td></tr><tr><td>dynamodb.key.error.not.found</td><td>Dynamo db key not found</td></tr><tr><td>dynamodb.error.exception.message</td><td>Dynamo db exception message</td></tr><tr><td>dynamodb.error.code</td><td>Dynamo db error code</td></tr><tr><td>dynamodb.error.message</td><td>Dynamo db error message</td></tr><tr><td>dynamodb.error.type</td><td>Dynamo db error type</td></tr><tr><td>dynamodb.error.service</td><td>Dynamo db error service</td></tr><tr><td>dynamodb.error.retryable</td><td>Dynamo db error is retryable</td></tr><tr><td>dynamodb.error.request.id</td><td>Dynamo db error request id</td></tr><tr><td>dynamodb.error.status.code</td><td>Dynamo db status code</td></tr></table><h3>State management: </h3>This processor has no state management.<h3>R estricted: </h3><h3>See Also:</h3><p><a href="../org.apache.nifi.processors.aws.dynamodb.GetDynamoDB/index.html">GetDynamoDB</a>, <a href="../org.apache.nifi.processors.aws.dynamodb.PutDynamoDB/index.html">PutDynamoDB</a></p></body></html> \ No newline at end of file
