Package org.apache.flink.table.runtime.operators.window.groupwindow.operator

Class WindowOperatorBuilder

java.lang.Object

org.apache.flink.table.runtime.operators.window.groupwindow.operator.WindowOperatorBuilder

public class WindowOperatorBuilder
extends Object

The WindowOperatorBuilder is used to build WindowOperator fluently.

Note: You have to call the aggregate method before the last build method.

 WindowOperatorBuilder
   .builder(KeyedStream)
   .tumble(Duration.ofMinutes(1))       // sliding(...), session(...)
   .withEventTime()     // withProcessingTime()
   .withAllowedLateness(Duration.ZERO)
   .produceUpdates()
   .aggregate(AggregationsFunction, accTypes, windowTypes)
   .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WindowOperatorBuilder.AggregateWindowOperatorBuilder	The builder which is used to build AggregateWindowOperator fluently.
static class	WindowOperatorBuilder.TableAggregateWindowOperatorBuilder	The builder which is used to build TableAggregateWindowOperator fluently.

Field Summary

Fields

Modifier and Type	Field	Description
protected LogicalType[]	accumulatorTypes
protected LogicalType[]	aggResultTypes
protected long	allowedLateness
protected int	inputCountIndex
protected LogicalType[]	inputFieldTypes
protected boolean	produceUpdates
protected int	rowtimeIndex
protected ZoneId	shiftTimeZone
protected Trigger<?>	trigger
protected GroupWindowAssigner<?>	windowAssigner
protected LogicalType[]	windowPropertyTypes

Constructor Summary

Constructors

Constructor	Description
WindowOperatorBuilder()

Method Summary

Modifier and Type	Method	Description
WindowOperatorBuilder.AggregateWindowOperatorBuilder	aggregate(GeneratedNamespaceAggsHandleFunction<?> generatedAggregateFunction, GeneratedRecordEqualiser generatedEqualiser, LogicalType[] accumulatorTypes, LogicalType[] aggResultTypes, LogicalType[] windowPropertyTypes)
WindowOperatorBuilder.TableAggregateWindowOperatorBuilder	aggregate(GeneratedNamespaceTableAggsHandleFunction<?> generatedTableAggregateFunction, LogicalType[] accumulatorTypes, LogicalType[] aggResultTypes, LogicalType[] windowPropertyTypes)
WindowOperatorBuilder.AggregateWindowOperatorBuilder	aggregate(NamespaceAggsHandleFunction<?> aggregateFunction, RecordEqualiser equaliser, LogicalType[] accumulatorTypes, LogicalType[] aggResultTypes, LogicalType[] windowPropertyTypes)
WindowOperatorBuilder.TableAggregateWindowOperatorBuilder	aggregate(NamespaceTableAggsHandleFunction<?> tableAggregateFunction, LogicalType[] accumulatorTypes, LogicalType[] aggResultTypes, LogicalType[] windowPropertyTypes)
protected void	aggregate(LogicalType[] accumulatorTypes, LogicalType[] aggResultTypes, LogicalType[] windowPropertyTypes)
WindowOperatorBuilder	assigner(GroupWindowAssigner<?> windowAssigner)
static WindowOperatorBuilder	builder()
WindowOperatorBuilder	countWindow(long size)
WindowOperatorBuilder	countWindow(long size, long slide)
WindowOperatorBuilder	cumulative(Duration size, Duration step)
WindowOperatorBuilder	produceUpdates()
WindowOperatorBuilder	session(Duration sessionGap)
WindowOperatorBuilder	sliding(Duration size, Duration slide)
WindowOperatorBuilder	triggering(Trigger<?> trigger)
WindowOperatorBuilder	tumble(Duration size)
WindowOperatorBuilder	withAllowedLateness(Duration allowedLateness)
WindowOperatorBuilder	withEventTime(int rowtimeIndex)
WindowOperatorBuilder	withInputCountIndex(int inputCountIndex)	The index of COUNT(*) in the aggregates. -1 when the input doesn't * contain COUNT(*), i.e.
WindowOperatorBuilder	withInputFields(LogicalType[] inputFieldTypes)
WindowOperatorBuilder	withProcessingTime()
WindowOperatorBuilder	withShiftTimezone(ZoneId shiftTimeZone)	The shift timezone of the window, if the proctime or rowtime type is TIMESTAMP_LTZ, the shift timezone is the timezone user configured in TableConfig, other cases the timezone is UTC which means never shift when assigning windows.

