You are viewing a plain text version of this content. The canonical link for it is here.

Posted to issues@nifi.apache.org by GitBox <gi...@apache.org> on 2020/02/21 03:33:56 UTC

[GitHub] [nifi] alopresto opened a new pull request #4066: NIFI-7175 Fixed core attributes formatting in Developer Guide.

alopresto opened a new pull request #4066: NIFI-7175 Fixed core attributes formatting in Developer Guide.
URL: https://github.com/apache/nifi/pull/4066
 
 
   Thank you for submitting a contribution to Apache NiFi.
   
   Please provide a short description of the PR here:
   
   #### Description of PR
   
   _Changed some formatting for readability and corrected confusing information about core attributes in Developer Guide._
   
   In order to streamline the review of the contribution we ask you
   to ensure the following steps have been taken:
   
   ### For all changes:
   - [x] Is there a JIRA ticket associated with this PR? Is it referenced 
        in the commit message?
   
   - [x] Does your PR title start with **NIFI-XXXX** where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.
   
   - [x] Has your PR been rebased against the latest commit within the target branch (typically `master`)?
   
   - [x] Is your initial contribution a single, squashed commit? _Additional commits in response to PR reviewer feedback should be made on this branch and pushed to allow change tracking. Do not `squash` or use `--force` when pushing to allow for clean monitoring of changes._
   
   ### For code changes:
   - [ ] Have you ensured that the full suite of tests is executed via `mvn -Pcontrib-check clean install` at the root `nifi` folder?
   - [ ] Have you written or updated unit tests to verify your changes?
   - [ ] Have you verified that the full build is successful on both JDK 8 and JDK 11?
   - [ ] If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under [ASF 2.0](http://www.apache.org/legal/resolved.html#category-a)? 
   - [ ] If applicable, have you updated the `LICENSE` file, including the main `LICENSE` file under `nifi-assembly`?
   - [ ] If applicable, have you updated the `NOTICE` file, including the main `NOTICE` file found under `nifi-assembly`?
   - [ ] If adding new Properties, have you added `.displayName` in addition to .name (programmatic access) for each of the new properties?
   
   ### For documentation related changes:
   - [x] Have you ensured that format looks appropriate for the output in which it is rendered?
   
   ### Note:
   Please ensure that once the PR is submitted, you check travis-ci for build issues and submit an update to your PR as soon as possible.
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [nifi] andrewmlim commented on issue #4066: NIFI-7175 Fixed core attributes formatting in Developer Guide.

Posted by GitBox <gi...@apache.org>.

andrewmlim commented on issue #4066: NIFI-7175 Fixed core attributes formatting in Developer Guide.
URL: https://github.com/apache/nifi/pull/4066#issuecomment-589773202
 
 
   Reviewing...

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [nifi] andrewmlim commented on a change in pull request #4066: NIFI-7175 Fixed core attributes formatting in Developer Guide.

Posted by GitBox <gi...@apache.org>.

andrewmlim commented on a change in pull request #4066: NIFI-7175 Fixed core attributes formatting in Developer Guide.
URL: https://github.com/apache/nifi/pull/4066#discussion_r382741146

##########
File path: nifi-docs/src/main/asciidoc/developer-guide.adoc
##########
@@ -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.
+- Alternative Identifier (`alternate.identifier`): Indicates an identifier other than the FlowFile's UUID that is known to refer to this FlowFile.

Review comment:
Perhaps change "Alternative" to "Alternate" for consistency with the string.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

With regards,
Apache Git Services

[GitHub] [nifi] alopresto merged pull request #4066: NIFI-7175 Fixed core attributes formatting in Developer Guide.

Posted by GitBox <gi...@apache.org>.

alopresto merged pull request #4066: NIFI-7175 Fixed core attributes formatting in Developer Guide.
URL: https://github.com/apache/nifi/pull/4066
 
 
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [nifi] andrewmlim commented on a change in pull request #4066: NIFI-7175 Fixed core attributes formatting in Developer Guide.

Posted by GitBox <gi...@apache.org>.

andrewmlim commented on a change in pull request #4066: NIFI-7175 Fixed core attributes formatting in Developer Guide.
URL: https://github.com/apache/nifi/pull/4066#discussion_r382741455

Review comment:
Everything else LGTM!

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

With regards,
Apache Git Services