org.apache.beam.sdk.transforms

Class Sum.SumIntegerFn

java.lang.Object

org.apache.beam.sdk.transforms.Combine.CombineFn<Integer,int[],Integer>

org.apache.beam.sdk.transforms.Combine.BinaryCombineIntegerFn

org.apache.beam.sdk.transforms.Sum.SumIntegerFn

All Implemented Interfaces:

Serializable, CombineFnBase.GlobalCombineFn<Integer,int[],Integer>, HasDisplayData, org.apache.beam.sdk.util.common.CounterProvider<Integer>

Enclosing class:

Sum

public static class Sum.SumIntegerFn
extends Combine.BinaryCombineIntegerFn
implements org.apache.beam.sdk.util.common.CounterProvider<Integer>

A SerializableFunction that computes the sum of an Iterable of Integers, useful as an argument to Combine.globally(org.apache.beam.sdk.transforms.SerializableFunction<java.lang.Iterable<V>, V>) or Combine.perKey(org.apache.beam.sdk.transforms.SerializableFunction<java.lang.Iterable<V>, V>).

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SumIntegerFn()

Method Summary

Modifier and Type	Method and Description
int	apply(int a, int b) Applies the binary operation to the two operands, returning the result.
TypeVariable<?>	getAccumTVariable() Returns the TypeVariable of AccumT.
org.apache.beam.sdk.util.common.Counter<Integer>	getCounter(String name)
String	getIncompatibleGlobalWindowErrorMessage() Returns the error message for not supported default values in Combine.globally().
TypeVariable<?>	getInputTVariable() Returns the TypeVariable of InputT.
TypeVariable<?>	getOutputTVariable() Returns the TypeVariable of OutputT.
int	identity() Returns the identity element of this operation, i.e.
void	populateDisplayData(DisplayData.Builder builder) Register display data for the given transform or component.

Methods inherited from class org.apache.beam.sdk.transforms.Combine.BinaryCombineIntegerFn

addInput, createAccumulator, extractOutput, getAccumulatorCoder, getDefaultOutputCoder, mergeAccumulators

Methods inherited from class org.apache.beam.sdk.transforms.Combine.CombineFn

apply, asKeyedFn, compact, defaultValue, getOutputType

Methods inherited from class java.lang.Object

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

Constructor Detail

SumIntegerFn

public SumIntegerFn()

Method Detail

apply

public int apply(int a,
                 int b)

Description copied from class: Combine.BinaryCombineIntegerFn

Applies the binary operation to the two operands, returning the result.

Specified by:

apply in class Combine.BinaryCombineIntegerFn

identity

public int identity()

Description copied from class: Combine.BinaryCombineIntegerFn

Returns the identity element of this operation, i.e. an element e such that apply(e, x) == apply(x, e) == x for all values of x.

Specified by:

identity in class Combine.BinaryCombineIntegerFn

getCounter

public org.apache.beam.sdk.util.common.Counter<Integer> getCounter(String name)

Specified by:

getCounter in interface org.apache.beam.sdk.util.common.CounterProvider<Integer>

Overrides:

getCounter in class Combine.BinaryCombineIntegerFn

getIncompatibleGlobalWindowErrorMessage

public String getIncompatibleGlobalWindowErrorMessage()

Description copied from interface: CombineFnBase.GlobalCombineFn

Returns the error message for not supported default values in Combine.globally().

Specified by:

getIncompatibleGlobalWindowErrorMessage in interface CombineFnBase.GlobalCombineFn<InputT,AccumT,OutputT>

getInputTVariable

public TypeVariable<?> getInputTVariable()

Returns the TypeVariable of InputT.

getAccumTVariable

public TypeVariable<?> getAccumTVariable()

Returns the TypeVariable of AccumT.

getOutputTVariable

public TypeVariable<?> getOutputTVariable()

Returns the TypeVariable of OutputT.

populateDisplayData

public void populateDisplayData(DisplayData.Builder builder)

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

Parameters:

builder - The builder to populate with display data.

See Also:

HasDisplayData