Apache
/
nifi
mirror of https://github.com/apache/nifi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

NIFI-309 Updating additionalDetails.html or removing 

based what is contained in new annotations
This commit is contained in:
danbress 2015-03-06 09:56:44 -05:00
parent ff1ba78b34
commit 68dffdd1d8
30 changed files with 38 additions and 1503 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
nifi/nifi-nar-bundles/nifi-hadoop-bundle/nifi-hdfs-processors/src/main/resources/docs/org.apache.nifi.processors.hadoop.CreateHadoopSequenceFile/additionalDetails.html
View File

@ -42,12 +42,5 @@
</p>
NOTE: The value portion of a key/value pair is loaded into memory. While there is a max size limit of 2GB, this could cause memory
issues if there are too many concurrent tasks and the flow file sizes are large.
<p>
<strong>See Also:</strong>
</p>
<ul>
<li><a href="../org.apache.nifi.processors.hadoop.PutHDFS/index.html">PutHDFS</a></li>
</ul>
</body>
</html>

57
nifi/nifi-nar-bundles/nifi-hadoop-bundle/nifi-hdfs-processors/src/main/resources/docs/org.apache.nifi.processors.hadoop.GetHDFS/additionalDetails.html
View File

@ -1,57 +0,0 @@
<!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>GetHDFS</title>
<link rel="stylesheet" href="../../css/component-usage.css" type="text/css" />
</head>
<body>
<p>
<strong>Modifies Attributes:</strong>
</p>
<table>
<thead>
<tr>
<th>Attribute Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>filename</td>
<td>The name of the file that was read from HDFS.</td>
</tr>
<tr>
<td>path</td>
<td>The path is set to the relative path of the file's directory on HDFS. For example, if the <em>Directory</em>
property is set to <code>/tmp</code>, then files picked up from /tmp will have the path attribute set to
&quot;<code>./</code>&quot;. If the <em>Recurse Subdirectories</em> property is set to <code>true</code>
and a file is picked up from /tmp/abc/1/2/3, then the path attribute will be set to &quot;<code>abc/1/2/3</code>&quot;.
</td>
</tr>
</tbody>
</table>
<p>
<strong>See Also:</strong>
</p>
<ul>
<li><a href="../org.apache.nifi.processors.hadoop.PutHDFS/index.html">PutHDFS</a></li>
</ul>
</body>
</html>

32
nifi/nifi-nar-bundles/nifi-hadoop-bundle/nifi-hdfs-processors/src/main/resources/docs/org.apache.nifi.processors.hadoop.GetHDFSSequenceFile/additionalDetails.html
View File

@ -1,32 +0,0 @@
<!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>GetHDFSSequenceFile</title>
<link rel="stylesheet" href="../../css/component-usage.css" type="text/css" />
</head>
<body>
<p>
<strong>See Also:</strong>
</p>
<ul>
<li><a href="../org.apache.nifi.processors.hadoop.PutHDFS/index.html">PutHDFS</a></li>
</ul>
</body>
</html>

51
nifi/nifi-nar-bundles/nifi-hadoop-bundle/nifi-hdfs-processors/src/main/resources/docs/org.apache.nifi.processors.hadoop.PutHDFS/additionalDetails.html
View File

@ -1,51 +0,0 @@
<!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>PutHDFS</title>
<link rel="stylesheet" href="../../css/component-usage.css" type="text/css" />
</head>
<body>
<p>
<strong>Uses Attributes:</strong>
</p>
<table>
<thead>
<tr>
<th>Attribute Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>filename</td>
<td>The name of the file written to HDFS comes from the value of this attribute.</td>
</tr>
</tbody>
</table>
<p>
<strong>See Also:</strong>
</p>
<ul>
<li><a href="../org.apache.nifi.processors.hadoop.GetHDFS/index.html">GetHDFS</a></li>
</ul>
</body>
</html>

33
nifi/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-processors/src/main/resources/docs/org.apache.nifi.processors.kafka.GetKafka/additionalDetails.html
View File

