Package io.substrait.proto

Class FunctionOption

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.substrait.proto.FunctionOption
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, FunctionOptionOrBuilder, Serializable
public final class FunctionOption extends com.google.protobuf.GeneratedMessageV3 implements FunctionOptionOrBuilder
 An optional function argument.  Typically used for specifying behavior in
 invalid or corner cases.
Protobuf type substrait.FunctionOption
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    FunctionOption.Builder
    An optional function argument.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    PREFERENCE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static FunctionOption
    getDefaultInstance()
     
    FunctionOption
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getName()
    Name of the option to set.
    com.google.protobuf.ByteString
    getNameBytes()
    Name of the option to set.
    com.google.protobuf.Parser<FunctionOption>
    getParserForType()
     
    String
    getPreference(int index)
    List of behavior options allowed by the producer.
    com.google.protobuf.ByteString
    getPreferenceBytes(int index)
    List of behavior options allowed by the producer.
    int
    getPreferenceCount()
    List of behavior options allowed by the producer.
    com.google.protobuf.ProtocolStringList
    getPreferenceList()
    List of behavior options allowed by the producer.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static FunctionOption.Builder
    newBuilder()
     
    static FunctionOption.Builder
    newBuilder(FunctionOption prototype)
     
    FunctionOption.Builder
    newBuilderForType()
     
    protected FunctionOption.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static FunctionOption
    parseDelimitedFrom(InputStream input)
     
    static FunctionOption
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FunctionOption
    parseFrom(byte[] data)
     
    static FunctionOption
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FunctionOption
    parseFrom(com.google.protobuf.ByteString data)
     
    static FunctionOption
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FunctionOption
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static FunctionOption
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FunctionOption
    parseFrom(InputStream input)
     
    static FunctionOption
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FunctionOption
    parseFrom(ByteBuffer data)
     
    static FunctionOption
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<FunctionOption>
    parser()
     
    FunctionOption.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

  • 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

    • getName

      public String getName()
       Name of the option to set. If the consumer does not recognize the
 option, it must reject the plan. The name is matched case-insensitively
 with option names defined for the function.
      string name = 1;
      Specified by:
      getName in interface FunctionOptionOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Name of the option to set. If the consumer does not recognize the
 option, it must reject the plan. The name is matched case-insensitively
 with option names defined for the function.
      string name = 1;
      Specified by:
      getNameBytes in interface FunctionOptionOrBuilder
      Returns:
      The bytes for name.

    • getPreferenceList

      public com.google.protobuf.ProtocolStringList getPreferenceList()
       List of behavior options allowed by the producer. At least one must be
 specified; to leave an option unspecified, simply don't add an entry to
 `options`. The consumer must use the first option from the list that it
 supports. If the consumer supports none of the specified options, it
 must reject the plan. The name is matched case-insensitively and must
 match one of the option values defined for the option.
      repeated string preference = 2;
      Specified by:
      getPreferenceList in interface FunctionOptionOrBuilder
      Returns:
      A list containing the preference.

    • getPreferenceCount

      public int getPreferenceCount()
       List of behavior options allowed by the producer. At least one must be
 specified; to leave an option unspecified, simply don't add an entry to
 `options`. The consumer must use the first option from the list that it
 supports. If the consumer supports none of the specified options, it
 must reject the plan. The name is matched case-insensitively and must
 match one of the option values defined for the option.
      repeated string preference = 2;
      Specified by:
      getPreferenceCount in interface FunctionOptionOrBuilder
      Returns:
      The count of preference.

    • getPreference

      public String getPreference(int index)
       List of behavior options allowed by the producer. At least one must be
 specified; to leave an option unspecified, simply don't add an entry to
 `options`. The consumer must use the first option from the list that it
 supports. If the consumer supports none of the specified options, it
 must reject the plan. The name is matched case-insensitively and must
 match one of the option values defined for the option.
      repeated string preference = 2;
      Specified by:
      getPreference in interface FunctionOptionOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The preference at the given index.

    • getPreferenceBytes

      public com.google.protobuf.ByteString getPreferenceBytes(int index)
       List of behavior options allowed by the producer. At least one must be
 specified; to leave an option unspecified, simply don't add an entry to
 `options`. The consumer must use the first option from the list that it
 supports. If the consumer supports none of the specified options, it
 must reject the plan. The name is matched case-insensitively and must
 match one of the option values defined for the option.
      repeated string preference = 2;
      Specified by:
      getPreferenceBytes in interface FunctionOptionOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the preference at the given index.

    • 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 FunctionOption parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static FunctionOption parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static FunctionOption parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static FunctionOption.Builder newBuilder()

    • newBuilder

      public static FunctionOption.Builder newBuilder(FunctionOption prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static FunctionOption getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<FunctionOption> 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 FunctionOption getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder