org.apache.beam.sdk.transforms.windowing

Class IntervalWindow

java.lang.Object

org.apache.beam.sdk.transforms.windowing.BoundedWindow

org.apache.beam.sdk.transforms.windowing.IntervalWindow

All Implemented Interfaces:

java.lang.Comparable<IntervalWindow>

public class IntervalWindow
extends BoundedWindow
implements java.lang.Comparable<IntervalWindow>

An implementation of BoundedWindow that represents an interval from start (inclusive) to end (exclusive).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IntervalWindow.IntervalWindowCoder Encodes an IntervalWindow as a pair of its upper bound and duration.

Field Summary

Fields inherited from class org.apache.beam.sdk.transforms.windowing.BoundedWindow

TIMESTAMP_MAX_VALUE, TIMESTAMP_MIN_VALUE

Constructor Summary

Constructors

Constructor and Description
IntervalWindow(Instant start, Instant end) Creates a new IntervalWindow that represents the half-open time interval [start, end).
IntervalWindow(Instant start, ReadableDuration size)

Method Summary

Modifier and Type	Method and Description
int	compareTo(IntervalWindow o)
boolean	contains(IntervalWindow other) Returns whether this window contains the given window.
Instant	end() Returns the end of this window, exclusive.
boolean	equals(@Nullable java.lang.Object o)
static Coder<IntervalWindow>	getCoder() Returns a Coder suitable for IntervalWindow.
int	hashCode()
boolean	intersects(IntervalWindow other) Returns whether this window intersects the given window.
boolean	isDisjoint(IntervalWindow other) Returns whether this window is disjoint from the given window.
Instant	maxTimestamp() Returns the largest timestamp that can be included in this window.
IntervalWindow	span(IntervalWindow other) Returns the minimal window that includes both this window and the given window.
Instant	start() Returns the start of this window, inclusive.
java.lang.String	toString()

Methods inherited from class org.apache.beam.sdk.transforms.windowing.BoundedWindow

formatTimestamp, validateTimestampBounds

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IntervalWindow

public IntervalWindow(Instant start,
                      Instant end)

Creates a new IntervalWindow that represents the half-open time interval [start, end).

IntervalWindow

public IntervalWindow(Instant start,
                      ReadableDuration size)

Method Detail

start

public Instant start()

Returns the start of this window, inclusive.

end

public Instant end()

Returns the end of this window, exclusive.

maxTimestamp

public Instant maxTimestamp()

Returns the largest timestamp that can be included in this window.

Specified by:

maxTimestamp in class BoundedWindow

contains

public boolean contains(IntervalWindow other)

Returns whether this window contains the given window.

isDisjoint

public boolean isDisjoint(IntervalWindow other)

Returns whether this window is disjoint from the given window.

intersects

public boolean intersects(IntervalWindow other)

Returns whether this window intersects the given window.

span

public IntervalWindow span(IntervalWindow other)

Returns the minimal window that includes both this window and the given window.

equals

public boolean equals(@Nullable java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(IntervalWindow o)

Specified by:

compareTo in interface java.lang.Comparable<IntervalWindow>

getCoder

public static Coder<IntervalWindow> getCoder()

Returns a Coder suitable for IntervalWindow.