@ -41,38 +41,5 @@
from multiple Topics, as each Processor will receive a different Processor UUID
and therefore a different Consumer Group Identifier.
</p>
<p>
<strong>Modifies Attributes:</strong>
</p>
<table>
<thead>
<tr>
<th>Attribute Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>kafka.topic</td>
<td>The name of the Kafka Topic from which the message was received</td>
</tr>
<tr>
<td>kafka.key</td>
<td>The key of the Kafka message, if it exists and batch size is 1. If the message does not have a key,
or if the batch size is greater than 1, this attribute will not be added.</td>
</tr>
<tr>
<td>kafka.partition</td>
<td>The partition of the Kafka Topic from which the message was received. This attribute is added only
if the batch size is 1.</td>
</tr>
<tr>
<td>kafka.offset</td>
<td>The offset of the message within the Kafka partition. This attribute is added only
if the batch size is 1.</td>
</tr>
</tbody>
</table>
</body>
</html>

68
nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.CompressContent/additionalDetails.html
View File

@ -1,68 +0,0 @@
<!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>CompressContent</title>
<link rel="stylesheet" href="../../css/component-usage.css" type="text/css" />
</head>
<body>
<!-- Processor Documentation ================================================== -->
<p>
<strong>Uses Attributes:</strong>
</p>
<table>
<thead>
<tr>
<th>Attribute Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>mime.type</td>
<td>If the <code>Compression Format</code> is set to <code>use mime.type attribute</code>,
this attribute is used to determine the compression type. Otherwise, this attribute is ignored.</td>
</tr>
</tbody>
</table>
<p>
<strong>Modifies Attributes:</strong>
</p>
<table>
<thead>
<tr>
<th>Attribute Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>mime.type</td>
<td>If the <code>Mode</code> property is set to <code>compress</code>, the appropriate MIME Type is set. If the
<code>Mode</code> property is set to <code>decompress</code> and the file is successfully decompressed,
this attribute is removed, as the MIME Type is no longer known.
</td>
</tr>
</tbody>
</table>
</body>
</html>

58
nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.DetectDuplicate/additionalDetails.html
View File

@ -1,58 +0,0 @@
<!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>DetectDuplicate</title>
<link rel="stylesheet" href="../../css/component-usage.css" type="text/css" />
</head>
<body>
<p>
<strong>Modifies Attributes:</strong>
</p>
<table>
<thead>
<tr>
<th>Attribute Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>original.flowfile.description</td>
<td>All FlowFiles routed to the <code>duplicate</code>
relationship will have an attribute added named <code>original.flowfile.description</code>.
The value of this attribute is determined by the attributes of the
original copy of the data and by the FlowFile Description property
</td>
</tr>
</tbody>
</table>
<p>
<strong>See Also:</strong>
</p>
<ul>
<li><a href="../org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService/index.html">Distributed Map Cache Client Service</a></li>
<li><a href="../org.apache.nifi.distributed.cache.server.map.DistributedMapCacheServer/index.html">Distributed Map Cache Server</a></li>
</ul>
</body>
</html>

34
nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateXPath/additionalDetails.html
View File

@ -1,34 +0,0 @@
<!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>EvaluateXPath</title>
<link rel="stylesheet" href="../../css/component-usage.css" type="text/css" />
</head>
<body>
<!-- Processor Documentation ================================================== -->
<p>
<strong>Modifies Attributes:</strong>
</p>
<p>
This processor adds user-defined attributes if the &lt;Destination&gt; property is set to
<code>flowfile-attribute</code>.
</p>
</body>
</html>

18
nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateXQuery/additionalDetails.html
View File

@ -27,21 +27,9 @@
<!-- Processor Documentation ================================================== -->
<p>
<strong>Modifies Attributes:</strong>
</p>
<p>
This processor adds user-defined attributes if the &lt;Destination&gt;
property is set to
<code>flowfile-attribute</code>
.
</p>
<p>
<strong>Examples:</strong>
</p>
<p>
<strong>Examples:</strong>
</p>
<p>This processor produces one attribute or FlowFile per
XQueryResult. If only one attribute or FlowFile is desired, the

