Package io.substrait.proto

Interface AggregateFunctionOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
AggregateFunction, AggregateFunction.Builder
public interface AggregateFunctionOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getFunctionReference

      int getFunctionReference()
       Points to a function_anchor defined in this plan, which must refer
 to an aggregate function in the associated YAML file. Required; 0 is
 considered to be a valid anchor/reference.
      uint32 function_reference = 1;
      Returns:
      The functionReference.

    • getArgumentsList

      List<FunctionArgument> getArgumentsList()
       The arguments to be bound to the function. This must have exactly the
 number of arguments specified in the function definition, and the
 argument types must also match exactly:

  - Value arguments must be bound using FunctionArgument.value, and
    the expression in that must yield a value of a type that a function
    overload is defined for.
  - Type arguments must be bound using FunctionArgument.type, and a
    function overload must be defined for that type.
  - Enum arguments must be bound using FunctionArgument.enum
    followed by Enum.specified, with a string that case-insensitively
    matches one of the allowed options.
  - Optional enum arguments must be bound using FunctionArgument.enum
    followed by either Enum.specified or Enum.unspecified. If specified,
    the string must case-insensitively match one of the allowed options.
      repeated .substrait.FunctionArgument arguments = 7;

    • getArguments

      FunctionArgument getArguments(int index)
       The arguments to be bound to the function. This must have exactly the
 number of arguments specified in the function definition, and the
 argument types must also match exactly:

  - Value arguments must be bound using FunctionArgument.value, and
    the expression in that must yield a value of a type that a function
    overload is defined for.
  - Type arguments must be bound using FunctionArgument.type, and a
    function overload must be defined for that type.
  - Enum arguments must be bound using FunctionArgument.enum
    followed by Enum.specified, with a string that case-insensitively
    matches one of the allowed options.
  - Optional enum arguments must be bound using FunctionArgument.enum
    followed by either Enum.specified or Enum.unspecified. If specified,
    the string must case-insensitively match one of the allowed options.
      repeated .substrait.FunctionArgument arguments = 7;

    • getArgumentsCount

      int getArgumentsCount()
       The arguments to be bound to the function. This must have exactly the
 number of arguments specified in the function definition, and the
 argument types must also match exactly:

  - Value arguments must be bound using FunctionArgument.value, and
    the expression in that must yield a value of a type that a function
    overload is defined for.
  - Type arguments must be bound using FunctionArgument.type, and a
    function overload must be defined for that type.
  - Enum arguments must be bound using FunctionArgument.enum
    followed by Enum.specified, with a string that case-insensitively
    matches one of the allowed options.
  - Optional enum arguments must be bound using FunctionArgument.enum
    followed by either Enum.specified or Enum.unspecified. If specified,
    the string must case-insensitively match one of the allowed options.
      repeated .substrait.FunctionArgument arguments = 7;

    • getArgumentsOrBuilderList

      List<? extends FunctionArgumentOrBuilder> getArgumentsOrBuilderList()
       The arguments to be bound to the function. This must have exactly the
 number of arguments specified in the function definition, and the
 argument types must also match exactly:

  - Value arguments must be bound using FunctionArgument.value, and
    the expression in that must yield a value of a type that a function
    overload is defined for.
  - Type arguments must be bound using FunctionArgument.type, and a
    function overload must be defined for that type.
  - Enum arguments must be bound using FunctionArgument.enum
    followed by Enum.specified, with a string that case-insensitively
    matches one of the allowed options.
  - Optional enum arguments must be bound using FunctionArgument.enum
    followed by either Enum.specified or Enum.unspecified. If specified,
    the string must case-insensitively match one of the allowed options.
      repeated .substrait.FunctionArgument arguments = 7;

    • getArgumentsOrBuilder

      FunctionArgumentOrBuilder getArgumentsOrBuilder(int index)
       The arguments to be bound to the function. This must have exactly the
 number of arguments specified in the function definition, and the
 argument types must also match exactly:

  - Value arguments must be bound using FunctionArgument.value, and
    the expression in that must yield a value of a type that a function
    overload is defined for.
  - Type arguments must be bound using FunctionArgument.type, and a
    function overload must be defined for that type.
  - Enum arguments must be bound using FunctionArgument.enum
    followed by Enum.specified, with a string that case-insensitively
    matches one of the allowed options.
  - Optional enum arguments must be bound using FunctionArgument.enum
    followed by either Enum.specified or Enum.unspecified. If specified,
    the string must case-insensitively match one of the allowed options.
      repeated .substrait.FunctionArgument arguments = 7;

    • getOptionsList

      List<FunctionOption> getOptionsList()
       Options to specify behavior for corner cases, or leave behavior
 unspecified if the consumer does not need specific behavior in these
 cases.
      repeated .substrait.FunctionOption options = 8;

    • getOptions

      FunctionOption getOptions(int index)
       Options to specify behavior for corner cases, or leave behavior
 unspecified if the consumer does not need specific behavior in these
 cases.
      repeated .substrait.FunctionOption options = 8;

    • getOptionsCount

      int getOptionsCount()
       Options to specify behavior for corner cases, or leave behavior
 unspecified if the consumer does not need specific behavior in these
 cases.
      repeated .substrait.FunctionOption options = 8;

    • getOptionsOrBuilderList

      List<? extends FunctionOptionOrBuilder> getOptionsOrBuilderList()
       Options to specify behavior for corner cases, or leave behavior
 unspecified if the consumer does not need specific behavior in these
 cases.
      repeated .substrait.FunctionOption options = 8;

    • getOptionsOrBuilder

      FunctionOptionOrBuilder getOptionsOrBuilder(int index)
       Options to specify behavior for corner cases, or leave behavior
 unspecified if the consumer does not need specific behavior in these
 cases.
      repeated .substrait.FunctionOption options = 8;

    • hasOutputType

      boolean hasOutputType()
       Must be set to the return type of the function, exactly as derived
 using the declaration in the extension.
      .substrait.Type output_type = 5;
      Returns:
      Whether the outputType field is set.

    • getOutputType

      Type getOutputType()
       Must be set to the return type of the function, exactly as derived
 using the declaration in the extension.
      .substrait.Type output_type = 5;
      Returns:
      The outputType.

    • getOutputTypeOrBuilder

      TypeOrBuilder getOutputTypeOrBuilder()
       Must be set to the return type of the function, exactly as derived
 using the declaration in the extension.
      .substrait.Type output_type = 5;

    • getPhaseValue

      int getPhaseValue()
       Describes which part of the aggregation to perform within the context of
 distributed algorithms. Required. Must be set to INITIAL_TO_RESULT for
 aggregate functions that are not decomposable.
      .substrait.AggregationPhase phase = 4;
      Returns:
      The enum numeric value on the wire for phase.

    • getPhase

      AggregationPhase getPhase()
       Describes which part of the aggregation to perform within the context of
 distributed algorithms. Required. Must be set to INITIAL_TO_RESULT for
 aggregate functions that are not decomposable.
      .substrait.AggregationPhase phase = 4;
      Returns:
      The phase.

    • getSortsList

      List<SortField> getSortsList()
       If specified, the aggregated records are ordered according to this list
 before they are aggregated. The first sort field has the highest
 priority; only if a sort field determines two records to be equivalent is
 the next field queried. This field is optional.
      repeated .substrait.SortField sorts = 3;

    • getSorts

      SortField getSorts(int index)
       If specified, the aggregated records are ordered according to this list
 before they are aggregated. The first sort field has the highest
 priority; only if a sort field determines two records to be equivalent is
 the next field queried. This field is optional.
      repeated .substrait.SortField sorts = 3;

    • getSortsCount

      int getSortsCount()
       If specified, the aggregated records are ordered according to this list
 before they are aggregated. The first sort field has the highest
 priority; only if a sort field determines two records to be equivalent is
 the next field queried. This field is optional.
      repeated .substrait.SortField sorts = 3;

    • getSortsOrBuilderList

      List<? extends SortFieldOrBuilder> getSortsOrBuilderList()
       If specified, the aggregated records are ordered according to this list
 before they are aggregated. The first sort field has the highest
 priority; only if a sort field determines two records to be equivalent is
 the next field queried. This field is optional.
      repeated .substrait.SortField sorts = 3;

    • getSortsOrBuilder

      SortFieldOrBuilder getSortsOrBuilder(int index)
       If specified, the aggregated records are ordered according to this list
 before they are aggregated. The first sort field has the highest
 priority; only if a sort field determines two records to be equivalent is
 the next field queried. This field is optional.
      repeated .substrait.SortField sorts = 3;

    • getInvocationValue

      int getInvocationValue()
       Specifies whether equivalent records are merged before being aggregated.
 Optional, defaults to AGGREGATION_INVOCATION_ALL.
      .substrait.AggregateFunction.AggregationInvocation invocation = 6;
      Returns:
      The enum numeric value on the wire for invocation.

    • getInvocation

      AggregateFunction.AggregationInvocation getInvocation()
       Specifies whether equivalent records are merged before being aggregated.
 Optional, defaults to AGGREGATION_INVOCATION_ALL.
      .substrait.AggregateFunction.AggregationInvocation invocation = 6;
      Returns:
      The invocation.

    • getArgsList

      @Deprecated List<Expression> getArgsList()
      Deprecated.
       deprecated; use arguments instead
      repeated .substrait.Expression args = 2 [deprecated = true];

    • getArgs

      @Deprecated Expression getArgs(int index)
      Deprecated.
       deprecated; use arguments instead
      repeated .substrait.Expression args = 2 [deprecated = true];

    • getArgsCount

      @Deprecated int getArgsCount()
      Deprecated.
       deprecated; use arguments instead
      repeated .substrait.Expression args = 2 [deprecated = true];

    • getArgsOrBuilderList

      @Deprecated List<? extends ExpressionOrBuilder> getArgsOrBuilderList()
      Deprecated.
       deprecated; use arguments instead
      repeated .substrait.Expression args = 2 [deprecated = true];

    • getArgsOrBuilder

      @Deprecated ExpressionOrBuilder getArgsOrBuilder(int index)
      Deprecated.
       deprecated; use arguments instead
      repeated .substrait.Expression args = 2 [deprecated = true];