org.apache.beam.sdk.common.runner.v1

Interface RunnerApi.WindowingStrategyOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

RunnerApi.WindowingStrategy, RunnerApi.WindowingStrategy.Builder

Enclosing class:

RunnerApi

public static interface RunnerApi.WindowingStrategyOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
RunnerApi.AccumulationMode	getAccumulationMode() (Required) The accumulation mode indicates whether new panes are a full replacement for prior panes or whether they are deltas to be combined with other panes (the combine should correspond to whatever the upstream grouping transform is).
int	getAccumulationModeValue() (Required) The accumulation mode indicates whether new panes are a full replacement for prior panes or whether they are deltas to be combined with other panes (the combine should correspond to whatever the upstream grouping transform is).
long	getAllowedLateness() (Required) The duration, in milliseconds, beyond the end of a window at which the window becomes droppable.
RunnerApi.ClosingBehavior	getClosingBehavior() (Required) Indicate when output should be omitted upon window expiration.
int	getClosingBehaviorValue() (Required) Indicate when output should be omitted upon window expiration.
RunnerApi.MergeStatus	getMergeStatus() (Required) Whether or not the window fn is merging.
int	getMergeStatusValue() (Required) Whether or not the window fn is merging.
RunnerApi.OnTimeBehavior	getOnTimeBehavior() (Required) Indicate whether empty on-time panes should be omitted.
int	getOnTimeBehaviorValue() (Required) Indicate whether empty on-time panes should be omitted.
RunnerApi.OutputTime	getOutputTime() (Required) The OutputTime specifies, for a grouping transform, how to compute the aggregate timestamp.
int	getOutputTimeValue() (Required) The OutputTime specifies, for a grouping transform, how to compute the aggregate timestamp.
RunnerApi.Trigger	getTrigger() (Required) The trigger to use when grouping this PCollection.
RunnerApi.TriggerOrBuilder	getTriggerOrBuilder() (Required) The trigger to use when grouping this PCollection.
String	getWindowCoderId() (Required) The coder for the windows of this PCollection.
com.google.protobuf.ByteString	getWindowCoderIdBytes() (Required) The coder for the windows of this PCollection.
RunnerApi.SdkFunctionSpec	getWindowFn() (Required) The SdkFunctionSpec of the UDF that assigns windows, merges windows, and shifts timestamps before they are combined according to the OutputTime.
RunnerApi.SdkFunctionSpecOrBuilder	getWindowFnOrBuilder() (Required) The SdkFunctionSpec of the UDF that assigns windows, merges windows, and shifts timestamps before they are combined according to the OutputTime.
boolean	hasTrigger() (Required) The trigger to use when grouping this PCollection.
boolean	hasWindowFn() (Required) The SdkFunctionSpec of the UDF that assigns windows, merges windows, and shifts timestamps before they are combined according to the OutputTime.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasWindowFn

boolean hasWindowFn()

 (Required) The SdkFunctionSpec of the UDF that assigns windows,
 merges windows, and shifts timestamps before they are
 combined according to the OutputTime.
 

.org.apache.beam.runner_api.v1.SdkFunctionSpec window_fn = 1;

getWindowFn

RunnerApi.SdkFunctionSpec getWindowFn()

 (Required) The SdkFunctionSpec of the UDF that assigns windows,
 merges windows, and shifts timestamps before they are
 combined according to the OutputTime.
 

.org.apache.beam.runner_api.v1.SdkFunctionSpec window_fn = 1;

getWindowFnOrBuilder

RunnerApi.SdkFunctionSpecOrBuilder getWindowFnOrBuilder()

 (Required) The SdkFunctionSpec of the UDF that assigns windows,
 merges windows, and shifts timestamps before they are
 combined according to the OutputTime.
 

.org.apache.beam.runner_api.v1.SdkFunctionSpec window_fn = 1;

getMergeStatusValue

int getMergeStatusValue()

 (Required) Whether or not the window fn is merging.
 This knowledge is required for many optimizations.
 

.org.apache.beam.runner_api.v1.MergeStatus merge_status = 2;