Methods inherited from class java.lang.Object

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

Field Detail

inputFieldTypes

protected LogicalType[] inputFieldTypes

windowAssigner

protected GroupWindowAssigner<?> windowAssigner

trigger

protected Trigger<?> trigger

accumulatorTypes

protected LogicalType[] accumulatorTypes

aggResultTypes

protected LogicalType[] aggResultTypes

windowPropertyTypes

protected LogicalType[] windowPropertyTypes

allowedLateness

protected long allowedLateness

produceUpdates

protected boolean produceUpdates

rowtimeIndex

protected int rowtimeIndex

shiftTimeZone

protected ZoneId shiftTimeZone

inputCountIndex

protected int inputCountIndex

Constructor Detail

WindowOperatorBuilder

public WindowOperatorBuilder()

Method Detail

builder

public static WindowOperatorBuilder builder()

withInputFields

public WindowOperatorBuilder withInputFields(LogicalType[] inputFieldTypes)

withShiftTimezone

public WindowOperatorBuilder withShiftTimezone(ZoneId shiftTimeZone)

The shift timezone of the window, if the proctime or rowtime type is TIMESTAMP_LTZ, the shift timezone is the timezone user configured in TableConfig, other cases the timezone is UTC which means never shift when assigning windows.

tumble

public WindowOperatorBuilder tumble(Duration size)

sliding

public WindowOperatorBuilder sliding(Duration size,
                                     Duration slide)

cumulative

public WindowOperatorBuilder cumulative(Duration size,
                                        Duration step)

session

public WindowOperatorBuilder session(Duration sessionGap)

countWindow

public WindowOperatorBuilder countWindow(long size)

countWindow

public WindowOperatorBuilder countWindow(long size,
                                         long slide)

assigner

public WindowOperatorBuilder assigner(GroupWindowAssigner<?> windowAssigner)

triggering

public WindowOperatorBuilder triggering(Trigger<?> trigger)

withEventTime

public WindowOperatorBuilder withEventTime(int rowtimeIndex)

withProcessingTime

public WindowOperatorBuilder withProcessingTime()

withAllowedLateness

public WindowOperatorBuilder withAllowedLateness(Duration allowedLateness)

produceUpdates

public WindowOperatorBuilder produceUpdates()

withInputCountIndex

public WindowOperatorBuilder withInputCountIndex(int inputCountIndex)

The index of COUNT(*) in the aggregates. -1 when the input doesn't * contain COUNT(*), i.e. doesn't contain retraction messages. We make sure there is a * COUNT(*) if input stream contains retraction.

aggregate

protected void aggregate(LogicalType[] accumulatorTypes,
                         LogicalType[] aggResultTypes,
                         LogicalType[] windowPropertyTypes)

aggregate

public WindowOperatorBuilder.AggregateWindowOperatorBuilder aggregate(NamespaceAggsHandleFunction<?> aggregateFunction,
                                                                      RecordEqualiser equaliser,
                                                                      LogicalType[] accumulatorTypes,
                                                                      LogicalType[] aggResultTypes,
                                                                      LogicalType[] windowPropertyTypes)

aggregate

public WindowOperatorBuilder.AggregateWindowOperatorBuilder aggregate(GeneratedNamespaceAggsHandleFunction<?> generatedAggregateFunction,
                                                                      GeneratedRecordEqualiser generatedEqualiser,
                                                                      LogicalType[] accumulatorTypes,
                                                                      LogicalType[] aggResultTypes,
                                                                      LogicalType[] windowPropertyTypes)

aggregate

public WindowOperatorBuilder.TableAggregateWindowOperatorBuilder aggregate(NamespaceTableAggsHandleFunction<?> tableAggregateFunction,
                                                                           LogicalType[] accumulatorTypes,
                                                                           LogicalType[] aggResultTypes,
                                                                           LogicalType[] windowPropertyTypes)

aggregate

public WindowOperatorBuilder.TableAggregateWindowOperatorBuilder aggregate(GeneratedNamespaceTableAggsHandleFunction<?> generatedTableAggregateFunction,
                                                                           LogicalType[] accumulatorTypes,
                                                                           LogicalType[] aggResultTypes,
                                                                           LogicalType[] windowPropertyTypes)