Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-2-0-nar/1.11.2/org.apache.nifi.processors.kafka.pubsub.PublishKafka_2_0/additionalDetails.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-2-0-nar/1.11.2/org.apache.nifi.processors.kafka.pubsub.PublishKafka_2_0/additionalDetails.html?rev=1874204&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-2-0-nar/1.11.2/org.apache.nifi.processors.kafka.pubsub.PublishKafka_2_0/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-2-0-nar/1.11.2/org.apache.nifi.processors.kafka.pubsub.PublishKafka_2_0/additionalDetails.html Wed Feb 19 18:04:18 2020 @@ -0,0 +1,205 @@ +<!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>PublishKafka</title> + <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" /> + </head> + + <body> + <h2>Description</h2> + <p> + This Processor puts the contents of a FlowFile to a Topic in + <a href="http://kafka.apache.org/";>Apache Kafka</a> using KafkaProducer API available + with Kafka 2.0 API. The content of a FlowFile becomes the contents of a Kafka message. + This message is optionally assigned a key by using the <Kafka Key> Property. + </p> + + <p> + The Processor allows the user to configure an optional Message Demarcator that + can be used to send many messages per FlowFile. For example, a <i>\n</i> could be used + to indicate that the contents of the FlowFile should be used to send one message + per line of text. It also supports multi-char demarcators (e.g., 'my custom demarcator'). + If the property is not set, the entire contents of the FlowFile + will be sent as a single message. When using the demarcator, if some messages are + successfully sent but other messages fail to send, the resulting FlowFile will be + considered a failed FlowFile and will have additional attributes to that effect. + One of such attributes is 'failed.last.idx' which indicates the index of the last message + that was successfully ACKed by Kafka. (if no demarcator is used the value of this index will be -1). + This will allow PublishKafka to only re-send un-ACKed messages on the next re-try. + </p> + + + <h2>Security Configuration</h2> + <p> + The Security Protocol property allows the user to specify the protocol for communicating + with the Kafka broker. The following sections describe each of the protocols in further detail. + </p> + <h3>PLAINTEXT</h3> + <p> + This option provides an unsecured connection to the broker, with no client authentication and no encryption. + In order to use this option the broker must be configured with a listener of the form: + <pre> + PLAINTEXT://host.name:port + </pre> + </p> + <h3>SSL</h3> + <p> + This option provides an encrypted connection to the broker, with optional client authentication. In order + to use this option the broker must be configured with a listener of the form: + <pre> + SSL://host.name:port + </pre> + In addition, the processor must have an SSL Context Service selected. + </p> + <p> + If the broker specifies ssl.client.auth=none, or does not specify ssl.client.auth, then the client will + not be required to present a certificate. In this case, the SSL Context Service selected may specify only + a truststore containing the public key of the certificate authority used to sign the broker's key. + </p> + <p> + If the broker specifies ssl.client.auth=required then the client will be required to present a certificate. + In this case, the SSL Context Service must also specify a keystore containing a client key, in addition to + a truststore as described above. + </p> + <h3>SASL_PLAINTEXT</h3> + <p> + This option uses SASL with a PLAINTEXT transport layer to authenticate to the broker. In order to use this + option the broker must be configured with a listener of the form: + <pre> + SASL_PLAINTEXT://host.name:port + </pre> + In addition, the Kerberos Service Name must be specified in the processor. + </p> + <h4>SASL_PLAINTEXT - GSSAPI</h4> + <p> + If the SASL mechanism is GSSAPI, then the client must provide a JAAS configuration to authenticate. The + JAAS configuration can be provided by specifying the java.security.auth.login.config system property in + NiFi's bootstrap.conf, such as: + <pre> + java.arg.16=-Djava.security.auth.login.config=/path/to/kafka_client_jaas.conf + </pre> + </p> + <p> + An example of the JAAS config file would be the following: + <pre> + KafkaClient { + com.sun.security.auth.module.Krb5LoginModule required + useKeyTab=true + storeKey=true + keyTab="/path/to/nifi.keytab" + serviceName="kafka" + principal="[email protected]"; + }; + </pre> + <b>NOTE:</b> The serviceName in the JAAS file must match the Kerberos Service Name in the processor. + </p> + <p> + Alternatively, the JAAS + configuration when using GSSAPI can be provided by specifying the Kerberos Principal and Kerberos Keytab + directly in the processor properties. This will dynamically create a JAAS configuration like above, and + will take precedence over the java.security.auth.login.config system property. + </p> + <h4>SASL_PLAINTEXT - PLAIN</h4> + <p> + If the SASL mechanism is PLAIN, then client must provide a JAAS configuration to authenticate, but + the JAAS configuration must use Kafka's PlainLoginModule. An example of the JAAS config file would + be the following: + <pre> + KafkaClient { + org.apache.kafka.common.security.plain.PlainLoginModule required + username="nifi" + password="nifi-password"; + }; + </pre> + The JAAS configuration can be provided by either of below ways + <ol type="1"> + <li>specify the java.security.auth.login.config system property in + NiFi's bootstrap.conf. This limits you to use only one user credential across the cluster.</li> + <pre> + java.arg.16=-Djava.security.auth.login.config=/path/to/kafka_client_jaas.conf + </pre> + <li>add user attribute 'sasl.jaas.config' in the processor configurations. This method allows one to have multiple consumers with different user credentials or gives flexibility to consume from multiple kafka clusters.</li> + <pre> + sasl.jaas.config : org.apache.kafka.common.security.plain.PlainLoginModule required + username="nifi" + password="nifi-password"; + </pre> + <b>NOTE:</b> The dynamic properties of this processor are not secured and as a result the password entered when utilizing sasl.jaas.config will be stored in the flow.xml.gz file in plain-text, and will be saved to NiFi Registry if using versioned flows. + </ol> + </p> + <p> + <b>NOTE:</b> It is not recommended to use a SASL mechanism of PLAIN with SASL_PLAINTEXT, as it would transmit + the username and password unencrypted. + </p> + <p> + <b>NOTE:</b> The Kerberos Service Name is not required for SASL mechanism of PLAIN. However, processor warns saying this attribute has to be filled with non empty string. You can choose to fill any random string, such as "null". + </p> + <p> + <b>NOTE:</b> Using the PlainLoginModule will cause it be registered in the JVM's static list of Providers, making + it visible to components in other NARs that may access the providers. There is currently a known issue + where Kafka processors using the PlainLoginModule will cause HDFS processors with Keberos to no longer work. + </p> + + <h4>SASL_PLAINTEXT - SCRAM</h4> + <p> + If the SASL mechanism is SSL, then client must provide a JAAS configuration to authenticate, but + the JAAS configuration must use Kafka's ScramLoginModule. Ensure that you add user defined attribute 'sasl.mechanism' and assign 'SCRAM-SHA-256' or 'SCRAM-SHA-512' based on kafka broker configurations. An example of the JAAS config file would + be the following: + <pre> + KafkaClient { + org.apache.kafka.common.security.scram.ScramLoginModule + username="nifi" + password="nifi-password"; + }; + </pre> + + The JAAS configuration can be provided by either of below ways + <ol type="1"> + <li>specify the java.security.auth.login.config system property in + NiFi's bootstrap.conf. This limits you to use only one user credential across the cluster.</li> + <pre> + java.arg.16=-Djava.security.auth.login.config=/path/to/kafka_client_jaas.conf + </pre> + <li>add user attribute 'sasl.jaas.config' in the processor configurations. This method allows one to have multiple consumers with different user credentials or gives flexibility to consume from multiple kafka clusters.</li> + <pre> + sasl.jaas.config : org.apache.kafka.common.security.scram.ScramLoginModule required + username="nifi" + password="nifi-password"; + </pre> + <b>NOTE:</b> The dynamic properties of this processor are not secured and as a result the password entered when utilizing sasl.jaas.config will be stored in the flow.xml.gz file in plain-text, and will be saved to NiFi Registry if using versioned flows. + </ol> + <b>NOTE:</b> The Kerberos Service Name is not required for SASL mechanism of SCRAM-SHA-256 or SCRAM-SHA-512. However, processor warns saying this attribute has to be filled with non empty string. You can choose to fill any random string, such as "null". + </p> + <h3>SASL_SSL</h3> + <p> + This option uses SASL with an SSL/TLS transport layer to authenticate to the broker. In order to use this + option the broker must be configured with a listener of the form: + <pre> + SASL_SSL://host.name:port + </pre> + </p> + <p> + See the SASL_PLAINTEXT section for a description of how to provide the proper JAAS configuration + depending on the SASL mechanism (GSSAPI or PLAIN). + </p> + <p> + See the SSL section for a description of how to configure the SSL Context Service based on the + ssl.client.auth property. + </p> + </body> +</html>
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-2-0-nar/1.11.2/org.apache.nifi.processors.kafka.pubsub.PublishKafka_2_0/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-2-0-nar/1.11.2/org.apache.nifi.processors.kafka.pubsub.PublishKafka_2_0/index.html?rev=1874204&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-2-0-nar/1.11.2/org.apache.nifi.processors.kafka.pubsub.PublishKafka_2_0/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-2-0-nar/1.11.2/org.apache.nifi.processors.kafka.pubsub.PublishKafka_2_0/index.html Wed Feb 19 18:04:18 2020 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PublishKafka_2_0</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;">PublishKafka_2_0</h1><h2>Description: </h2><p>Sends the contents of a FlowFile as a message to Apache Kafka using the Kafka 2.0 Producer API.The messages to send may be individual FlowFiles or may be delimited, using a user-specified delimiter, such as a new-line. The complementary NiFi processor for fetching messages is ConsumeKafka_2_0.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>Apache, Kafka, Put, Send, Message, PubSub, 2.0</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other prope rties (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>Kafka Brokers</strong></td><td id="default-value">localhost:9092</td><td id="allowable-values"></td><td id="description">A comma-separated list of known Kafka Brokers in the format <host>:<port><br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Security Protocol</strong></ td><td id="default-value">PLAINTEXT</td><td id="allowable-values"><ul><li>PLAINTEXT <img src="../../../../../html/images/iconInfo.png" alt="PLAINTEXT" title="PLAINTEXT"></img></li><li>SSL <img src="../../../../../html/images/iconInfo.png" alt="SSL" title="SSL"></img></li><li>SASL_PLAINTEXT <img src="../../../../../html/images/iconInfo.png" alt="SASL_PLAINTEXT" title="SASL_PLAINTEXT"></img></li><li>SASL_SSL <img src="../../../../../html/images/iconInfo.png" alt="SASL_SSL" title="SASL_SSL"></img></li></ul></td><td id="description">Protocol used to communicate with brokers. Corresponds to Kafka's 'security.protocol' property.</td></tr><tr><td id="name"><strong>SASL Mechanism</strong></td><td id="default-value">GSSAPI</td><td id="allowable-values"><ul><li>GSSAPI <img src="../../../../../html/images/iconInfo.png" alt="The mechanism for authentication via Kerberos. The principal and keytab must be provided to the processor by using a Keytab Credential service, or by specifying the propert ies directly in the processor." title="The mechanism for authentication via Kerberos. The principal and keytab must be provided to the processor by using a Keytab Credential service, or by specifying the properties directly in the processor."></img></li><li>PLAIN <img src="../../../../../html/images/iconInfo.png" alt="The mechanism for authentication via username and password. The username and password properties must be populated when using this mechanism." title="The mechanism for authentication via username and password. The username and password properties must be populated when using this mechanism."></img></li><li>SCRAM-SHA-256 <img src="../../../../../html/images/iconInfo.png" alt="The Salted Challenge Response Authentication Mechanism. The username and password properties must be set when using this mechanism." title="The Salted Challenge Response Authentication Mechanism. The username and password properties must be set when using this mechanism."></img></li></ul></td><td i d="description">The SASL mechanism to use for authentication. Corresponds to Kafka's 'sasl.mechanism' property.</td></tr><tr><td id="name">Kerberos Service Name</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The service name that matches the primary name of the Kafka server configured in the broker JAAS file.This can be defined either in Kafka's JAAS config or in Kafka's config. Corresponds to Kafka's 'security.protocol' property.It is ignored unless one of the SASL options of the <Security Protocol> are selected.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Kerberos Credentials Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>KerberosCredentialsService<br/><strong>Implementation: </strong><a href="../../../nifi-kerberos-credentials-service-nar/1.11.2/org.apache.nifi.kerberos.KeytabCredentials Service/index.html">KeytabCredentialsService</a></td><td id="description">Specifies the Kerberos Credentials Controller Service that should be used for authenticating with Kerberos</td></tr><tr><td id="name">Kerberos Principal</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Kerberos principal that will be used to connect to brokers. If not set, it is expected to set a JAAS configuration file in the JVM properties defined in the bootstrap.conf file. This principal will be set into 'sasl.jaas.config' Kafka's property.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Kerberos Keytab</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Kerberos keytab that will be used to connect to brokers. If not set, it is expected to set a JAAS configuration file in the JVM properties defined in the bootstrap.conf file. This principal will be s et into 'sasl.jaas.config' Kafka's property.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The username when the SASL Mechanism is PLAIN or SCRAM-SHA-256<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The password for the given username when the SASL Mechanism is PLAIN or SCRAM-SHA-256<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Token Auth</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">When SASL Mechanism is SCRAM-SHA-256, t his property indicates if token authentication should be used.</td></tr><tr><td id="name">SSL Context Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Implementations: </strong><a href="../../../nifi-ssl-context-service-nar/1.11.2/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</a><br/><a href="../../../nifi-ssl-context-service-nar/1.11.2/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td id="description">Specifies the SSL Context Service to use for communicating with Kafka.</td></tr><tr><td id="name"><strong>Topic Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the Kafka Topic to publish to.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Delivery Guarantee</strong></td><td id="default-value">0</td><td id="allowable-values"><ul><li>Best Effort <img src="../../../../../html/images/iconInfo.png" alt="FlowFile will be routed to success after successfully writing the content to a Kafka node, without waiting for a response. This provides the best performance but may result in data loss." title="FlowFile will be routed to success after successfully writing the content to a Kafka node, without waiting for a response. This provides the best performance but may result in data loss."></img></li><li>Guarantee Single Node Delivery <img src="../../../../../html/images/iconInfo.png" alt="FlowFile will be routed to success if the message is received by a single Kafka node, whether or not it is replicated. This is faster than <Guarantee Replicated Delivery> but can result in data loss if a Kafka node crashes" title="FlowFile will be routed to success if the message is received by a single Kafka node, whether or not it is replicated. This is faster than <Guarantee Replicated Delivery> but can result in data loss if a Kafka node crashes"></img></li><li>Guarantee Replicated Delivery <img src="../../../../../html/images/iconInfo.png" alt="FlowFile will be routed to failure unless the message is replicated to the appropriate number of Kafka Nodes according to the Topic configuration" title="FlowFile will be routed to failure unless the message is replicated to the appropriate number of Kafka Nodes according to the Topic configuration"></img></li></ul></td><td id="description">Specifies the requirement for guaranteeing that a message is sent to Kafka. Corresponds to Kafka's 'acks' property.</td></tr><tr><td id="name"><strong>Use Transactions</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specifies whether or not NiFi should provide Transactional guarantees when communicating with Kafka. If there is a problem sending data to Kafka, and this property is set to false, then the messages that have already been sent to Kafka will continue on and be delivered to consumers. If this is set to true, then the Kafka transaction will be rolled back so that those messages are not available to consumers. Setting this to true requires that the <Delivery Guarantee> property be set to "Guarantee Replicated Delivery."</td></tr><tr><td id="name">Transactional Id Prefix</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">When Use Transaction is set to true, KafkaProducer config 'transactional.id' will be a generated UUID and will be prefixed with this string.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Attributes to Send as Headers (Regex)</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A Regular Expression that is matched against all FlowF ile attribute names. Any attribute whose name matches the regex will be added to the Kafka messages as a Header. If not specified, no FlowFile attributes will be added as headers.</td></tr><tr><td id="name">Message Header Encoding</td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">For any attribute that is added as a message header, as configured via the <Attributes to Send as Headers> property, this property indicates the Character Encoding to use for serializing the headers.</td></tr><tr><td id="name">Kafka Key</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Key to use for the Message. If not specified, the flow file attribute 'kafka.key' is used as the message key, if it is present.Beware that setting Kafka key and demarcating at the same time may potentially lead to many Kafka messages with the same key.Normally this is not a problem as Kafka does not enforce or assume message and key uniqueness. Still, setting the demarcator and Kafka key at the same time poses a risk of data loss on Kafka. During a topic compaction on Kafka, messages will be deduplicated based on this key.<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 Attribute Encoding</strong></td><td id="default-value">utf-8</td><td id="allowable-values"><ul><li>UTF-8 Encoded <img src="../../../../../html/images/iconInfo.png" alt="The key is interpreted as a UTF-8 Encoded string." title="The key is interpreted as a UTF-8 Encoded string."></img></li><li>Hex Encoded <img src="../../../../../html/images/iconInfo.png" alt="The key is interpreted as arbitrary binary data that is encoded using hexadecimal characters with uppercase letters." title="The key is interpreted as arbitrary binary data that is encoded using hexadecimal characters with uppercase letters."></img></li></ul></td><td id="description">Flow Files that are emitted have an attribute named 'kafka.key'. This property dictates how the value of the attribute should be encoded.</td></tr><tr><td id="name">Message Demarcator</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specifies the string (interpreted as UTF-8) to use for demarcating multiple messages within a single FlowFile. If not specified, the entire content of the FlowFile will be used as a single message. If specified, the contents of the FlowFile will be split on this delimiter and each section sent as a separate Kafka message. To enter special character such as 'new line' use CTRL+Enter or Shift+Enter, depending on your OS.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Max Request Size</strong></td><td id="default-value">1 MB</td><td id="allowable-values"></td><td id="description">The maximum size of a request in byte s. Corresponds to Kafka's 'max.request.size' property and defaults to 1 MB (1048576).</td></tr><tr><td id="name"><strong>Acknowledgment Wait Time</strong></td><td id="default-value">5 secs</td><td id="allowable-values"></td><td id="description">After sending a message to Kafka, this indicates the amount of time that we are willing to wait for a response from Kafka. If Kafka does not acknowledge the message within this time period, the FlowFile will be routed to 'failure'.</td></tr><tr><td id="name"><strong>Max Metadata Wait Time</strong></td><td id="default-value">5 sec</td><td id="allowable-values"></td><td id="description">The amount of time publisher will wait to obtain metadata or wait for the buffer to flush during the 'send' call before failing the entire 'send' call. Corresponds to Kafka's 'max.block.ms' property<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Partitioner class</td><td id="def ault-value">org.apache.kafka.clients.producer.internals.DefaultPartitioner</td><td id="allowable-values"><ul><li>RoundRobinPartitioner <img src="../../../../../html/images/iconInfo.png" alt="Messages will be assigned partitions in a round-robin fashion, sending the first message to Partition 1, the next Partition to Partition 2, and so on, wrapping as necessary." title="Messages will be assigned partitions in a round-robin fashion, sending the first message to Partition 1, the next Partition to Partition 2, and so on, wrapping as necessary."></img></li><li>DefaultPartitioner <img src="../../../../../html/images/iconInfo.png" alt="Messages will be assigned to random partitions." title="Messages will be assigned to random partitions."></img></li><li>Expression Language Partitioner <img src="../../../../../html/images/iconInfo.png" alt="Interprets the <Partition> property as Expression Language that will be evaluated against each FlowFile. This Expression will be evaluated once a gainst the FlowFile, so all Records in a given FlowFile will go to the same partition." title="Interprets the <Partition> property as Expression Language that will be evaluated against each FlowFile. This Expression will be evaluated once against the FlowFile, so all Records in a given FlowFile will go to the same partition."></img></li></ul></td><td id="description">Specifies which class to use to compute a partition id for a message. Corresponds to Kafka's 'partitioner.class' property.</td></tr><tr><td id="name">Partition</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specifies which Partition Records will go to.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Compression Type</strong></td><td id="default-value">none</td><td id="allowable-values"><ul><li>none</li><li>gzip</li><li>snappy</li><li>lz4</li></ul></td><td id="descript ion">This parameter allows you to specify the compression codec for all data generated by this producer.</td></tr></table><h3>Dynamic Properties: </h3><p>Dynamic Properties allow the user to specify both the name and value of a property.<table id="dynamic-properties"><tr><th>Name</th><th>Value</th><th>Description</th></tr><tr><td id="name">The name of a Kafka configuration property.</td><td id="value">The value of a given Kafka configuration property.</td><td>These properties will be added on the Kafka configuration after loading any provided configuration properties. In the event a dynamic property represents a property that was already set, its value will be ignored and WARN message logged. For the list of available Kafka properties please refer to: http://kafka.apache.org/documentation.html#configuration. <br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</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 for which all content was sent to Kafka.</td></tr><tr><td>failure</td><td>Any FlowFile that cannot be sent to Kafka 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>msg.count</td><td>The number of messages that were sent to Kafka for this FlowFile. This attribute is added only to FlowFiles that are routed to success. If the <Message Demarcator> Property is not set, this will always be 1, but if the Property is set, it may be greater than 1.</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-kafka-2-0-nar/1.11.2/org.apache.nifi.record.sink.kafka.KafkaRecordSink_2_0/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-2-0-nar/1.11.2/org.apache.nifi.record.sink.kafka.KafkaRecordSink_2_0/index.html?rev=1874204&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-2-0-nar/1.11.2/org.apache.nifi.record.sink.kafka.KafkaRecordSink_2_0/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-2-0-nar/1.11.2/org.apache.nifi.record.sink.kafka.KafkaRecordSink_2_0/index.html Wed Feb 19 18:04:18 2020 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>KafkaRecordSink_2_0</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;">KafkaRecordSink_2_0</h1><h2>Description: </h2><p>Provides a service to write records to a Kafka 2.x topic.</p><h3>Tags: </h3><p>kafka, record, sink</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>Kafka Brokers</strong></td><td id="default-value">localhost:9092</td><td id="allowable-values"></td><td id="description">A comma-separated list of known Kafka Brokers in the format <host>:<port><br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Topic Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the Kafka Topic to publish to.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Record Writer</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>RecordSetWriterFactory<br/><strong>Implementations: </strong><a href="../../../nifi-parquet-nar/1.11.2/org.apache.nifi.parquet.ParquetRecordSetWriter/index.html">ParquetRecordSetWriter</a><br/><a href= "../../../nifi-record-serialization-services-nar/1.11.2/org.apache.nifi.csv.CSVRecordSetWriter/index.html">CSVRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.2/org.apache.nifi.text.FreeFormTextRecordSetWriter/index.html">FreeFormTextRecordSetWriter</a><br/><a href="../../../nifi-scripting-nar/1.11.2/org.apache.nifi.record.script.ScriptedRecordSetWriter/index.html">ScriptedRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.2/org.apache.nifi.avro.AvroRecordSetWriter/index.html">AvroRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.2/org.apache.nifi.xml.XMLRecordSetWriter/index.html">XMLRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.2/org.apache.nifi.json.JsonRecordSetWriter/index.html">JsonRecordSetWriter</a></td><td id="description">Specifies the Controller Service to use for writing out the records.</td></tr><tr><td id="name"><strong>Del ivery Guarantee</strong></td><td id="default-value">0</td><td id="allowable-values"><ul><li>Best Effort <img src="../../../../../html/images/iconInfo.png" alt="Records are considered 'transmitted successfully' after successfully writing the content to a Kafka node, without waiting for a response. This provides the best performance but may result in data loss." title="Records are considered 'transmitted successfully' after successfully writing the content to a Kafka node, without waiting for a response. This provides the best performance but may result in data loss."></img></li><li>Guarantee Single Node Delivery <img src="../../../../../html/images/iconInfo.png" alt="Records are considered 'transmitted successfully' if the message is received by a single Kafka node, whether or not it is replicated. This is faster than <Guarantee Replicated Delivery> but can result in data loss if a Kafka node crashes." title="Records are considered 'transmitted successfully' if the message is r eceived by a single Kafka node, whether or not it is replicated. This is faster than <Guarantee Replicated Delivery> but can result in data loss if a Kafka node crashes."></img></li><li>Guarantee Replicated Delivery <img src="../../../../../html/images/iconInfo.png" alt="Records are considered 'transmitted unsuccessfully' unless the message is replicated to the appropriate number of Kafka Nodes according to the Topic configuration." title="Records are considered 'transmitted unsuccessfully' unless the message is replicated to the appropriate number of Kafka Nodes according to the Topic configuration."></img></li></ul></td><td id="description">Specifies the requirement for guaranteeing that a message is sent to Kafka. Corresponds to Kafka's 'acks' property.</td></tr><tr><td id="name">Message Header Encoding</td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">For any attribute that is added as a message header, as configured via the <Attri butes to Send as Headers> property, this property indicates the Character Encoding to use for serializing the headers.</td></tr><tr><td id="name"><strong>Security Protocol</strong></td><td id="default-value">PLAINTEXT</td><td id="allowable-values"><ul><li>PLAINTEXT <img src="../../../../../html/images/iconInfo.png" alt="PLAINTEXT" title="PLAINTEXT"></img></li><li>SSL <img src="../../../../../html/images/iconInfo.png" alt="SSL" title="SSL"></img></li><li>SASL_PLAINTEXT <img src="../../../../../html/images/iconInfo.png" alt="SASL_PLAINTEXT" title="SASL_PLAINTEXT"></img></li><li>SASL_SSL <img src="../../../../../html/images/iconInfo.png" alt="SASL_SSL" title="SASL_SSL"></img></li></ul></td><td id="description">Protocol used to communicate with brokers. Corresponds to Kafka's 'security.protocol' property.</td></tr><tr><td id="name">Kerberos Credentials Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>KerberosCredentialsSe rvice<br/><strong>Implementation: </strong><a href="../../../nifi-kerberos-credentials-service-nar/1.11.2/org.apache.nifi.kerberos.KeytabCredentialsService/index.html">KeytabCredentialsService</a></td><td id="description">Specifies the Kerberos Credentials Controller Service that should be used for authenticating with Kerberos</td></tr><tr><td id="name">Kerberos Service Name</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The service name that matches the primary name of the Kafka server configured in the broker JAAS file.This can be defined either in Kafka's JAAS config or in Kafka's config. Corresponds to Kafka's 'security.protocol' property.It is ignored unless one of the SASL options of the <Security Protocol> are selected.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">SSL Context Service</td><td id="default-value"></td><td id="allowable-values"><strong >Controller Service API: ></strong><br/>SSLContextService<br/><strong>Implementations: </strong><a >href="../../../nifi-ssl-context-service-nar/1.11.2/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</a><br/><a > >href="../../../nifi-ssl-context-service-nar/1.11.2/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td > id="description">Specifies the SSL Context Service to use for communicating >with Kafka.</td></tr><tr><td id="name"><strong>Max Request >Size</strong></td><td id="default-value">1 MB</td><td >id="allowable-values"></td><td id="description">The maximum size of a request >in bytes. Corresponds to Kafka's 'max.request.size' property and defaults to >1 MB (1048576).</td></tr><tr><td id="name"><strong>Acknowledgment Wait >Time</strong></td><td id="default-value">5 secs</td><td >id="allowable-values"></td><td id="description">After sending a message to >Kafka, this indicates the amount of time that we are willing to wait for a response from Kafka. If Kafka does not acknowledge the message within this time period, the FlowFile will be routed to 'failure'.</td></tr><tr><td id="name"><strong>Max Metadata Wait Time</strong></td><td id="default-value">5 sec</td><td id="allowable-values"></td><td id="description">The amount of time publisher will wait to obtain metadata or wait for the buffer to flush during the 'send' call before failing the entire 'send' call. Corresponds to Kafka's 'max.block.ms' property<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Compression Type</strong></td><td id="default-value">none</td><td id="allowable-values"><ul><li>none</li><li>gzip</li><li>snappy</li><li>lz4</li></ul></td><td id="description">This parameter allows you to specify the compression codec for all data generated by this producer.</td></tr></table><h3>State management: </h3>This component do es not store state.<h3>Restricted: </h3>This component is not restricted.<h3>System Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kerberos-credentials-service-nar/1.11.2/org.apache.nifi.kerberos.KeytabCredentialsService/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kerberos-credentials-service-nar/1.11.2/org.apache.nifi.kerberos.KeytabCredentialsService/index.html?rev=1874204&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kerberos-credentials-service-nar/1.11.2/org.apache.nifi.kerberos.KeytabCredentialsService/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kerberos-credentials-service-nar/1.11.2/org.apache.nifi.kerberos.KeytabCredentialsService/index.html Wed Feb 19 18:04:18 2020 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>KeytabCredentialsService</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;">KeytabCredentialsService</h1><h2>Description: </h2><p>Provides a mechanism for specifying a Keytab and a Principal that other components are able to use in order to perform authentication using Kerberos. By encapsulating this information into a Controller Service and allowing other components to make use of it (as opposed to specifying the principal and keytab directly in the processor) an administrator is able to choose which users are allowed to use which keytabs and principals. This provides a more robust security model for multi-tenant use cases.</p><h3>Tags: </h3><p>Kerberos, Keyta b, Principal, Credentials, Authentication, Security</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, 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>Kerberos Keytab</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Kerberos keytab associated with the principal. Requires nifi.kerberos.krb5.file to be set in your nifi.properties<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Kerberos Principal</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id ="description">Kerberos principal to authenticate as. Requires nifi.kerberos.krb5.file to be set in your nifi.properties<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3><table id="restrictions"><tr><th>Required Permission</th><th>Explanation</th></tr><tr><td>access keytab</td><td>Allows user to define a Keytab and principal that can then be used by other components.</td></tr></table><h3>System Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kudu-nar/1.11.2/org.apache.nifi.controller.kudu.KuduLookupService/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kudu-nar/1.11.2/org.apache.nifi.controller.kudu.KuduLookupService/index.html?rev=1874204&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kudu-nar/1.11.2/org.apache.nifi.controller.kudu.KuduLookupService/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kudu-nar/1.11.2/org.apache.nifi.controller.kudu.KuduLookupService/index.html Wed Feb 19 18:04:18 2020 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>KuduLookupService</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;">KuduLookupService</h1><h2>Description: </h2><p>Lookup a record from Kudu Server associated with the specified key. Binary columns are base64 encoded. Only one matched row will be returned</p><h3>Tags: </h3><p>lookup, enrich, key, value, kudu</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>Kudu Masters</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Comma separated addresses of the Kudu masters to connect to.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Kerberos Credentials Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>KerberosCredentialsService<br/><strong>Implementation: </strong><a href="../../../nifi-kerberos-credentials-service-nar/1.11.2/org.apache.nifi.kerberos.KeytabCredentialsService/index.html">KeytabCredentialsService</a></td><td id="description">Specifies the Kerberos Credentials to use for authentication</td></tr><tr><td id="name">Kudu Operation Timeout</td><td id="default-value">30000ms</td><td id="allowable-values"></td><td id="descri ption">Default timeout used for user operations (using sessions and scanners)<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Kudu Replica Selection</strong></td><td id="default-value">CLOSEST_REPLICA</td><td id="allowable-values"><ul><li>CLOSEST_REPLICA <img src="../../../../../html/images/iconInfo.png" alt="Select the closest replica to the client. Replicas are classified from closest to furthest as follows: 1) Local replicas 2) Replicas whose tablet server has the same location as the client 3) All other replicas" title="Select the closest replica to the client. Replicas are classified from closest to furthest as follows: 1) Local replicas 2) Replicas whose tablet server has the same location as the client 3) All other replicas"></img></li><li>LEADER_ONLY <img src="../../../../../html/images/iconInfo.png" alt="Select the LEADER replica" title="Select the LEADER replica"></img></li></ul></t d><td id="description">Policy with which to choose amongst multiple replicas</td></tr><tr><td id="name"><strong>Kudu Table Name</strong></td><td id="default-value">default</td><td id="allowable-values"></td><td id="description">Name of the table to access.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Kudu Return Columns</strong></td><td id="default-value">*</td><td id="allowable-values"></td><td id="description">A comma-separated list of columns to return when scanning. To return all columns set to "*"<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>System Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kudu-nar/1.11.2/org.apache.nifi.processors.kudu.PutKudu/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kudu-nar/1.11.2/org.apache.nifi.processors.kudu.PutKudu/index.html?rev=1874204&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kudu-nar/1.11.2/org.apache.nifi.processors.kudu.PutKudu/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kudu-nar/1.11.2/org.apache.nifi.processors.kudu.PutKudu/index.html Wed Feb 19 18:04:18 2020 @@ -0,0 +1,4 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutKudu</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">PutKudu</h1><h2>Description: </h2><p>Reads records from an incoming FlowFile using the provided Record Reader, and writes those records to the specified Kudu's table. The schema for the table must be provided in the processor properties or from your source. If any error occurs while reading records from the input, or writing records to Kudu, the FlowFile will be routed to failure</p><h3>Tags: </h3><p>put, database, NoSQL, kudu, HDFS, record</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered opt ional. The table also indicates any default values, and whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Kudu Masters</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Comma separated addresses of the Kudu masters to connect to.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Table Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the Kudu Table to put data into<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Kerberos Credentials Service</td><td id="default-value"></td><td id="a llowable-values"><strong>Controller Service API: </strong><br/>KerberosCredentialsService<br/><strong>Implementation: </strong><a href="../../../nifi-kerberos-credentials-service-nar/1.11.2/org.apache.nifi.kerberos.KeytabCredentialsService/index.html">KeytabCredentialsService</a></td><td id="description">Specifies the Kerberos Credentials to use for authentication</td></tr><tr><td id="name"><strong>Skip head line</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Deprecated. Used to ignore header lines, but this should be handled by a RecordReader (e.g. "Treat First Line as Header" property of CSVReader)</td></tr><tr><td id="name"><strong>Lowercase Field Names</strong></td><td id="default-value">false</td><td id="allowable-values"></td><td id="description">Convert column names to lowercase when finding index of Kudu table columns<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Record Reader</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>RecordReaderFactory<br/><strong>Implementations: </strong><a href="../../../nifi-record-serialization-services-nar/1.11.2/org.apache.nifi.csv.CSVReader/index.html">CSVReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.2/org.apache.nifi.avro.AvroReader/index.html">AvroReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.2/org.apache.nifi.syslog.SyslogReader/index.html">SyslogReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.2/org.apache.nifi.json.JsonPathReader/index.html">JsonPathReader</a><br/><a href="../../../nifi-scripting-nar/1.11.2/org.apache.nifi.record.script.ScriptedReader/index.html">ScriptedReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.2/org.apache.nifi.x ml.XMLReader/index.html">XMLReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.2/org.apache.nifi.syslog.Syslog5424Reader/index.html">Syslog5424Reader</a><br/><a href="../../../nifi-parquet-nar/1.11.2/org.apache.nifi.parquet.ParquetReader/index.html">ParquetReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.2/org.apache.nifi.json.JsonTreeReader/index.html">JsonTreeReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.2/org.apache.nifi.grok.GrokReader/index.html">GrokReader</a></td><td id="description">The service for reading records from incoming flow files.</td></tr><tr><td id="name">Kudu Operation Type</td><td id="default-value">INSERT</td><td id="allowable-values"></td><td id="description">Specify operationType for this processor. Insert-Ignore will ignore duplicated rows<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr ><td id="name"><strong>Flush Mode</strong></td><td >id="default-value">AUTO_FLUSH_BACKGROUND</td><td >id="allowable-values"><ul><li>AUTO_FLUSH_SYNC</li><li>AUTO_FLUSH_BACKGROUND</li><li>MANUAL_FLUSH</li></ul></td><td > id="description">Set the new flush mode for a kudu session. +AUTO_FLUSH_SYNC: the call returns when the operation is persisted, else it throws an exception. +AUTO_FLUSH_BACKGROUND: the call returns when the operation has been added to the buffer. This call should normally perform only fast in-memory operations but it may have to wait when the buffer is full and there's another buffer being flushed. +MANUAL_FLUSH: the call returns when the operation has been added to the buffer, else it throws a KuduException if the buffer is full.</td></tr><tr><td id="name"><strong>FlowFiles per Batch</strong></td><td id="default-value">1</td><td id="allowable-values"></td><td id="description">The maximum number of FlowFiles to process in a single execution, between 1 - 100000. Depending on your memory size, and data size per row set an appropriate batch size for the number of FlowFiles to process per client connection setup.Gradually increase this number, only if your FlowFiles typically contain a few records.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Max Records per Batch</strong></td><td id="default-value">100</td><td id="allowable-values"></td><td id="description">The maximum number of Records to process in a single Kudu-client batch, between 1 - 100000. Depending on your memory size, and data size per row set an appropriate batch size. Gradually increase this number to find out the best one for best performances.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Ignore NULL</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Ignore NULL on Kudu Put Operation, Update only non-Null columns if set true<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Kudu Operation Timeout</td><td id="default-value">30000ms</td><td id="allowable-values"></td><td id="description">Default timeout used for user operations (using sessions and scanners)<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Kudu Keep Alive Period Timeout</td><td id=" default-value">15000ms</td><td id="allowable-values"></td><td id="description">Default timeout used for user operations<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>A FlowFile is routed to this relationship after it has been successfully stored in Kudu</td></tr><tr><td>failure</td><td>A FlowFile is routed to this relationship if it cannot be sent to Kudu</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>record.count</td><td>Number of records written to Kudu</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>System Res ource Considerations:</h3>None specified.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-language-translation-nar/1.11.2/org.apache.nifi.processors.yandex.YandexTranslate/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-language-translation-nar/1.11.2/org.apache.nifi.processors.yandex.YandexTranslate/index.html?rev=1874204&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-language-translation-nar/1.11.2/org.apache.nifi.processors.yandex.YandexTranslate/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-language-translation-nar/1.11.2/org.apache.nifi.processors.yandex.YandexTranslate/index.html Wed Feb 19 18:04:18 2020 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>YandexTranslate</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">YandexTranslate</h1><h2>Description: </h2><p>Translates content and attributes from one language to another</p><h3>Tags: </h3><p>yandex, translate, translation, language</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</t h><th>Description</th></tr><tr><td id="name"><strong>Yandex API Key</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The API Key that is registered with Yandex</td></tr><tr><td id="name">Input Language</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The language of incoming data. If no language is set, Yandex will attempt to detect the incoming language automatically.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Target Language</strong></td><td id="default-value">en</td><td id="allowable-values"></td><td id="description">The language to translate the text into<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Translate Content</strong></td><td id="default-value">false</td><td id="all owable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specifies whether or not the content should be translated. If false, only the text specified by user-defined properties will be translated.</td></tr><tr><td id="name"><strong>Character Set</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">Specifies the character set of the data to be translated<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr></table><h3>Dynamic Properties: </h3><p>Dynamic Properties allow the user to specify both the name and value of a property.<table id="dynamic-properties"><tr><th>Name</th><th>Value</th><th>Description</th></tr><tr><td id="name">The name of an attribute to set that will contain the translated text of the value</td><td id="value">The value to translate</td><td>User-defined properties are used to translate arbitrary text based on attributes. <br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr></table></p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>translation.failure</td><td>This relationship is used if the translation cannot be performed for some reason other than communications failure</td></tr><tr><td>success</td><td>This relationship is used when the translation is successful</td></tr><tr><td>comms.failure</td><td>This relationship is used when the translation fails due to a problem such as a network failure, and for which the translation should be attempted again</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>yandex.translate.failure.reason</td><td>If the text cannot be translated, this attribute will be set indicating the reason for the failure</td></tr><tr><t d>language</td><td>When the translation succeeds, if the content was translated, this attribute will be set indicating the new language of the content</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-livy-nar/1.11.2/org.apache.nifi.controller.livy.LivySessionController/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-livy-nar/1.11.2/org.apache.nifi.controller.livy.LivySessionController/index.html?rev=1874204&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-livy-nar/1.11.2/org.apache.nifi.controller.livy.LivySessionController/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-livy-nar/1.11.2/org.apache.nifi.controller.livy.LivySessionController/index.html Wed Feb 19 18:04:18 2020 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>LivySessionController</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">LivySessionController</h1><h2>Description: </h2><p>Manages pool of Spark sessions over HTTP</p><h3>Tags: </h3><p>Livy, REST, Spark, http</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr> <tr><td id="name"><strong>Livy Host</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The hostname (or IP address) of the Livy server.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Livy Port</strong></td><td id="default-value">8998</td><td id="allowable-values"></td><td id="description">The port number for the Livy server.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Session Pool Size</strong></td><td id="default-value">2</td><td id="allowable-values"></td><td id="description">Number of sessions to keep open<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Session Type</strong></td><td id="default-value">spark</td><td id="allowable-values"><ul><li>spark</li><li>pysp ark</li><li>pyspark3</li><li>sparkr</li></ul></td><td id="description">The type of Spark session to start (spark, pyspark, pyspark3, sparkr, e.g.)</td></tr><tr><td id="name"><strong>Session Manager Status Interval</strong></td><td id="default-value">2 sec</td><td id="allowable-values"></td><td id="description">The amount of time to wait between requesting session information updates.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">SSL Context Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Implementations: </strong><a href="../../../nifi-ssl-context-service-nar/1.11.2/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</a><br/><a href="../../../nifi-ssl-context-service-nar/1.11.2/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextSe rvice</a></td><td id="description">The SSL Context Service used to provide client certificate information for TLS/SSL (https) connections.</td></tr><tr><td id="name"><strong>Connection Timeout</strong></td><td id="default-value">5 secs</td><td id="allowable-values"></td><td id="description">Max wait time for connection to remote service.</td></tr><tr><td id="name">Session JARs</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">JARs to be used in the Spark session.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Session Files</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Files to be used in the Spark session.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Kerberos Credentials Service</td><td id="default-value"></td><td id="allowable-values"><strong >Controller Service API: ></strong><br/>KerberosCredentialsService<br/><strong>Implementation: ></strong><a >href="../../../nifi-kerberos-credentials-service-nar/1.11.2/org.apache.nifi.kerberos.KeytabCredentialsService/index.html">KeytabCredentialsService</a></td><td > id="description">Specifies the Kerberos Credentials Controller Service that >should be used for authenticating with Kerberos</td></tr></table><h3>State >management: </h3>This component does not store state.<h3>Restricted: ></h3>This component is not restricted.<h3>System Resource >Considerations:</h3>None specified.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-livy-nar/1.11.2/org.apache.nifi.processors.livy.ExecuteSparkInteractive/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-livy-nar/1.11.2/org.apache.nifi.processors.livy.ExecuteSparkInteractive/index.html?rev=1874204&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-livy-nar/1.11.2/org.apache.nifi.processors.livy.ExecuteSparkInteractive/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-livy-nar/1.11.2/org.apache.nifi.processors.livy.ExecuteSparkInteractive/index.html Wed Feb 19 18:04:18 2020 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ExecuteSparkInteractive</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">ExecuteSparkInteractive</h1><h2>Description: </h2><p>Execute Spark Code over a Livy-managed HTTP session to a live Spark context. Supports cached RDD sharing.</p><h3>Tags: </h3><p>spark, livy, http, execute</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Name</th> <th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Livy Controller Service</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>LivySessionService<br/><strong>Implementation: </strong><a href="../org.apache.nifi.controller.livy.LivySessionController/index.html">LivySessionController</a></td><td id="description">The controller service to use for Livy-managed session(s).</td></tr><tr><td id="name">Code</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The code to execute in the session. This property can be empty, a constant value, or built from attributes using Expression Language. If this property is specified, it will be used regardless of the content of incoming flowfiles. If this property is empty, the content of the incoming flow file is expected to contain valid code to be issued by the processor to the session. Note that Expression Langua ge is not evaluated for flow file contents.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Character Set</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">The character set encoding for the incoming flow file.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Status Check Interval</strong></td><td id="default-value">1 sec</td><td id="allowable-values"></td><td id="description">The amount of time to wait between checking the status of an operation.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>FlowFiles that a re successfully processed are sent to this relationship</td></tr><tr><td>wait</td><td>FlowFiles that are waiting on an available Spark session will be sent to this relationship</td></tr><tr><td>failure</td><td>FlowFiles are routed to this relationship when they cannot be parsed</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.2/org.apache.nifi.lookup.CSVRecordLookupService/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.2/org.apache.nifi.lookup.CSVRecordLookupService/index.html?rev=1874204&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.2/org.apache.nifi.lookup.CSVRecordLookupService/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.2/org.apache.nifi.lookup.CSVRecordLookupService/index.html Wed Feb 19 18:04:18 2020 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>CSVRecordLookupService</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">CSVRecordLookupService</h1><h2>Description: </h2><p>A reloadable CSV file-based lookup service. When the lookup key is found in the CSV file, the columns are returned as a Record. All returned fields will be strings.</p><h3>Tags: </h3><p>lookup, cache, enrich, join, csv, reloadable, key, value, record</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../../../../html/expression -language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>CSV File</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A CSV file that will serve as the data source.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>CSV Format</strong></td><td id="default-value">Default</td><td id="allowable-values"><ul><li>Excel</li><li>MySQL</li><li>TDF</li><li>PostgreSQLCsv</li><li>InformixUnloadCsv</li><li>Oracle</li><li>Default</li><li>RFC4180</li><li>InformixUnload</li><li>PostgreSQLText</li></ul></td><td id="description">Specifies which "format" the CSV data is in.</td></tr><tr><td id="name"><strong>Character Set</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">The Character Encoding that is used to decode the CSV file.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Lookup Key Column</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The field in the CSV file that will serve as the lookup key. This is the field that will be matched against the property specified in the lookup processor.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Ignore Duplicates</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Ignore duplicate keys for records in the CSV file.</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>System Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.2/org.apache.nifi.lookup.DistributedMapCacheLookupService/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.2/org.apache.nifi.lookup.DistributedMapCacheLookupService/index.html?rev=1874204&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.2/org.apache.nifi.lookup.DistributedMapCacheLookupService/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.2/org.apache.nifi.lookup.DistributedMapCacheLookupService/index.html Wed Feb 19 18:04:18 2020 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>DistributedMapCacheLookupService</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">DistributedMapCacheLookupService</h1><h2>Description: </h2><p>Allows to choose a distributed map cache client to retrieve the value associated to a key. The coordinates that are passed to the lookup must contain the key 'key'.</p><h3>Tags: </h3><p>lookup, enrich, key, value, map, cache, distributed</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th >Allowable Values</th><th>Description</th></tr><tr><td >id="name"><strong>Distributed Cache Service</strong></td><td >id="default-value"></td><td id="allowable-values"><strong>Controller Service >API: </strong><br/>DistributedMapCacheClient<br/><strong>Implementations: ></strong><a >href="../../../nifi-hbase_2-client-service-nar/1.11.2/org.apache.nifi.hbase.HBase_2_ClientMapCacheService/index.html">HBase_2_ClientMapCacheService</a><br/><a > >href="../../../nifi-redis-nar/1.11.2/org.apache.nifi.redis.service.RedisDistributedMapCacheClientService/index.html">RedisDistributedMapCacheClientService</a><br/><a > >href="../../../nifi-distributed-cache-services-nar/1.11.2/org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService/index.html">DistributedMapCacheClientService</a><br/><a > >href="../../../nifi-couchbase-nar/1.11.2/org.apache.nifi.couchbase.CouchbaseMapCacheClient/index.html">CouchbaseMapCacheClient</a><br/><a > href="../../../nifi-hbase_1_1_2-client-service-nar/1.11.2/org.apach e.nifi.hbase.HBase_1_1_2_ClientMapCacheService/index.html">HBase_1_1_2_ClientMapCacheService</a></td><td id="description">The Controller Service that is used to get the cached values.</td></tr><tr><td id="name"><strong>Character Encoding</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"><ul><li>ISO-8859-1</li><li>UTF-8</li><li>UTF-16</li><li>UTF-16LE</li><li>UTF-16BE</li><li>US-ASCII</li></ul></td><td id="description">Specifies a character encoding to use.</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>System Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.2/org.apache.nifi.lookup.PropertiesFileLookupService/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.2/org.apache.nifi.lookup.PropertiesFileLookupService/index.html?rev=1874204&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.2/org.apache.nifi.lookup.PropertiesFileLookupService/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.2/org.apache.nifi.lookup.PropertiesFileLookupService/index.html Wed Feb 19 18:04:18 2020 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PropertiesFileLookupService</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">PropertiesFileLookupService</h1><h2>Description: </h2><p>A reloadable properties file-based lookup service</p><h3>Tags: </h3><p>lookup, cache, enrich, join, properties, reloadable, key, value</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Configuration File</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A configuration file<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>System Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.2/org.apache.nifi.lookup.RestLookupService/additionalDetails.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.2/org.apache.nifi.lookup.RestLookupService/additionalDetails.html?rev=1874204&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.2/org.apache.nifi.lookup.RestLookupService/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.11.2/org.apache.nifi.lookup.RestLookupService/additionalDetails.html Wed Feb 19 18:04:18 2020 @@ -0,0 +1,65 @@ +<!DOCTYPE html> +<html lang="en"> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<head> + <meta charset="utf-8" /> + <title>RestLookupService</title> + <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" /> +</head> +<body> + <h2>General</h2> + <p>This lookup service has the following optional lookup coordinate keys:</p> + <ul> + <li>request.method; defaults to 'get', valid values: + <ul> + <li>delete</li> + <li>get</li> + <li>post</li> + <li>put</li> + </ul> + </li> + <li>body; contains a string representing JSON, XML, etc. to be sent with any + of those methods except for "get".</li> + <li>mime.type; specifies media type of the request body, required when 'body' is passed.</li> + <li>*; any other keys can be configured to pass variables to resolve target URLs. See 'Dynamic URLs' section below.</li> + </ul> + <p>The record reader is used to consume the response of the REST service call and turn it into one or more records. The record path property + is provided to allow for a lookup path to either a nested record or a single point deep in the REST response. Note: a valid schema must be + built that encapsulates the REST response accurately in order for this service to work.</p> + <h2>Headers</h2> + <p>Headers are supported using dynamic properties. Just add a dynamic property and the name will be the header name and the value will be the value for the header. Expression language + powered by input from the variable registry is supported.</p> + <h2>Dynamic URLs</h2> + <p>The URL property supports expression language through the lookup key/value pairs configured on the component using this lookup service (e.g. LookupRecord processor). The configuration specified by the user will be passed + through to the expression language engine for evaluation. Note: flowfile attributes will be disregarded here for this property.</p> + <p>Ex. URL: <em>http://example.com/service/${user.name}/friend/${friend.id}</em>, combined with example record paths at LookupRecord processor:</p> + <ul> + <li>user.name => "/example/username"</li> + <li>friend.id => "/example/first_friend"</li> + </ul> + <p>Would dynamically produce an endpoint of <em>http://example.com/service/john.smith/friend/12345</em></p> + + <h3>Using Variable Registry with URLs</h3> + + <p>In addition to the lookup key/value pairs, Variable Registry can be referred from expression languages configured at the URL property.</p> + <p>Ex. URL: <em>http://${apiServerHostname}:${apiServerPort}/service/${user.name}/friend/${friend.id}</em>, combined with the previous example record paths, and variable registry:</p> + <ul> + <li>apiServerHostname => "test.example.com"</li> + <li>apiServerPort => "8080"</li> + </ul> + <p>Would dynamically produce an endpoint of <em>http://test.example.com:8080/service/john.smith/friend/12345</em></p> +</body> +</html> \ No newline at end of file
