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

Class RunnerApi.WindowingStrategy

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

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

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, RunnerApi.WindowingStrategyOrBuilder

Enclosing class:

RunnerApi

public static final class RunnerApi.WindowingStrategy
extends com.google.protobuf.GeneratedMessageV3
implements RunnerApi.WindowingStrategyOrBuilder

 A windowing strategy describes the window function, triggering, allowed
 lateness, and accumulation mode for a PCollection.
 TODO: consider inlining field on PCollection
 

Protobuf type org.apache.beam.runner_api.v1.WindowingStrategy

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RunnerApi.WindowingStrategy.Builder A windowing strategy describes the window function, triggering, allowed lateness, and accumulation mode for a PCollection.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACCUMULATION_MODE_FIELD_NUMBER
static int	ALLOWED_LATENESS_FIELD_NUMBER
static int	ASSIGNS_TO_ONE_WINDOW_FIELD_NUMBER
static int	CLOSING_BEHAVIOR_FIELD_NUMBER
static int	MERGE_STATUS_FIELD_NUMBER
static int	ONTIMEBEHAVIOR_FIELD_NUMBER
static int	OUTPUT_TIME_FIELD_NUMBER
static int	TRIGGER_FIELD_NUMBER
static int	WINDOW_CODER_ID_FIELD_NUMBER
static int	WINDOW_FN_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
RunnerApi.AccumulationMode.Enum	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.
boolean	getAssignsToOneWindow() (Required) Whether or not the window fn assigns inputs to exactly one window This knowledge is required for some optimizations
RunnerApi.ClosingBehavior.Enum	getClosingBehavior() (Required) Indicate when output should be omitted upon window expiration.
int	getClosingBehaviorValue() (Required) Indicate when output should be omitted upon window expiration.
static RunnerApi.WindowingStrategy	getDefaultInstance()
RunnerApi.WindowingStrategy	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
RunnerApi.MergeStatus.Enum	getMergeStatus() (Required) Whether or not the window fn is merging.
int	getMergeStatusValue() (Required) Whether or not the window fn is merging.
RunnerApi.OnTimeBehavior.Enum	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.Enum	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.
com.google.protobuf.Parser<RunnerApi.WindowingStrategy>	getParserForType()
int	getSerializedSize()
RunnerApi.Trigger	getTrigger() (Required) The trigger to use when grouping this PCollection.
RunnerApi.TriggerOrBuilder	getTriggerOrBuilder() (Required) The trigger to use when grouping this PCollection.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
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.
int	hashCode()
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.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static RunnerApi.WindowingStrategy.Builder	newBuilder()
static RunnerApi.WindowingStrategy.Builder	newBuilder(RunnerApi.WindowingStrategy prototype)
RunnerApi.WindowingStrategy.Builder	newBuilderForType()
protected RunnerApi.WindowingStrategy.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static RunnerApi.WindowingStrategy	parseDelimitedFrom(InputStream input)
static RunnerApi.WindowingStrategy	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RunnerApi.WindowingStrategy	parseFrom(byte[] data)
static RunnerApi.WindowingStrategy	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RunnerApi.WindowingStrategy	parseFrom(com.google.protobuf.ByteString data)
static RunnerApi.WindowingStrategy	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RunnerApi.WindowingStrategy	parseFrom(com.google.protobuf.CodedInputStream input)
static RunnerApi.WindowingStrategy	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RunnerApi.WindowingStrategy	parseFrom(InputStream input)
static RunnerApi.WindowingStrategy	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<RunnerApi.WindowingStrategy>	parser()
RunnerApi.WindowingStrategy.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

WINDOW_FN_FIELD_NUMBER

public static final int WINDOW_FN_FIELD_NUMBER

See Also:

Constant Field Values

MERGE_STATUS_FIELD_NUMBER

public static final int MERGE_STATUS_FIELD_NUMBER

See Also:

Constant Field Values

WINDOW_CODER_ID_FIELD_NUMBER

public static final int WINDOW_CODER_ID_FIELD_NUMBER

See Also:

Constant Field Values

TRIGGER_FIELD_NUMBER

public static final int TRIGGER_FIELD_NUMBER

See Also:

Constant Field Values

ACCUMULATION_MODE_FIELD_NUMBER

public static final int ACCUMULATION_MODE_FIELD_NUMBER

See Also:

Constant Field Values

OUTPUT_TIME_FIELD_NUMBER

public static final int OUTPUT_TIME_FIELD_NUMBER

See Also:

Constant Field Values

CLOSING_BEHAVIOR_FIELD_NUMBER

public static final int CLOSING_BEHAVIOR_FIELD_NUMBER

See Also:

Constant Field Values

ALLOWED_LATENESS_FIELD_NUMBER

public static final int ALLOWED_LATENESS_FIELD_NUMBER

See Also:

Constant Field Values

ONTIMEBEHAVIOR_FIELD_NUMBER

public static final int ONTIMEBEHAVIOR_FIELD_NUMBER

See Also:

Constant Field Values

ASSIGNS_TO_ONE_WINDOW_FIELD_NUMBER

public static final int ASSIGNS_TO_ONE_WINDOW_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

hasWindowFn

public 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;

Specified by:

hasWindowFn in interface RunnerApi.WindowingStrategyOrBuilder

getWindowFn

public 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;

Specified by:

getWindowFn in interface RunnerApi.WindowingStrategyOrBuilder