57
nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ExecuteStreamCommand/additionalDetails.html
View File

@ -1,57 +0,0 @@
<!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>ExecuteStreamCommand</title>
<link rel="stylesheet" href="../../css/component-usage.css" type="text/css" />
</head>
<body>
<!-- Processor Documentation ================================================== -->
<p>
<strong>Creates Attributes:</strong>
</p>
<table>
<thead>
<tr>
<th>Attribute Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>execution.command</td>
<td>The name of the command executed to create the new FlowFile</td>
</tr>
<tr>
<td>execution.command.args</td>
<td>The semi-colon delimited list of arguments</td>
</tr>
<tr>
<td>execution.status</td>
<td>The exit status code returned from executing the command</td>
</tr>
<tr>
<td>execution.error</td>
<td>Any error messages returned from executing the command</td>
</tr>
</tbody>
</table>
</body>
</html>

74
nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetFTP/additionalDetails.html
View File

@ -1,74 +0,0 @@
<!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>GetFTP</title>
<link rel="stylesheet" href="../../css/component-usage.css" type="text/css" />
</head>
<body>
<!-- Processor Documentation ================================================== -->
<p>
<strong>Modifies Attributes:</strong>
</p>
<table>
<thead>
<tr>
<th>Attribute Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>filename</td>
<td>The filename is set to the name of the file on the remote server</td>
</tr>
<tr>
<td>path</td>
<td>The path is set to the path of the file's
directory on the remote server. For example, if the &lt;Remote Path&gt;
property is set to <code>/tmp</code>, files picked up from /tmp
will have the path attribute set to <code>/tmp</code>. If the
&lt;Search Recursively&gt; property is set to <code>true</code>
and a file is picked up from /tmp/abc/1/2/3, then the path
attribute will be set to <code>/tmp/abc/1/2/3</code></td>
</tr>
<tr>
<td>file.lastModifiedTime</td>
<td>The date and time that the source file was last modified.</td>
</tr>
<tr>
<td>file.owner</td>
<td>The numeric owner id of the source file.</td>
</tr>
<tr>
<td>file.group</td>
<td>The numeric group id of the source file.</td>
</tr>
<tr>
<td>file.permissions</td>
<td>The read/write/execute permissions of the source file.</td>
</tr>
<tr>
<td>absolute.path</td>
<td>The full/absolute path from where a file was picked up. The current 'path' attribute is still populated, but may be a relative path.</td>
</tr>
</tbody>
</table>
</body>
</html>

79
nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetFile/additionalDetails.html
View File

@ -1,79 +0,0 @@
<!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>GetFile</title>
<link rel="stylesheet" href="../../css/component-usage.css" type="text/css" />
</head>
<body>
<!-- Processor Documentation ================================================== -->
<p>
<strong>Modifies Attributes:</strong>
</p>
<table>
<thead>
<tr>
<th>Attribute Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>filename</td>
<td>The filename is set to the name of the file on disk</td>
</tr>
<tr>
<td>path</td>
<td>The path is set to the relative path of the file's directory on disk. For example, if the &lt;Input Directory&gt;
property is set to <code>/tmp</code>, files picked up from /tmp will have the path attribute set to <code>./</code>.
If the &lt;Recurse Subdirectories&gt; property is set to <code>true</code> and a file is picked up
from /tmp/abc/1/2/3, then the path attribute will be set to <code>abc/1/2/3</code>
</tr>
<tr>
<td>file.creationTime</td>
<td>The date and time that the file was created. May not work on all file systems</td>
</tr>
<tr>
<td>file.lastModifiedTime</td>
<td>The date and time that the file was last modified. May not work on all file systems</td>
</tr>
<tr>
<td>file.lastAccessTime</td>
<td>The date and time that the file was last accessed. May not work on all file systems</td>
</tr>
<tr>
<td>file.owner</td>
<td>The owner of the file. May not work on all file systems</td>
</tr>
<tr>
<td>file.group</td>
<td>The group owner of the file. May not work on all file systems</td>
</tr>
<tr>
<td>file.permissions</td>
<td>The read/write/execute permissions of the file. May not work on all file systems</td>
</tr>
<tr>
<td>absolute.path</td>
<td>The full/absolute path from where a file was picked up. The current 'path' attribute is still populated, but may be a relative path.</td>
</tr>
</tbody>
</table>
</body>
</html>

