Package io.substrait.proto

Enum Class AggregationPhase

java.lang.Object
java.lang.Enum<AggregationPhase>
io.substrait.proto.AggregationPhase
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<AggregationPhase>, Constable
public enum AggregationPhase extends Enum<AggregationPhase> implements com.google.protobuf.ProtocolMessageEnum
 Describes which part of an aggregation or window function to perform within
 the context of distributed algorithms.
Protobuf enum substrait.AggregationPhase

  • Enum Constant Details

    • AGGREGATION_PHASE_UNSPECIFIED

      public static final AggregationPhase AGGREGATION_PHASE_UNSPECIFIED
       Implies `INTERMEDIATE_TO_RESULT`.
      AGGREGATION_PHASE_UNSPECIFIED = 0;

    • AGGREGATION_PHASE_INITIAL_TO_INTERMEDIATE

      public static final AggregationPhase AGGREGATION_PHASE_INITIAL_TO_INTERMEDIATE
       Specifies that the function should be run only up to the point of
 generating an intermediate value, to be further aggregated later using
 INTERMEDIATE_TO_INTERMEDIATE or INTERMEDIATE_TO_RESULT.
      AGGREGATION_PHASE_INITIAL_TO_INTERMEDIATE = 1;

    • AGGREGATION_PHASE_INTERMEDIATE_TO_INTERMEDIATE

      public static final AggregationPhase AGGREGATION_PHASE_INTERMEDIATE_TO_INTERMEDIATE
       Specifies that the inputs of the aggregate or window function are the
 intermediate values of the function, and that the output should also be
 an intermediate value, to be further aggregated later using
 INTERMEDIATE_TO_INTERMEDIATE or INTERMEDIATE_TO_RESULT.
      AGGREGATION_PHASE_INTERMEDIATE_TO_INTERMEDIATE = 2;

    • AGGREGATION_PHASE_INITIAL_TO_RESULT

      public static final AggregationPhase AGGREGATION_PHASE_INITIAL_TO_RESULT
       A complete invocation: the function should aggregate the given set of
 inputs to yield a single return value. This style must be used for
 aggregate or window functions that are not decomposable.
      AGGREGATION_PHASE_INITIAL_TO_RESULT = 3;

    • AGGREGATION_PHASE_INTERMEDIATE_TO_RESULT

      public static final AggregationPhase AGGREGATION_PHASE_INTERMEDIATE_TO_RESULT
       Specifies that the inputs of the aggregate or window function are the
 intermediate values of the function, generated previously using
 INITIAL_TO_INTERMEDIATE and possibly INTERMEDIATE_TO_INTERMEDIATE calls.
 This call should combine the intermediate values to yield the final
 return value.
      AGGREGATION_PHASE_INTERMEDIATE_TO_RESULT = 4;

    • UNRECOGNIZED

      public static final AggregationPhase UNRECOGNIZED

  • Field Details

    • AGGREGATION_PHASE_UNSPECIFIED_VALUE

      public static final int AGGREGATION_PHASE_UNSPECIFIED_VALUE
       Implies `INTERMEDIATE_TO_RESULT`.
      AGGREGATION_PHASE_UNSPECIFIED = 0;
      See Also:

    • AGGREGATION_PHASE_INITIAL_TO_INTERMEDIATE_VALUE

      public static final int AGGREGATION_PHASE_INITIAL_TO_INTERMEDIATE_VALUE
       Specifies that the function should be run only up to the point of
 generating an intermediate value, to be further aggregated later using
 INTERMEDIATE_TO_INTERMEDIATE or INTERMEDIATE_TO_RESULT.
      AGGREGATION_PHASE_INITIAL_TO_INTERMEDIATE = 1;
      See Also:

    • AGGREGATION_PHASE_INTERMEDIATE_TO_INTERMEDIATE_VALUE

      public static final int AGGREGATION_PHASE_INTERMEDIATE_TO_INTERMEDIATE_VALUE
       Specifies that the inputs of the aggregate or window function are the
 intermediate values of the function, and that the output should also be
 an intermediate value, to be further aggregated later using
 INTERMEDIATE_TO_INTERMEDIATE or INTERMEDIATE_TO_RESULT.
      AGGREGATION_PHASE_INTERMEDIATE_TO_INTERMEDIATE = 2;
      See Also:

    • AGGREGATION_PHASE_INITIAL_TO_RESULT_VALUE

      public static final int AGGREGATION_PHASE_INITIAL_TO_RESULT_VALUE
       A complete invocation: the function should aggregate the given set of
 inputs to yield a single return value. This style must be used for
 aggregate or window functions that are not decomposable.
      AGGREGATION_PHASE_INITIAL_TO_RESULT = 3;
      See Also:

    • AGGREGATION_PHASE_INTERMEDIATE_TO_RESULT_VALUE

      public static final int AGGREGATION_PHASE_INTERMEDIATE_TO_RESULT_VALUE
       Specifies that the inputs of the aggregate or window function are the
 intermediate values of the function, generated previously using
 INITIAL_TO_INTERMEDIATE and possibly INTERMEDIATE_TO_INTERMEDIATE calls.
 This call should combine the intermediate values to yield the final
 return value.
      AGGREGATION_PHASE_INTERMEDIATE_TO_RESULT = 4;
      See Also:

  • Method Details

    • values

      public static AggregationPhase[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static AggregationPhase valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getNumber

      public final int getNumber()
      Specified by:
      getNumber in interface com.google.protobuf.Internal.EnumLite
      Specified by:
      getNumber in interface com.google.protobuf.ProtocolMessageEnum

    • valueOf

      @Deprecated public static AggregationPhase valueOf(int value)
      Deprecated.
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      value - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • forNumber

      public static AggregationPhase forNumber(int value)
      Parameters:
      value - The numeric wire value of the corresponding enum entry.
      Returns:
      The enum associated with the given numeric wire value.

    • internalGetValueMap

      public static com.google.protobuf.Internal.EnumLiteMap<AggregationPhase> internalGetValueMap()

    • getValueDescriptor

      public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
      Specified by:
      getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptorForType

      public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptor

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

    • valueOf

      public static AggregationPhase valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      desc - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null