Sum.SumIntegerFn (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

Class Sum.SumIntegerFn

• java.lang.Object
• • com.google.cloud.dataflow.sdk.transforms.Combine.CombineFn<Integer,int[],Integer>
  • • com.google.cloud.dataflow.sdk.transforms.Combine.BinaryCombineIntegerFn
    • • com.google.cloud.dataflow.sdk.transforms.Sum.SumIntegerFn

• All Implemented Interfaces:

  CombineFnBase.GlobalCombineFn<Integer,int[],Integer>, HasDisplayData, com.google.cloud.dataflow.sdk.util.common.CounterProvider<Integer>, Serializable

  Enclosing class:

  Sum

  ---

  
  

  public static class Sum.SumIntegerFn
  extends Combine.BinaryCombineIntegerFn
  implements com.google.cloud.dataflow.sdk.util.common.CounterProvider<Integer>

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

  See Also:

  Serialized Form

• • Constructor Summary

    Constructors 

    Constructor and Description
    SumIntegerFn()

  • Method Summary

    All Methods Instance Methods Concrete Methods 

    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.
    com.google.cloud.dataflow.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 com.google.cloud.dataflow.sdk.transforms.Combine.BinaryCombineIntegerFn

      addInput, createAccumulator, extractOutput, getAccumulatorCoder, getDefaultOutputCoder, mergeAccumulators

    • Methods inherited from class com.google.cloud.dataflow.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 com.google.cloud.dataflow.sdk.util.common.Counter<Integer> getCounter(String name)

      Specified by:

      getCounter in interface com.google.cloud.dataflow.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