45
nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetHTTP/additionalDetails.html
View File

@ -1,45 +0,0 @@
<!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>GetHTTP</title>
<link rel="stylesheet" href="../../css/component-usage.css" type="text/css" />
</head>
<body>
<!-- Processor Documentation ================================================== -->
<h2>Description:</h2>
<p>
<strong>Modifies Attributes:</strong>
</p>
<table>
<thead>
<tr>
<th>Attribute Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>filename</td>
<td>The filename is set to the name of the file on the remote server</td>
</tr>
</tbody>
</table>
</body>
</html>

80
nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetSFTP/additionalDetails.html
View File

@ -1,80 +0,0 @@
<!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>GetSFTP</title>
<link rel="stylesheet" href="../../css/component-usage.css" type="text/css" />
</head>
<body>
<!-- Processor Documentation ================================================== -->
<p>
<strong>Modifies Attributes:</strong>
</p>
<table>
<thead>
<tr>
<th>Attribute Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>filename</td>
<td>The filename is set to the name of the file on the remote server</td>
</tr>
<tr>
<td>path</td>
<td>The path is set to the path of the file's
directory on the remote server. For example, if the &lt;Remote Path&gt;
property is set to <code>/tmp</code>, files picked up from /tmp
will have the path attribute set to <code>/tmp</code>. If the
&lt;Search Recursively&gt; property is set to <code>true</code>
and a file is picked up from /tmp/abc/1/2/3, then the path
attribute will be set to <code>/tmp/abc/1/2/3</code></td>
</tr>
<tr>
<td>file.lastModifiedTime</td>
<td>The date and time that the source file was last modified.</td>
</tr>
<tr>
<td>file.owner</td>
<td>The numeric owner id of the source file.</td>
</tr>
<tr>
<td>file.group</td>
<td>The numeric group id of the source file.</td>
</tr>
<tr>
<td>file.permissions</td>
<td>The read/write/execute permissions of the source file.</td>
</tr>
<tr>
<td>absolute.path</td>
<td>The full/absolute path from where a file was picked up. The current 'path' attribute is still populated, but may be a relative path.</td>
</tr>
</tbody>
</table>
<p>
<strong>See Also:</strong>
<ul>
<li><a href="../org.apache.nifi.processors.standard.PutSFTP/index.html">PutSFTP</a></li>
</ul>
</body>
</html>

35
nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.HashAttribute/additionalDetails.html
View File

@ -1,35 +0,0 @@
<!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>HashAttribute</title>
<link rel="stylesheet" href="../../css/component-usage.css" type="text/css" />
</head>
<body>
<!-- Processor Documentation ================================================== -->
<p>
<strong>Modifies Attributes:</strong>
</p>
<p>
This Processor adds an attribute whose value is the result of Hashing the existing FlowFile attributes.
The name of this attribute is specified by the &lt;Hash Value Attribute Key&gt; property.
</p>
</body>
</html>

35
nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.HashContent/additionalDetails.html
View File

@ -1,35 +0,0 @@
<!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>HashContent</title>
<link rel="stylesheet" href="../../css/component-usage.css" type="text/css" />
</head>
<body>
<!-- Processor Documentation ================================================== -->
<p>
<strong>Modifies Attributes:</strong>
</p>
<p>
This Processor adds an attribute whose value is the result of Hashing the existing FlowFile attributes.
The name of this attribute is specified by the &lt;Hash Attribute Name&gt; property.
</p>
</body>
</html>

51
nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.IdentifyMimeType/additionalDetails.html
View File

