Package io.substrait.proto

Class Expression.ScalarFunction

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.substrait.proto.Expression.ScalarFunction
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Expression.ScalarFunctionOrBuilder, Serializable
Enclosing class:
Expression
public static final class Expression.ScalarFunction extends com.google.protobuf.GeneratedMessageV3 implements Expression.ScalarFunctionOrBuilder
 A scalar function call.
Protobuf type substrait.Expression.ScalarFunction
See Also:

  • Field Details

    • FUNCTION_REFERENCE_FIELD_NUMBER

      public static final int FUNCTION_REFERENCE_FIELD_NUMBER
      See Also:

    • ARGUMENTS_FIELD_NUMBER

      public static final int ARGUMENTS_FIELD_NUMBER
      See Also:

    • OPTIONS_FIELD_NUMBER

      public static final int OPTIONS_FIELD_NUMBER
      See Also:

    • OUTPUT_TYPE_FIELD_NUMBER

      public static final int OUTPUT_TYPE_FIELD_NUMBER
      See Also:

    • ARGS_FIELD_NUMBER

      public static final int ARGS_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getFunctionReference

      public 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;
      Specified by:
      getFunctionReference in interface Expression.ScalarFunctionOrBuilder
      Returns:
      The functionReference.

    • getArgumentsList

      public 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;
      Specified by:
      getArgumentsList in interface Expression.ScalarFunctionOrBuilder

    • getArgumentsOrBuilderList

      public 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;
      Specified by:
      getArgumentsOrBuilderList in interface Expression.ScalarFunctionOrBuilder

    • getArgumentsCount

      public 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;
      Specified by:
      getArgumentsCount in interface Expression.ScalarFunctionOrBuilder

    • getArguments

      public 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;
      Specified by:
      getArguments in interface Expression.ScalarFunctionOrBuilder

    • getArgumentsOrBuilder

      public 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;
      Specified by:
      getArgumentsOrBuilder in interface Expression.ScalarFunctionOrBuilder

    • getOptionsList

      public 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;
      Specified by:
      getOptionsList in interface Expression.ScalarFunctionOrBuilder

    • getOptionsOrBuilderList

      public 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;
      Specified by:
      getOptionsOrBuilderList in interface Expression.ScalarFunctionOrBuilder

    • getOptionsCount

      public 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;
      Specified by:
      getOptionsCount in interface Expression.ScalarFunctionOrBuilder

    • getOptions

      public 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;
      Specified by:
      getOptions in interface Expression.ScalarFunctionOrBuilder

    • getOptionsOrBuilder

      public 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;
      Specified by:
      getOptionsOrBuilder in interface Expression.ScalarFunctionOrBuilder

    • hasOutputType

      public 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;
      Specified by:
      hasOutputType in interface Expression.ScalarFunctionOrBuilder
      Returns:
      Whether the outputType field is set.

    • getOutputType

      public 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;
      Specified by:
      getOutputType in interface Expression.ScalarFunctionOrBuilder
      Returns:
      The outputType.

    • getOutputTypeOrBuilder

      public 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;
      Specified by:
      getOutputTypeOrBuilder in interface Expression.ScalarFunctionOrBuilder

    • getArgsList

      @Deprecated public List<Expression> getArgsList()
      Deprecated.
       Deprecated; use arguments instead.
      repeated .substrait.Expression args = 2 [deprecated = true];
      Specified by:
      getArgsList in interface Expression.ScalarFunctionOrBuilder

    • getArgsOrBuilderList

      @Deprecated public List<? extends ExpressionOrBuilder> getArgsOrBuilderList()
      Deprecated.
       Deprecated; use arguments instead.
      repeated .substrait.Expression args = 2 [deprecated = true];
      Specified by:
      getArgsOrBuilderList in interface Expression.ScalarFunctionOrBuilder

    • getArgsCount

      @Deprecated public int getArgsCount()
      Deprecated.
       Deprecated; use arguments instead.
      repeated .substrait.Expression args = 2 [deprecated = true];
      Specified by:
      getArgsCount in interface Expression.ScalarFunctionOrBuilder

    • getArgs

      @Deprecated public Expression getArgs(int index)
      Deprecated.
       Deprecated; use arguments instead.
      repeated .substrait.Expression args = 2 [deprecated = true];
      Specified by:
      getArgs in interface Expression.ScalarFunctionOrBuilder

    • getArgsOrBuilder

      @Deprecated public ExpressionOrBuilder getArgsOrBuilder(int index)
      Deprecated.
       Deprecated; use arguments instead.
      repeated .substrait.Expression args = 2 [deprecated = true];
      Specified by:
      getArgsOrBuilder in interface Expression.ScalarFunctionOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Expression.ScalarFunction parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Expression.ScalarFunction parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Expression.ScalarFunction parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Expression.ScalarFunction parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Expression.ScalarFunction parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Expression.ScalarFunction parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Expression.ScalarFunction parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Expression.ScalarFunction parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Expression.ScalarFunction parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Expression.ScalarFunction parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Expression.ScalarFunction parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Expression.ScalarFunction parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Expression.ScalarFunction.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Expression.ScalarFunction.Builder newBuilder()

    • newBuilder

      public static Expression.ScalarFunction.Builder newBuilder(Expression.ScalarFunction prototype)

    • toBuilder

      public Expression.ScalarFunction.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Expression.ScalarFunction.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static Expression.ScalarFunction getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Expression.ScalarFunction> parser()

    • getParserForType

      public com.google.protobuf.Parser<Expression.ScalarFunction> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public Expression.ScalarFunction getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder