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

NIFI-7175 Fixed core attributes formatting in Developer Guide. (#4066) 

* NIFI-7175 Fixed core attributes formatting in Developer Guide.

* NIFI-7175 Made core attribute names more consistent.
This commit is contained in:
Andy LoPresto 2020-02-21 10:41:41 -08:00 committed by GitHub
parent c5c1fa4e85
commit eef04709b9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
nifi-docs/src/main/asciidoc/developer-guide.adoc
View File

@ -127,30 +127,34 @@ can change, the FlowFile object is
immutable. Modifications to a FlowFile are made possible by the ProcessSession.
The core attributes for FlowFiles are defined in the `org.apache.nifi.flowfile.attributes.CoreAttributes` enum.
The most common attributes you'll see are filename, path and uuid. The string in quotes is the value of the
attribute within the `CoreAttributes` enum.
The most common attributes you'll see are `filename`, `path` and `uuid`. The string in parentheses is the value of the
attribute within the `CoreAttributes` enum and how it appears in the UI/API.
- Filename ("filename"): The filename of the FlowFile. The filename should not contain any directory structure.
- Filename (`filename`): The filename of the FlowFile. The filename should not contain any directory structure.
- File Size ("fileSize"): The file size of the FlowFile in bytes.
- UUID (`uuid`): A Universally Unique Identifier assigned to this FlowFile that distinguishes the FlowFile from other FlowFiles in the system.
- UUID ("uuid"): A Universally Unique Identifier assigned to this FlowFile that distinguishes the FlowFile from other FlowFiles in the system.
- Path (`path`): The FlowFile's path indicates the relative directory to which a FlowFile belongs and does not contain the filename.
- Path ("path"): The FlowFile's path indicates the relative directory to which a FlowFile belongs and does not contain the filename.
- Absolute Path (`absolute.path`): The FlowFile's absolute path indicates the absolute directory to which a FlowFile belongs and does not contain the filename.
- Absolute Path ("absolute.path"): The FlowFile's absolute path indicates the absolute directory to which a FlowFile belongs and does not contain the filename.
- Priority (`priority`): A numeric value indicating the FlowFile priority.
- Entry Date ("entryDate"): The date and time at which the FlowFile entered the system (i.e., was created). The value of this attribute is a number that represents the number of milliseconds since midnight, Jan. 1, 1970 (UTC).
- MIME Type (`mime.type`): The MIME Type of this FlowFile.
- Lineage Start Date ("lineageStartDate"): Any time that a FlowFile is cloned, merged, or split, this results in a "child" FlowFile being created. As those children are then cloned, merged, or split, a chain of ancestors is built. This value represents the date and time at which the oldest ancestor entered the system. Another way to think about this is that this attribute represents the latency of the FlowFile through the system. The value is a number that represents the number of milliseconds since midnight, Jan. 1, 1970 (UTC).
- Discard Reason (`discard.reason`): Specifies the reason that a FlowFile is being discarded.
- Priority ("priority"): A numeric value indicating the FlowFile priority.
- Alternate Identifier (`alternate.identifier`): Indicates an identifier other than the FlowFile's UUID that is known to refer to this FlowFile.
- MIME Type ("mime.type"): The MIME Type of this FlowFile.
===== Additional Common Attributes
- Discard Reason ("discard.reason"): Specifies the reason that a FlowFile is being discarded.
While these attributes are not members of the `CoreAttributes` enum, they are de facto standards across the system and found on most FlowFiles.
- Alternative Identifier ("alternate.identifier"): Indicates an identifier other than the FlowFile's UUID that is known to refer to this FlowFile.
- File Size (`fileSize`): The size of the FlowFile content in bytes.
- Entry Date (`entryDate`): The date and time at which the FlowFile entered the system (i.e., was created). The value of this attribute is a number that represents the number of milliseconds since midnight, Jan. 1, 1970 (UTC).
- Lineage Start Date (`lineageStartDate`): Any time that a FlowFile is cloned, merged, or split, this results in a "child" FlowFile being created. As those children are then cloned, merged, or split, a chain of ancestors is built. This value represents the date and time at which the oldest ancestor entered the system. Another way to think about this is that this attribute represents the latency of the FlowFile through the system. The value is a number that represents the number of milliseconds since midnight, Jan. 1, 1970 (UTC).
[[process_session]]
==== ProcessSession