@ -25,20 +25,39 @@
<p>
<strong>Modifies Attributes:</strong>
</p>
<table>
<thead>
<tr>
<th>Attribute Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>mime.type</td>
<td>This Processor sets the FlowFile's mime.type attribute to the detected MIME Type. If unable to detect
the MIME Type, the attribute's value will be set to <code>application/octet-stream</code>.</td>
</tr>
</tbody>
</table>
</body>
<p>The following MIME Types are detected:
</p>
<ul>
<li>application/gzip</li>
<li>application/bzip2</li>
<li>application/flowfile-v3</li>
<li>application/flowfile-v1 (requires Identify TAR be set to true)</li>
<li>application/xml</li>
<li>video/mp4</li>
<li>video/x-m4v</li>
<li>video/mp4a-latm</li>
<li>video/quicktime</li>
<li>video/mpeg</li>
<li>audio/wav</li>
<li>audio/mp3</li>
<li>image/bmp</li>
<li>image/png</li>
<li>image/jpg</li>
<li>image/gif</li>
<li>image/tif</li>
<li>application/vnd.ms-works</li>
<li>application/msexcel</li>
<li>application/mspowerpoint</li>
<li>application/msaccess</li>
<li>application/x-ms-wmv</li>
<li>application/pdf</li>
<li>application/x-rpm</li>
<li>application/tar</li>
<li>application/x-7z-compressed</li>
<li>application/java-archive</li>
<li>application/zip</li>
<li>application/x-lzh</li>
</ul>
</body>
</html>

64
nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.InvokeHTTP/additionalDetails.html
View File

@ -1,64 +0,0 @@
<!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>InvokeHTTP - a swiss army http client processor</title>
<link rel="stylesheet" href="../../css/component-usage.css" type="text/css" />
</head>
<body>
<p>
<strong>Adds Attributes:</strong>
</p>
<table>
<thead>
<tr>
<th>Attribute Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>invokehttp.status.code</td>
<td>The status code that is returned.</td>
</tr>
<tr>
<td>invokehttp.status.message</td>
<td>The status message that is returned.</td>
</tr>
<tr>
<td>invokehttp.response.body</td>
<td>The response body.</td>
</tr>
<tr>
<td>invokehttp.request.url</td>
<td>The request URL.</td>
</tr>
<tr>
<td>invokehttp.tx.id</td>
<td>The transaction ID that is returned after reading the response.</td>
</tr>
<tr>
<td>invokehttp.remote.dn</td>
<td>The DN of the remote server.</td>
</tr>
</tbody>
</table>
</body>
</html>

115
nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.MergeContent/additionalDetails.html
View File

@ -1,115 +0,0 @@
<!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>MergeContent</title>
<link rel="stylesheet" href="../../css/component-usage.css" type="text/css" />
</head>
<body>
<!-- Processor Documentation ================================================== -->
<p>
<strong>Uses Attributes:</strong>
</p>
<table>
<thead>
<tr>
<th>Attribute Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>fragment.identifier</td>
<td>Applicable only if the &lt;Merge Strategy&gt; property is set to <code>Defragment</code>.
All FlowFiles with the same value for this attribute will be bundled together.
</td>
</tr>
<tr>
<td>fragment.index</td>
<td>Applicable only if the &lt;Merge Strategy&gt; property is set to <code>Defragment</code>.
This attribute must be present on all FlowFiles with the same value for the <code>fragment.identifier</code>
attribute and must be a unique integer between 0 and the value of the <code>fragment.count</code> attribute.
This attribute indicates the order in which the fragments should be assembled.
</td>
</tr>
<tr>
<td>fragment.count</td>
<td>Applicable only if the &lt;Merge Strategy&gt; property is set to <code>Defragment</code>.
This attribute must be present on all FlowFiles with the same value for the <code>fragment.identifier</code>
attribute. All FlowFiles in the same bundle must have the same value for this attribute. The value of
this attribute indicates how many FlowFiles should be expected in the given bundle.
</td>
</tr>
<tr>
<td>segment.original.filename</td>
<td>Applicable only if the &lt;Merge Strategy&gt; property is set to <code>Defragment</code>.
This attribute must be present on all FlowFiles with the same value for the <code>fragment.identifier</code>
attribute. All FlowFiles in the same bundle must have the same value for this attribute. The value of
this attribute will be used for the filename of the completed merged FlowFile.
</td>
</tr>
<tr>
<td>tar.permissions</td>
<td>Applicable only if the &lt;Merge Format&gt; property is set to <code>TAR</code>.
The value of this attribute must be 3 characters; each character must be in the range 0 to 7 (inclusive)
and indicates the file permissions that should be used for the FlowFile's TAR entry. If this attribute
is missing or has an invalid value, the default value of 644 will be used.
</td>
</tr>
</tbody>
</table>
<p>
<strong>Modifies Attributes:</strong>
</p>
<table>
<thead>
<tr>
<th>Attribute Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>filename</td>
<td>When more than 1 file is merged, the filename comes from the segment.original.filename attribute.
If that attribute does not exist in the source FlowFiles, then the filename is set to the number of
nanoseconds matching system time. Then a filename extension may be applied:
<ul>
<li>if Merge Format is TAR, then the filename will be appended with .tar</li>
<li>if Merge Format is ZIP, then the filename will be appended with .zip</li>
<li>if Merge Format is FlowFileStream, then the filename will be appended with .pkg</li>
</ul>
</td>
</tr>
<tr>
<td>merge.count</td>
<td>The number of FlowFiles that were merged into this bundle.</td>
</tr>
<tr>
<td>merge.bin.age</td>
<td>The age of the bin, in milliseconds, when it was merged and output. Effectively this is the
greatest amount of time that any FlowFile in this bundle remained waiting in this processor before it
was output.</td>
</tr>
</tbody>
</table>
</body>
</html>