getWindowFnOrBuilder

public 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;

Specified by:

getWindowFnOrBuilder in interface RunnerApi.WindowingStrategyOrBuilder

getMergeStatusValue

public 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.Enum merge_status = 2;

Specified by:

getMergeStatusValue in interface RunnerApi.WindowingStrategyOrBuilder

getMergeStatus

public RunnerApi.MergeStatus.Enum getMergeStatus()

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

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

Specified by:

getMergeStatus in interface RunnerApi.WindowingStrategyOrBuilder

getWindowCoderId

public String getWindowCoderId()

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

string window_coder_id = 3;

Specified by:

getWindowCoderId in interface RunnerApi.WindowingStrategyOrBuilder

getWindowCoderIdBytes

public com.google.protobuf.ByteString getWindowCoderIdBytes()

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

string window_coder_id = 3;

Specified by:

getWindowCoderIdBytes in interface RunnerApi.WindowingStrategyOrBuilder

hasTrigger

public boolean hasTrigger()

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

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

Specified by:

hasTrigger in interface RunnerApi.WindowingStrategyOrBuilder

getTrigger

public RunnerApi.Trigger getTrigger()

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

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

Specified by:

getTrigger in interface RunnerApi.WindowingStrategyOrBuilder

getTriggerOrBuilder

public RunnerApi.TriggerOrBuilder getTriggerOrBuilder()

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

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

Specified by:

getTriggerOrBuilder in interface RunnerApi.WindowingStrategyOrBuilder

getAccumulationModeValue

public 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.Enum accumulation_mode = 5;

Specified by:

getAccumulationModeValue in interface RunnerApi.WindowingStrategyOrBuilder

getAccumulationMode

public RunnerApi.AccumulationMode.Enum 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.Enum accumulation_mode = 5;

Specified by:

getAccumulationMode in interface RunnerApi.WindowingStrategyOrBuilder

getOutputTimeValue

public 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.Enum output_time = 6;

Specified by:

getOutputTimeValue in interface RunnerApi.WindowingStrategyOrBuilder

getOutputTime

public RunnerApi.OutputTime.Enum 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.Enum output_time = 6;

Specified by:

getOutputTime in interface RunnerApi.WindowingStrategyOrBuilder

getClosingBehaviorValue

public int getClosingBehaviorValue()

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

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

Specified by:

getClosingBehaviorValue in interface RunnerApi.WindowingStrategyOrBuilder

getClosingBehavior

public RunnerApi.ClosingBehavior.Enum getClosingBehavior()

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

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

Specified by:

getClosingBehavior in interface RunnerApi.WindowingStrategyOrBuilder

getAllowedLateness

public long getAllowedLateness()

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

int64 allowed_lateness = 8;

Specified by:

getAllowedLateness in interface RunnerApi.WindowingStrategyOrBuilder

getOnTimeBehaviorValue

public int getOnTimeBehaviorValue()

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

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

Specified by:

getOnTimeBehaviorValue in interface RunnerApi.WindowingStrategyOrBuilder

getOnTimeBehavior

public RunnerApi.OnTimeBehavior.Enum getOnTimeBehavior()

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

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

Specified by:

getOnTimeBehavior in interface RunnerApi.WindowingStrategyOrBuilder

getAssignsToOneWindow

public boolean getAssignsToOneWindow()

 (Required) Whether or not the window fn assigns inputs to exactly one window
 This knowledge is required for some optimizations
 

bool assigns_to_one_window = 10;

Specified by:

getAssignsToOneWindow in interface RunnerApi.WindowingStrategyOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static RunnerApi.WindowingStrategy parseFrom(com.google.protobuf.ByteString data)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RunnerApi.WindowingStrategy parseFrom(com.google.protobuf.ByteString data,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RunnerApi.WindowingStrategy parseFrom(byte[] data)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RunnerApi.WindowingStrategy parseFrom(byte[] data,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RunnerApi.WindowingStrategy parseFrom(InputStream input)
                                             throws IOException

Throws:

IOException

parseFrom

public static RunnerApi.WindowingStrategy parseFrom(InputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws IOException

Throws:

IOException

parseDelimitedFrom

public static RunnerApi.WindowingStrategy parseDelimitedFrom(InputStream input)
                                                      throws IOException

Throws:

IOException

parseDelimitedFrom

public static RunnerApi.WindowingStrategy parseDelimitedFrom(InputStream input,
                                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                      throws IOException

Throws:

IOException

parseFrom

public static RunnerApi.WindowingStrategy parseFrom(com.google.protobuf.CodedInputStream input)
                                             throws IOException

Throws:

IOException

parseFrom

public static RunnerApi.WindowingStrategy parseFrom(com.google.protobuf.CodedInputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws IOException

Throws:

IOException

newBuilderForType

public RunnerApi.WindowingStrategy.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static RunnerApi.WindowingStrategy.Builder newBuilder()

newBuilder

public static RunnerApi.WindowingStrategy.Builder newBuilder(RunnerApi.WindowingStrategy prototype)

toBuilder

public RunnerApi.WindowingStrategy.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected RunnerApi.WindowingStrategy.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static RunnerApi.WindowingStrategy getDefaultInstance()

parser

public static com.google.protobuf.Parser<RunnerApi.WindowingStrategy> parser()

getParserForType

public com.google.protobuf.Parser<RunnerApi.WindowingStrategy> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public RunnerApi.WindowingStrategy getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder