Package io.substrait.proto

Interface FunctionOptionOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getName()
    Name of the option to set.
    com.google.protobuf.ByteString
    getNameBytes()
    Name of the option to set.
    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.
    List<String>
    getPreferenceList()
    List of behavior options allowed by the producer.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getName

      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;
      Returns:
      The name.

    • getNameBytes

      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;
      Returns:
      The bytes for name.

    • getPreferenceList

      List<String> 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;
      Returns:
      A list containing the preference.

    • getPreferenceCount

      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;
      Returns:
      The count of preference.

    • getPreference

      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;
      Parameters:
      index - The index of the element to return.
      Returns:
      The preference at the given index.

    • getPreferenceBytes

      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;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the preference at the given index.