49
nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.MonitorActivity/additionalDetails.html
View File

@ -1,49 +0,0 @@
<!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>MonitorActivity</title>
<link rel="stylesheet" href="../../css/component-usage.css" type="text/css" />
</head>
<body>
<!-- Processor Documentation ================================================== -->
<p>
<strong>Modifies Attributes:</strong>
</p>
<table>
<thead>
<tr>
<th>Attribute Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>inactivityStartMillis</td>
<td>The time at which Inactivity began, in the form of milliseconds since Epoch.</td>
</tr>
<tr>
<td>inactivityDurationMillis</td>
<td>The number of milliseconds that the inactivity has spanned.</td>
</tr>
</tbody>
</table>
</body>
</html>

48
nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PostHTTP/additionalDetails.html
View File

@ -1,48 +0,0 @@
<!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>PostHTTP</title>
<link rel="stylesheet" href="../../css/component-usage.css" type="text/css" />
</head>
<body>
<!-- Processor Documentation ================================================== -->
<p>
<strong>Uses Attributes:</strong>
</p>
<table>
<thead>
<tr>
<th>Attribute Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>mime.type</td>
<td>If not sending data as a FlowFile, the mime.type attribute will be used to set the HTTP Header for <code>Content-Type</code>.</td>
</tr>
</tbody>
</table>
</body>
</html>

34
nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PutSFTP/additionalDetails.html
View File

@ -1,34 +0,0 @@
<!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>PutSFTP</title>
<link rel="stylesheet" href="../../css/component-usage.css" type="text/css" />
</head>
<body>
<!-- Processor Documentation ================================================== -->
<p>
<strong>See Also:</strong>
</p>
<ul>
<li>
<a href="../org.apache.nifi.processors.standard.GetSFTP/index.html">GetSFTP</a>
</li>
</ul>
</body>
</html>

45
nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ScanContent/additionalDetails.html
View File

@ -1,45 +0,0 @@
<!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>ScanContent</title>
<link rel="stylesheet" href="../../css/component-usage.css" type="text/css" />
</head>
<body>
<!-- Processor Documentation ================================================== -->
<p>
<strong>Modifies Attributes:</strong>
</p>
<table>
<thead>
<tr>
<th>Attribute Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>matching.term</td>
<td>The term that caused the Processor to route the FlowFile to the 'matched' relationship; if FlowFile is routed to the 'unmatched' relationship, this attribute is not added.</td>
</tr>
</tbody>
</table>
</body>
</html>

82
nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SegmentContent/additionalDetails.html
View File

