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

NIFI-13697 Clarify documentation in ProcessSession regarding StateManager interactions 

Signed-off-by: Pierre Villard <pierre.villard.fr@gmail.com>

This closes #9223.
This commit is contained in:
EndzeitBegins 2024-08-31 20:33:42 +02:00 committed by Pierre Villard
parent f92f6f1def
commit 6b78c42928
No known key found for this signature in database
GPG Key ID: F92A93B30C07C6D5
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
nifi-api/src/main/java/org/apache/nifi/processor/ProcessSession.java
View File

@ -848,7 +848,7 @@ public interface ProcessSession {
/**
* Updates the value of the component's state, setting it to given value.
* <p>
* This method does update the remote State Provider immediately but rather caches the value until the session is committed.
* This method does not update the remote State Provider immediately but rather caches the value until the session is committed.
* At that point, it will publish the state to the remote State Provider, if the state is the latest according to the remote State Provider.
*
* @param state the value to change the state to
@ -876,7 +876,7 @@ public interface ProcessSession {
* The oldValue will be compared against the value of the state as it is known to {@code this} {@link ProcessSession}.
* If the Process Session does not currently know the state, it will be fetched from the StateProvider.
* <p>
* This method does update the remote State Provider immediately but rather caches the value until the session is committed.
* This method does not update the remote State Provider immediately but rather caches the value until the session is committed.
* At that point, it will publish the state to the remote State Provider, if the state is the latest according to the remote State Provider.
*
* @param oldValue the value to compare the state's current value against
@ -891,7 +891,7 @@ public interface ProcessSession {
/**
* Clears all keys and values from the component's state.
* <p>
* This method does update the remote State Provider immediately but rather caches the value until the session is committed.
* This method does not update the remote State Provider immediately but rather caches the value until the session is committed.
* At that point, it will publish the state to the remote State Provider, if the state is the latest according to the remote State Provider.
*
* @param scope the {@link Scope} to use for clearing the state