Window.Bound (Google Cloud Dataflow SDK 1.9.1 API)

Google Cloud Dataflow SDK for Java, version 1.9.1

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

Class Window.Bound<T>

    • Method Detail

      • named

        public Window.Bound<T> named(String name)
        Returns a new Window PTransform that's like this PTransform but with the specified name. Does not modify this PTransform.

        See the discussion of Naming in ParDo for more explanation.

      • discardingFiredPanes

        @Experimental(value=TRIGGER)
        public Window.Bound<T> discardingFiredPanes()
        Returns a new Window PTransform that uses the registered WindowFn and Triggering behavior, and that discards elements in a pane after they are triggered.

        Does not modify this transform. The resulting PTransform is sufficiently specified to be applied, but more properties can still be specified.

      • accumulatingFiredPanes

        @Experimental(value=TRIGGER)
        public Window.Bound<T> accumulatingFiredPanes()
        Returns a new Window PTransform that uses the registered WindowFn and Triggering behavior, and that accumulates elements in a pane after they are triggered.

        Does not modify this transform. The resulting PTransform is sufficiently specified to be applied, but more properties can still be specified.

      • withAllowedLateness

        @Experimental(value=TRIGGER)
        public Window.Bound<T> withAllowedLateness(Duration allowedLateness)
        Override the amount of lateness allowed for data elements in the pipeline. Like the other properties on this Window operation, this will be applied at the next GroupByKey. Any elements that are later than this as decided by the system-maintained watermark will be dropped.

        This value also determines how long state will be kept around for old windows. Once no elements will be added to a window (because this duration has passed) any state associated with the window will be cleaned up.

        Depending on the trigger this may not produce a pane with PaneInfo.isLast. See Window.ClosingBehavior.FIRE_IF_NON_EMPTY for more details.

      • withAllowedLateness

        @Experimental(value=TRIGGER)
        public Window.Bound<T> withAllowedLateness(Duration allowedLateness,
                                                                                Window.ClosingBehavior behavior)
        Override the amount of lateness allowed for data elements in the pipeline. Like the other properties on this Window operation, this will be applied at the next GroupByKey. Any elements that are later than this as decided by the system-maintained watermark will be dropped.

        This value also determines how long state will be kept around for old windows. Once no elements will be added to a window (because this duration has passed) any state associated with the window will be cleaned up.

      • getOutputStrategyInternal

        public com.google.cloud.dataflow.sdk.util.WindowingStrategy<?,?> getOutputStrategyInternal(com.google.cloud.dataflow.sdk.util.WindowingStrategy<?,?> inputStrategy)
        Get the output strategy of this Window PTransform. For internal use only.
      • validate

        public void validate(PCollection<T> input)
        Description copied from class: PTransform
        Called before invoking apply (which may be intercepted by the runner) to verify this transform is fully specified and applicable to the specified input.

        By default, does nothing.

        Overrides:
        validate in class PTransform<PCollection<T>,PCollection<T>>
      • populateDisplayData

        public void populateDisplayData(DisplayData.Builder builder)
        Description copied from class: PTransform
        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 PTransform<PCollection<T>,PCollection<T>>
        Parameters:
        builder - The builder to populate with display data.
        See Also:
        HasDisplayData
      • getKindString

        protected String getKindString()
        Description copied from class: PTransform
        Returns the name to use by default for this PTransform (not including the names of any enclosing PTransforms).

        By default, returns the base name of this PTransform's class.

        The caller is responsible for ensuring that names of applied PTransforms are unique, e.g., by adding a uniquifying suffix when needed.

        Overrides:
        getKindString in class PTransform<PCollection<T>,PCollection<T>>


Was this page helpful? Let us know how we did:

Send feedback about...

Cloud Dataflow
Need help? Visit our support page.