@ -1,82 +0,0 @@
<!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>SegmentContent</title>
<link rel="stylesheet" href="../../css/component-usage.css" type="text/css" />
</head>
<body>
<!-- Processor Documentation ================================================== -->
<p>
<strong>Adds or Modifies Attributes:</strong>
</p>
<table>
<thead>
<tr>
<th>Attribute Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>segment.identifier</td>
<td>All segments produced from the same parent FlowFile will have the same randomly generated UUID added for this attribute. This attribute is added to maintain backward compatibility, but the fragment.identifier is preferred, as it is designed to work in conjunction with the MergeContent Processor.</td>
</tr>
<tr>
<td>segment.index</td>
<td>A one-up number that indicates the ordering of the segments that were created from a single parent FlowFile. This attribute is added to maintain backward compatibility, but the fragment.index is preferred, as it is designed to work in conjunction with the MergeContent Processor.</td>
</tr>
<tr>
<td>segment.count</td>
<td>The number of segments generated from the parent FlowFile. This attribute is added to maintain backward compatibility, but the fragment.count is preferred, as it is designed to work in conjunction with the MergeContent Processor.</td>
</tr>
<tr>
<td>fragment.identifier</td>
<td>All segments 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 segments that were created from a single parent FlowFile.</td>
</tr>
<tr>
<td>fragment.count</td>
<td>The number of segments generated from the parent FlowFile.</td>
</tr>
<tr>
<td>segment.original.filename</td>
<td>The filename of the parent FlowFile</td>
</tr>
<tr>
<td>filename</td>
<td>The filename will be updated to include the parent's filename, the segment index, and the segment count.</td>
</tr>
</tbody>
</table>
<p>
<strong>See Also:</strong>
</p>
<ul>
<li><a href="../org.apache.nifi.processors.standard.MergeContent/index.html">MergeContent</a> - can defragment FlowFiles
that have been segmented.</li>
</ul>
</body>
</html>

67
nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SplitContent/additionalDetails.html
View File

@ -1,67 +0,0 @@
<!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>SplitContent</title>
<link rel="stylesheet" href="../../css/component-usage.css" type="text/css" />
</head>
<body>
<!-- Processor Documentation ================================================== -->
<p>
<strong>Modifies Attributes:</strong>
</p>
<table>
<thead>
<tr>
<th>Attribute Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<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>
</tbody>
</table>
<p>
<strong>See Also:</strong>
</p>
<ul>
<li><a href="../org.apache.nifi.processors.standard.MergeContent/index.html">MergeContent</a> - can defragment FlowFiles
that have been split if <em>Keep Byte Sequence</em> is set to true.</li>
</ul>
</body>
</html>

72
nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SplitText/additionalDetails.html
View File

@ -1,72 +0,0 @@
<!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>SplitText</title>
<link rel="stylesheet" href="../../css/component-usage.css" type="text/css" />
</head>
<body>
<!-- Processor Documentation ================================================== -->
<p>
<strong>Modifies Attributes:</strong>
</p>
<table>
<thead>
<tr>
<th>Attribute Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>text.line.count</td>
<td>The number of lines of text from the original FlowFile that were copied to this FlowFile.</td>
</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>
</tbody>
</table>
<p>
<strong>See Also:</strong>
</p>
<ul>
<li><a href="../org.apache.nifi.processors.standard.MergeContent/index.html">MergeContent</a> - can defragment FlowFiles
that have been split if <em>Remove Trailing Newlines</em> is set to false and <em>Header Line Count</em> is set to 0.</li>
</ul>
</body>
</html>

106
nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.UnpackContent/additionalDetails.html
View File

