[FLINK-20312] The documentation is incomplete

• Type: Improvement
• Status: Reopened
• Priority: Not a Priority
• Resolution: Unresolved
• Affects Version/s: 1.11.0
• Component/s: API / DataStream, Documentation
• Labels: documentation pull-request-available
• Assignee: Unassigned
• Reporter: sxb
• Created: 24/Nov/20 03:57
• Updated: 20/Feb/24 14:50

Description

In this document, Under Triggers, TriggerResult's action is incomplete

 The description of PURGE is missing after and，As follows.

 

1) The first three decide how to act on their invocation event by returning a TriggerResult. The action can be one of the following:

• CONTINUE: do nothing,
• FIRE: trigger the computation,
• PURGE: clear the elements in the window, and
• FIRE_AND_PURGE: trigger the computation and clear the elements in the window afterwards.

 

Description in the source code

/**

• All elements in the window are cleared and the window is discarded,
• without evaluating the window function or emitting any elements.
  */
  PURGE(false, true);

Issue Links

• links to: GitHub Pull Request #24349