Package org.apache.beam.sdk.values

Interface WindowedValue<T>

Type Parameters:

T - the type of the primary data for the value.

All Known Subinterfaces:

OutputBuilder<T>

All Known Implementing Classes:

WindowedValues.Builder

public interface WindowedValue<T>

A value along with Beam's windowing information and all other metadata.

Method Summary

Modifier and Type	Method	Description
CausedByDrain	causedByDrain()
Iterable<? extends WindowedValue<T>>	explodeWindows()	A representation of each of the actual values represented by this compressed WindowedValue, one per window.
@Nullable Context	getOpenTelemetryContext()
PaneInfo	getPaneInfo()	The PaneInfo associated with this WindowedValue.
@Nullable String	getRecordId()
@Nullable Long	getRecordOffset()
Instant	getTimestamp()	The timestamp of this value in event time.
T	getValue()	The primary data for this value.
ValueKind	getValueKind()	Returns the ValueKind associated with this WindowedValue.
Collection<? extends BoundedWindow>	getWindows()	Returns the windows of this WindowedValue.
<OtherT> WindowedValue<OtherT>	withValue(OtherT value)	A WindowedValue with identical metadata to the current one, but with the provided value.

Method Details

getValue

@Pure
T getValue()

The primary data for this value.

getTimestamp

@Pure
Instant getTimestamp()

The timestamp of this value in event time.

getWindows

@Pure
Collection<? extends BoundedWindow> getWindows()

Returns the windows of this WindowedValue.

getPaneInfo

@Pure
PaneInfo getPaneInfo()

The PaneInfo associated with this WindowedValue.

getRecordId

@Nullable String getRecordId()

getOpenTelemetryContext

@Nullable Context getOpenTelemetryContext()

getRecordOffset

@Nullable Long getRecordOffset()

causedByDrain

CausedByDrain causedByDrain()

getValueKind

@Pure
ValueKind getValueKind()

Returns the ValueKind associated with this WindowedValue.

explodeWindows

@Pure
Iterable<? extends WindowedValue<T>> explodeWindows()

A representation of each of the actual values represented by this compressed WindowedValue, one per window.

withValue

@Pure
<OtherT> WindowedValue<OtherT> withValue(OtherT value)

A WindowedValue with identical metadata to the current one, but with the provided value.