FixedWindows (Google Cloud Dataflow SDK 1.9.1 API)

Google Cloud Dataflow SDK for Java, version 1.9.1

Warning: Dataflow SDK 1.x for Java is unsupported as of October 16, 2018. After August 12, 2020, you can use unsupported SDKs temporarily while you upgrade your pipelines. For more information, see Using an unsupported SDK.

For information on migrating from the 1.x SDK, see Migrating from Dataflow SDK 1.x for Java.

Note: If you are using Cloud Dataflow SDK version 2.x, see the Apache Beam API reference documentation.

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

Class FixedWindows

• java.lang.Object
• • com.google.cloud.dataflow.sdk.transforms.windowing.WindowFn<T,W>
  • • com.google.cloud.dataflow.sdk.transforms.windowing.NonMergingWindowFn<T,W>
    • • com.google.cloud.dataflow.sdk.transforms.windowing.PartitioningWindowFn<Object,IntervalWindow>
      • • com.google.cloud.dataflow.sdk.transforms.windowing.FixedWindows

• All Implemented Interfaces:

  HasDisplayData, Serializable

  ---

  
  

  public class FixedWindows
  extends PartitioningWindowFn<Object,IntervalWindow>

  A WindowFn that windows values into fixed-size timestamp-based windows.

  For example, in order to partition the data into 10 minute windows:

   
   PCollection<Integer> items = ...;
   PCollection<Integer> windowedItems = items.apply(
     Window.<Integer>into(FixedWindows.of(Duration.standardMinutes(10))));
    

  See Also:

  Serialized Form

• • Nested Class Summary

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

      WindowFn.AssignContext, WindowFn.MergeContext

  • Method Summary

    All Methods Static Methods Instance Methods Concrete Methods 

    Modifier and Type	Method and Description
    IntervalWindow	assignWindow(Instant timestamp) Returns the single window to which elements with this timestamp belong.
    boolean	equals(Object object)
    Duration	getOffset()
    Duration	getSize()
    int	hashCode()
    boolean	isCompatible(WindowFn<?,?> other) Returns whether this performs the same merging as the given WindowFn.
    static FixedWindows	of(Duration size) Partitions the timestamp space into half-open intervals of the form [N * size, (N + 1) * size), where 0 is the epoch.
    void	populateDisplayData(DisplayData.Builder builder) Register display data for the given transform or component.
    Coder<IntervalWindow>	windowCoder() Returns the Coder used for serializing the windows used by this windowFn.
    FixedWindows	withOffset(Duration offset) Partitions the timestamp space into half-open intervals of the form [N * size + offset, (N + 1) * size + offset), where 0 is the epoch.

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

      assignsToSingleWindow, assignWindows, getOutputTime, getSideInputWindow

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

      isNonMerging, mergeWindows

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

      getOutputTimeFn

    • Methods inherited from class java.lang.Object

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

• • Method Detail

    • of

      public static FixedWindows of(Duration size)

      Partitions the timestamp space into half-open intervals of the form [N * size, (N + 1) * size), where 0 is the epoch.

    • withOffset

      public FixedWindows withOffset(Duration offset)

      Partitions the timestamp space into half-open intervals of the form [N * size + offset, (N + 1) * size + offset), where 0 is the epoch.

      Throws:

      IllegalArgumentException - if offset is not in [0, size)

    • assignWindow

      public IntervalWindow assignWindow(Instant timestamp)

      Description copied from class: PartitioningWindowFn
      Returns the single window to which elements with this timestamp belong.

      Specified by:

      assignWindow in class PartitioningWindowFn<Object,IntervalWindow>

    • populateDisplayData

      public void populateDisplayData(DisplayData.Builder builder)

      Description copied from class: WindowFn
      Register display data for the given transform or component.

      populateDisplayData(DisplayData.Builder) is invoked by Pipeline runners to collect display data via DisplayData.from(HasDisplayData). Implementations may call super.populateDisplayData(builder) in order to register display data in the current namespace, but should otherwise use subcomponent.populateDisplayData(builder) to use the namespace of the subcomponent.

      By default, does not register any display data. Implementors may override this method to provide their own display data.

      Specified by:

      populateDisplayData in interface HasDisplayData

      Overrides:

      populateDisplayData in class WindowFn<Object,IntervalWindow>

      Parameters:

      builder - The builder to populate with display data.

      See Also:

      HasDisplayData

    • windowCoder

      public Coder<IntervalWindow> windowCoder()

      Description copied from class: WindowFn
      Returns the Coder used for serializing the windows used by this windowFn.

      Specified by:

      windowCoder in class WindowFn<Object,IntervalWindow>

    • isCompatible

      public boolean isCompatible(WindowFn<?,?> other)

      Description copied from class: WindowFn
      Returns whether this performs the same merging as the given WindowFn.

      Specified by:

      isCompatible in class WindowFn<Object,IntervalWindow>

    • getSize

      public Duration getSize()

    • getOffset

      public Duration getOffset()

    • equals

      public boolean equals(Object object)

      Overrides:

      equals in class Object

    • hashCode

      public int hashCode()

      Overrides:

      hashCode in class Object