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

Class CalendarWindows.YearsWindows

java.lang.Object

com.google.cloud.dataflow.sdk.transforms.windowing.WindowingFn<T,W>

com.google.cloud.dataflow.sdk.transforms.windowing.NonMergingWindowingFn<T,W>

com.google.cloud.dataflow.sdk.transforms.windowing.PartitioningWindowingFn<java.lang.Object,IntervalWindow>

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

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

CalendarWindows

public static class CalendarWindows.YearsWindows
extends PartitioningWindowingFn<java.lang.Object,IntervalWindow>

A WindowingFn that windows elements into periods measured by years.

By default, periods of multiple years are measured starting at the epoch. This can be overridden with withStartingYear(int).

Years start on the first day of each calendar year, unless overridden by beginningOnDay(int, int).

The time zone used to determine calendar boundaries is UTC, unless this is overridden with the withTimeZone(org.joda.time.DateTimeZone) method.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.google.cloud.dataflow.sdk.transforms.windowing.WindowingFn

WindowingFn.AssignContext, WindowingFn.MergeContext

Method Summary

Methods

Modifier and Type	Method and Description
IntervalWindow	assignWindow(Instant timestamp) Returns the single window to which elements with this timestamp belong.
CalendarWindows.YearsWindows	beginningOnDay(int monthOfYear, int dayOfMonth)
boolean	isCompatible(WindowingFn other) Returns whether this performs the same merging as the given WindowingFn.
Coder<IntervalWindow>	windowCoder() Returns the Coder used for serializing the windows used by this windowingFn.
CalendarWindows.YearsWindows	withStartingYear(int year)
CalendarWindows.YearsWindows	withTimeZone(DateTimeZone timeZone)

Methods inherited from class com.google.cloud.dataflow.sdk.transforms.windowing.PartitioningWindowingFn

assignWindows

Methods inherited from class com.google.cloud.dataflow.sdk.transforms.windowing.NonMergingWindowingFn

mergeWindows

Methods inherited from class java.lang.Object

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

Method Detail

beginningOnDay

public CalendarWindows.YearsWindows beginningOnDay(int monthOfYear,
                                          int dayOfMonth)

withStartingYear

public CalendarWindows.YearsWindows withStartingYear(int year)

withTimeZone

public CalendarWindows.YearsWindows withTimeZone(DateTimeZone timeZone)

assignWindow

public IntervalWindow assignWindow(Instant timestamp)

Description copied from class: PartitioningWindowingFn

Returns the single window to which elements with this timestamp belong.

Specified by:

assignWindow in class PartitioningWindowingFn<java.lang.Object,IntervalWindow>

windowCoder

public Coder<IntervalWindow> windowCoder()

Description copied from class: WindowingFn

Returns the Coder used for serializing the windows used by this windowingFn.

Specified by:

windowCoder in class WindowingFn<java.lang.Object,IntervalWindow>

isCompatible

public boolean isCompatible(WindowingFn other)

Description copied from class: WindowingFn

Returns whether this performs the same merging as the given WindowingFn.

Specified by:

isCompatible in class WindowingFn<java.lang.Object,IntervalWindow>