getMergeStatus

RunnerApi.MergeStatus getMergeStatus()

 (Required) Whether or not the window fn is merging.
 This knowledge is required for many optimizations.
 

.org.apache.beam.runner_api.v1.MergeStatus merge_status = 2;

getWindowCoderId

String getWindowCoderId()

 (Required) The coder for the windows of this PCollection.
 

string window_coder_id = 3;

getWindowCoderIdBytes

com.google.protobuf.ByteString getWindowCoderIdBytes()

 (Required) The coder for the windows of this PCollection.
 

string window_coder_id = 3;

hasTrigger

boolean hasTrigger()

 (Required) The trigger to use when grouping this PCollection.
 

.org.apache.beam.runner_api.v1.Trigger trigger = 4;

getTrigger

RunnerApi.Trigger getTrigger()

 (Required) The trigger to use when grouping this PCollection.
 

.org.apache.beam.runner_api.v1.Trigger trigger = 4;

getTriggerOrBuilder

RunnerApi.TriggerOrBuilder getTriggerOrBuilder()

 (Required) The trigger to use when grouping this PCollection.
 

.org.apache.beam.runner_api.v1.Trigger trigger = 4;

getAccumulationModeValue

int getAccumulationModeValue()

 (Required) The accumulation mode indicates whether new panes are a full
 replacement for prior panes or whether they are deltas to be combined
 with other panes (the combine should correspond to whatever the upstream
 grouping transform is).
 

.org.apache.beam.runner_api.v1.AccumulationMode accumulation_mode = 5;

getAccumulationMode

RunnerApi.AccumulationMode getAccumulationMode()

 (Required) The accumulation mode indicates whether new panes are a full
 replacement for prior panes or whether they are deltas to be combined
 with other panes (the combine should correspond to whatever the upstream
 grouping transform is).
 

.org.apache.beam.runner_api.v1.AccumulationMode accumulation_mode = 5;

getOutputTimeValue

int getOutputTimeValue()

 (Required) The OutputTime specifies, for a grouping transform, how to
 compute the aggregate timestamp. The window_fn will first possibly shift
 it later, then the OutputTime takes the max, min, or ignores it and takes
 the end of window.
 This is actually only for input to grouping transforms, but since they
 may be introduced in runner-specific ways, it is carried along with the
 windowing strategy.
 

.org.apache.beam.runner_api.v1.OutputTime output_time = 6;

getOutputTime

RunnerApi.OutputTime getOutputTime()

 (Required) The OutputTime specifies, for a grouping transform, how to
 compute the aggregate timestamp. The window_fn will first possibly shift
 it later, then the OutputTime takes the max, min, or ignores it and takes
 the end of window.
 This is actually only for input to grouping transforms, but since they
 may be introduced in runner-specific ways, it is carried along with the
 windowing strategy.
 

.org.apache.beam.runner_api.v1.OutputTime output_time = 6;

getClosingBehaviorValue

int getClosingBehaviorValue()

 (Required) Indicate when output should be omitted upon window expiration.
 

.org.apache.beam.runner_api.v1.ClosingBehavior closing_behavior = 7;

getClosingBehavior

RunnerApi.ClosingBehavior getClosingBehavior()

 (Required) Indicate when output should be omitted upon window expiration.
 

.org.apache.beam.runner_api.v1.ClosingBehavior closing_behavior = 7;

getAllowedLateness

long getAllowedLateness()

 (Required) The duration, in milliseconds, beyond the end of a window at
 which the window becomes droppable.
 

int64 allowed_lateness = 8;

getOnTimeBehaviorValue

int getOnTimeBehaviorValue()

 (Required) Indicate whether empty on-time panes should be omitted.
 

.org.apache.beam.runner_api.v1.OnTimeBehavior OnTimeBehavior = 9;

getOnTimeBehavior

RunnerApi.OnTimeBehavior getOnTimeBehavior()

 (Required) Indicate whether empty on-time panes should be omitted.
 

.org.apache.beam.runner_api.v1.OnTimeBehavior OnTimeBehavior = 9;