Package io.substrait.proto

Interface Expression.ScalarFunctionOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Expression.ScalarFunction, Expression.ScalarFunction.Builder
Enclosing class:
Expression
public static interface Expression.ScalarFunctionOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getFunctionReference

      int getFunctionReference()
       Points to a function_anchor defined in this plan, which must refer
 to a scalar function in the associated YAML file. Required; avoid
 using anchor/reference zero.
      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.
  - Enum arguments must be bound using FunctionArgument.enum
    followed by Enum.specified, with a string that case-insensitively
    matches one of the allowed options.
      repeated .substrait.FunctionArgument arguments = 4;

    • 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.
  - Enum arguments must be bound using FunctionArgument.enum
    followed by Enum.specified, with a string that case-insensitively
    matches one of the allowed options.
      repeated .substrait.FunctionArgument arguments = 4;

    • 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.
  - Enum arguments must be bound using FunctionArgument.enum
    followed by Enum.specified, with a string that case-insensitively
    matches one of the allowed options.
      repeated .substrait.FunctionArgument arguments = 4;

    • 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.
  - Enum arguments must be bound using FunctionArgument.enum
    followed by Enum.specified, with a string that case-insensitively
    matches one of the allowed options.
      repeated .substrait.FunctionArgument arguments = 4;

    • 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.
  - Enum arguments must be bound using FunctionArgument.enum
    followed by Enum.specified, with a string that case-insensitively
    matches one of the allowed options.
      repeated .substrait.FunctionArgument arguments = 4;

    • 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 = 5;

    • 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 = 5;

    • 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 = 5;

    • 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 = 5;

    • 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 = 5;

    • 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 = 3;
      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 = 3;
      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 = 3;

    • 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];