Package org.apache.flink.runtime.asyncprocessing.operators.windowing

Class AsyncWindowOperator.Context

java.lang.Object

org.apache.flink.runtime.asyncprocessing.operators.windowing.AsyncWindowOperator.Context

All Implemented Interfaces:

AsyncTrigger.OnMergeContext, AsyncTrigger.TriggerContext

Enclosing class:

AsyncWindowOperator<K,IN,ACC,OUT,W extends Window>

public class AsyncWindowOperator.Context
extends Object
implements AsyncTrigger.OnMergeContext

Context is a utility for handling AsyncTrigger invocations. It can be reused by setting the key and window fields. No internal state must be kept in the Context

Field Summary

Fields

Modifier and Type	Field	Description
protected DeclaredVariable<W>	window

Constructor Summary

Constructors

Constructor	Description
Context(DeclaredVariable<W> window)

Method Summary

Modifier and Type	Method	Description
org.apache.flink.api.common.state.v2.StateFuture<Void>	clear()
void	deleteEventTimeTimer(long time)	Delete the event-time trigger for the given time.
void	deleteProcessingTimeTimer(long time)	Delete the processing time trigger for the given time.
long	getCurrentProcessingTime()	Returns the current processing time.
long	getCurrentWatermark()	Returns the current watermark time.
org.apache.flink.metrics.MetricGroup	getMetricGroup()	Returns the metric group for this AsyncTrigger.
<T,S extends org.apache.flink.api.common.state.v2.State> S	getPartitionedState(org.apache.flink.api.common.state.v2.StateDescriptor<T> stateDescriptor)	Retrieves a State (v2) object that can be used to interact with fault-tolerant state that is scoped to the window and key of the current trigger invocation.
<T> void	mergePartitionedState(org.apache.flink.api.common.state.v2.StateDescriptor<T> stateDescriptor)
org.apache.flink.api.common.state.v2.StateFuture<TriggerResult>	onElement(StreamRecord<IN> element)
org.apache.flink.api.common.state.v2.StateFuture<TriggerResult>	onEventTime(long time)
void	onMerge(Collection<W> mergedWindows)
org.apache.flink.api.common.state.v2.StateFuture<TriggerResult>	onProcessingTime(long time)
void	registerEventTimeTimer(long time)	Register an event-time callback.
void	registerProcessingTimeTimer(long time)	Register a system time callback.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

window

protected DeclaredVariable<W extends Window> window

Constructor Detail

Context

public Context(DeclaredVariable<W> window)

Method Detail

getMetricGroup

public org.apache.flink.metrics.MetricGroup getMetricGroup()

Description copied from interface: AsyncTrigger.TriggerContext

Returns the metric group for this AsyncTrigger. This is the same metric group that would be returned from RuntimeContext.getMetricGroup() in a user function.

You must not call methods that create metric objects (such as MetricGroup.counter(int) multiple times but instead call once and store the metric object in a field.

Specified by:

getMetricGroup in interface AsyncTrigger.TriggerContext

getCurrentWatermark

public long getCurrentWatermark()

Description copied from interface: AsyncTrigger.TriggerContext

Returns the current watermark time.

Specified by:

getCurrentWatermark in interface AsyncTrigger.TriggerContext

getPartitionedState

public <T,S extends org.apache.flink.api.common.state.v2.State> S getPartitionedState(org.apache.flink.api.common.state.v2.StateDescriptor<T> stateDescriptor)

Description copied from interface: AsyncTrigger.TriggerContext

Retrieves a State (v2) object that can be used to interact with fault-tolerant state that is scoped to the window and key of the current trigger invocation.

Specified by:

getPartitionedState in interface AsyncTrigger.TriggerContext

Type Parameters:

T - The store element of the state.

Parameters:

stateDescriptor - The StateDescriptor that contains the name and type of the state that is being accessed.

Returns:

The partitioned state object.

mergePartitionedState

public <T> void mergePartitionedState(org.apache.flink.api.common.state.v2.StateDescriptor<T> stateDescriptor)

Specified by:

mergePartitionedState in interface AsyncTrigger.OnMergeContext

getCurrentProcessingTime

public long getCurrentProcessingTime()

Description copied from interface: AsyncTrigger.TriggerContext

Returns the current processing time.

Specified by:

getCurrentProcessingTime in interface AsyncTrigger.TriggerContext

registerProcessingTimeTimer

public void registerProcessingTimeTimer(long time)

Description copied from interface: AsyncTrigger.TriggerContext

Register a system time callback. When the current system time passes the specified time AsyncTrigger.onProcessingTime(long, Window, TriggerContext) is called with the time specified here.

Specified by:

registerProcessingTimeTimer in interface AsyncTrigger.TriggerContext

Parameters:

time - The time at which to invoke AsyncTrigger.onProcessingTime(long, Window, TriggerContext)

registerEventTimeTimer

public void registerEventTimeTimer(long time)

Description copied from interface: AsyncTrigger.TriggerContext

Register an event-time callback. When the current watermark passes the specified time AsyncTrigger.onEventTime(long, Window, TriggerContext) is called with the time specified here.

Specified by:

registerEventTimeTimer in interface AsyncTrigger.TriggerContext

Parameters:

time - The watermark at which to invoke AsyncTrigger.onEventTime(long, Window, AsyncTrigger.TriggerContext)

See Also:

Watermark

deleteProcessingTimeTimer

public void deleteProcessingTimeTimer(long time)

Description copied from interface: AsyncTrigger.TriggerContext

Delete the processing time trigger for the given time.

Specified by:

deleteProcessingTimeTimer in interface AsyncTrigger.TriggerContext

deleteEventTimeTimer

public void deleteEventTimeTimer(long time)

Description copied from interface: AsyncTrigger.TriggerContext

Delete the event-time trigger for the given time.

Specified by:

deleteEventTimeTimer in interface AsyncTrigger.TriggerContext

onElement

public org.apache.flink.api.common.state.v2.StateFuture<TriggerResult> onElement(StreamRecord<IN> element)
                                                                          throws Exception

Throws:

Exception

onProcessingTime

public org.apache.flink.api.common.state.v2.StateFuture<TriggerResult> onProcessingTime(long time)
                                                                                 throws Exception

Throws:

Exception

onEventTime

public org.apache.flink.api.common.state.v2.StateFuture<TriggerResult> onEventTime(long time)
                                                                            throws Exception

Throws:

Exception

onMerge

public void onMerge(Collection<W> mergedWindows)
             throws Exception

Throws:

Exception

clear

public org.apache.flink.api.common.state.v2.StateFuture<Void> clear()
                                                             throws Exception

Throws:

Exception

toString

public String toString()

Overrides:

toString in class Object