Skip to content

Commit

Permalink
NIFI-13217 Updated ProcessSession Comments to List Immutable Attributes
Browse files Browse the repository at this point in the history
This closes #8819

Signed-off-by: David Handermann <exceptionfactory@apache.org>
  • Loading branch information
EndzeitBegins authored and exceptionfactory committed May 12, 2024
1 parent 03005aa commit 15696ad
Showing 1 changed file with 4 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -430,7 +430,8 @@ default void commitAsync(Runnable onSuccess) {
/**
* Removes the attribute with the given {@code key} from the given {@link FlowFile}.
* <p>
* If the {@code key} is named {@code uuid}, this method will return the same FlowFile without removing any attribute.
* The attributes with the keys {@code uuid}, {@code path}, and {@code filename} will not be removed.
* If the {@code key} is one of those, this method will return the same FlowFile without removing any attribute.
*
* @param flowFile to update
* @param key of attribute to remove
Expand All @@ -447,7 +448,7 @@ default void commitAsync(Runnable onSuccess) {
/**
* Removes the attributes with the given {@code keys} from the given {@link FlowFile}.
* <p>
* If the set of keys contains the value {@code uuid}, this key will be ignored.
* The attributes with the keys {@code uuid}, {@code path}, and {@code filename} will not be removed.
*
* @param flowFile to update
* @param keys of attributes to remove
Expand All @@ -464,7 +465,7 @@ default void commitAsync(Runnable onSuccess) {
/**
* Removes all attributes from the given {@link FlowFile} whose key matches the given pattern.
* <p>
* If the pattern matches the key {@code uuid}, this key will not be removed.
* The attributes with the keys {@code uuid}, {@code path}, and {@code filename} will not be removed.
*
* @param flowFile to update
* @param keyPattern pattern to match each {@link FlowFile} attribute against; may be null, in which case no attribute is removed
Expand Down

0 comments on commit 15696ad

Please sign in to comment.