com.google.cloud.dataflow.sdk.transforms.windowing

Class PaneInfo

java.lang.Object

com.google.cloud.dataflow.sdk.transforms.windowing.PaneInfo

public final class PaneInfo
extends Object

Provides information about the pane this value belongs to. Every pane is implicitly associated with a window.

Note: This does not uniquely identify a pane, and should not be used for comparisons.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PaneInfo.PaneInfoCoder A Coder for encoding PaneInfo instances.
static class	PaneInfo.Timing Enumerates the possibilities for how the timing of this pane firing related to the watermark.

Field Summary

Fields

Modifier and Type	Field and Description
static PaneInfo	DEFAULT Until an element has been assigned to a window and had triggers processed, it doesn't belong to any pane.
static PaneInfo	ON_TIME_AND_ONLY_FIRING PaneInfo to use when there will be exactly one firing and it is on time.

Method Summary

Modifier and Type	Method and Description
static PaneInfo	createPane(boolean isFirst, boolean isLast, PaneInfo.Timing timing) Factory method to create a PaneInfo with the specified parameters.
static PaneInfo	decodePane(byte encodedPane)
boolean	equals(Object obj)
PaneInfo.Timing	getTiming() Return true if this is the last pane that will be produced in the associated window.
int	hashCode()
boolean	isDefault() Returns true if this pane corresponds to the DEFAULT pane.
boolean	isFirst() Return true if this is the first pane produced for the associated window.
boolean	isLast() Return true if this is the last pane that will be produced in the associated window.
boolean	isUnknown() Return true if there is no timing information for the current PaneInfo.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final PaneInfo DEFAULT

Until an element has been assigned to a window and had triggers processed, it doesn't belong to any pane. This is the default value assigned to elements read from sources, and those that have been assigned a window but not passed through execution of any trigger.

ON_TIME_AND_ONLY_FIRING

public static final PaneInfo ON_TIME_AND_ONLY_FIRING

PaneInfo to use when there will be exactly one firing and it is on time.

Method Detail

isDefault

public boolean isDefault()

Returns true if this pane corresponds to the DEFAULT pane.

createPane

public static PaneInfo createPane(boolean isFirst,
                                  boolean isLast,
                                  PaneInfo.Timing timing)

Factory method to create a PaneInfo with the specified parameters.

decodePane

public static PaneInfo decodePane(byte encodedPane)

isUnknown

public boolean isUnknown()

Return true if there is no timing information for the current PaneInfo. This typically indicates that the current element has not been assigned to windows or passed through an operation that executes triggers yet.

isFirst

public boolean isFirst()

Return true if this is the first pane produced for the associated window.

isLast

public boolean isLast()

Return true if this is the last pane that will be produced in the associated window.

getTiming

public PaneInfo.Timing getTiming()

Return true if this is the last pane that will be produced in the associated window.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object