@ -1,106 +0,0 @@
<!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>UnpackContent</title>
<link rel="stylesheet" href="../../css/component-usage.css" type="text/css" />
</head>
<body>
<!-- Processor Documentation ================================================== -->
<p>
<strong>Uses Attributes:</strong>
</p>
<table>
<thead>
<tr>
<th>Attribute Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>mime.type</td>
<td>
If the &lt;Packaging Format&gt; property is set to <code>use mime.type attribute</code>,
this attribute is used to determine the FlowFile's MIME Type.
In this case, if the attribute is set to <code>application/tar</code>, the TAR Packaging Format will be used.
If the attribute is set to <code>application/zip</code>, the ZIP Packaging Format will be used.
If the attribute is set to <code>application/flowfile-v3</code> or <code>application/flowfile-v2</code> or <code>application/flowfile-v1</code>,
the appropriate FlowFile Packaging Format will be used.
If this attribute is missing, the FlowFile will be routed to 'failure'.
Otherwise, if the attribute's value is not one of those mentioned above, the FlowFile will be
routed to 'success' without being unpacked.
</td>
</tr>
</tbody>
</table>
<p>
<strong>Modifies Attributes:</strong>
</p>
<table>
<thead>
<tr>
<th>Attribute Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>mime.type</td>
<td>
If the FlowFile is successfully unpacked, its MIME Type is no longer known, so the
mime.type attribute is set to <code>application/octet-stream</code>.
</td>
</tr>
<tr>
<td>fragment.identifier</td>
<td>All unpacked 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 unpacked FlowFiles that were created from a
single parent FlowFile.</td>
</tr>
<tr>
<td>fragment.count</td>
<td>The number of unpacked FlowFiles generated from the parent FlowFile.</td>
</tr>
<tr>
<td>segment.original.filename</td>
<td>The filename of the parent FlowFile. Extensions of .tar, .zip or .pkg are removed because the <a
href="../org.apache.nifi.processors.standard.MergeContent/index.html">MergeContent</a> processor automatically adds
those extensions if it is used to rebuild the original FlowFile.
</td>
</tr>
</tbody>
</table>
<p>
<strong>See Also:</strong>
</p>
<ul>
<li><a href="../org.apache.nifi.processors.standard.MergeContent/index.html">MergeContent</a> - can repackage FlowFiles
that have been unpacked.</li>
</ul>
</body>
</html>

7
nifi/nifi-nar-bundles/nifi-standard-services/nifi-distributed-cache-services-bundle/nifi-distributed-cache-client-service/src/main/resources/docs/org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService/additionalDetails.html
View File

@ -41,12 +41,5 @@
&lt;/service&gt;
&lt;/services&gt;
</pre>
<i>See Also:</i>
<ul>
<li><a href="../org.apache.nifi.distributed.cache.server.map.DistributedMapCacheServer/index.html">Distributed Map Cache Server</a></li>
<li><a href="../org.apache.nifi.ssl.StandardSSLContextService/index.html">Standard SSL Context Service</a></li>
</ul>
</body>
</html>

31
nifi/nifi-nar-bundles/nifi-standard-services/nifi-distributed-cache-services-bundle/nifi-distributed-cache-client-service/src/main/resources/docs/org.apache.nifi.distributed.cache.client.DistributedSetCacheClientService/additionalDetails.html
View File

@ -1,31 +0,0 @@
<!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>Distributed Map Cache Client Service</title>
<link rel="stylesheet" href="../../css/component-usage.css" type="text/css" />
</head>
<body>
<i>See Also:</i>
<ul>
<li><a href="../org.apache.nifi.distributed.cache.server.map.DistributedMapCacheServer/index.html">Distributed Map Cache Server</a></li>
<li><a href="../org.apache.nifi.ssl.StandardSSLContextService/index.html">Standard SSL Context Service</a></li>
</ul>
</body>
</html>

7
nifi/nifi-nar-bundles/nifi-standard-services/nifi-distributed-cache-services-bundle/nifi-distributed-cache-server/src/main/resources/docs/org.apache.nifi.distributed.cache.server.map.DistributedMapCacheServer/additionalDetails.html
View File

@ -42,12 +42,5 @@
&lt;/service&gt;
&lt;/services&gt;
</pre>
<i>See Also:</i>
<ul>
<li><a href="../org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService/index.html">Distributed Map Cache Client Service</a></li>
<li><a href="../org.apache.nifi.ssl.StandardSSLContextService/index.html">Standard SSL Context Service</a></li>
</ul>
</body>
</html>