Package io.substrait.proto

Enum Class WriteRel.OutputMode

java.lang.Object
java.lang.Enum<WriteRel.OutputMode>
io.substrait.proto.WriteRel.OutputMode
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<WriteRel.OutputMode>, Constable
Enclosing class:
WriteRel
public static enum WriteRel.OutputMode extends Enum<WriteRel.OutputMode> implements com.google.protobuf.ProtocolMessageEnum
Protobuf enum substrait.WriteRel.OutputMode

  • Enum Constant Details

    • OUTPUT_MODE_UNSPECIFIED

      public static final WriteRel.OutputMode OUTPUT_MODE_UNSPECIFIED
      OUTPUT_MODE_UNSPECIFIED = 0;

    • OUTPUT_MODE_NO_OUTPUT

      public static final WriteRel.OutputMode OUTPUT_MODE_NO_OUTPUT
       return no records at all
      OUTPUT_MODE_NO_OUTPUT = 1;

    • OUTPUT_MODE_MODIFIED_RECORDS

      public static final WriteRel.OutputMode OUTPUT_MODE_MODIFIED_RECORDS
       this mode makes the operator return all the record INSERTED/DELETED/UPDATED by the operator.
 The operator returns the AFTER-image of any change. This can be further manipulated by operators upstreams
 (e.g., retunring the typical "count of modified records").
 For scenarios in which the BEFORE image is required, the user must implement a spool (via references to
 subplans in the body of the Rel input) and return those with anounter PlanRel.relations.
      OUTPUT_MODE_MODIFIED_RECORDS = 2;

    • UNRECOGNIZED

      public static final WriteRel.OutputMode UNRECOGNIZED

  • Field Details

    • OUTPUT_MODE_UNSPECIFIED_VALUE

      public static final int OUTPUT_MODE_UNSPECIFIED_VALUE
      OUTPUT_MODE_UNSPECIFIED = 0;
      See Also:

    • OUTPUT_MODE_NO_OUTPUT_VALUE

      public static final int OUTPUT_MODE_NO_OUTPUT_VALUE
       return no records at all
      OUTPUT_MODE_NO_OUTPUT = 1;
      See Also:

    • OUTPUT_MODE_MODIFIED_RECORDS_VALUE

      public static final int OUTPUT_MODE_MODIFIED_RECORDS_VALUE
       this mode makes the operator return all the record INSERTED/DELETED/UPDATED by the operator.
 The operator returns the AFTER-image of any change. This can be further manipulated by operators upstreams
 (e.g., retunring the typical "count of modified records").
 For scenarios in which the BEFORE image is required, the user must implement a spool (via references to
 subplans in the body of the Rel input) and return those with anounter PlanRel.relations.
      OUTPUT_MODE_MODIFIED_RECORDS = 2;
      See Also:

  • Method Details

    • values

      public static WriteRel.OutputMode[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static WriteRel.OutputMode valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getNumber

      public final int getNumber()
      Specified by:
      getNumber in interface com.google.protobuf.Internal.EnumLite
      Specified by:
      getNumber in interface com.google.protobuf.ProtocolMessageEnum

    • valueOf

      @Deprecated public static WriteRel.OutputMode valueOf(int value)
      Deprecated.
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      value - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • forNumber

      public static WriteRel.OutputMode forNumber(int value)
      Parameters:
      value - The numeric wire value of the corresponding enum entry.
      Returns:
      The enum associated with the given numeric wire value.

    • internalGetValueMap

      public static com.google.protobuf.Internal.EnumLiteMap<WriteRel.OutputMode> internalGetValueMap()

    • getValueDescriptor

      public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
      Specified by:
      getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptorForType

      public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptor

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

    • valueOf

      public static WriteRel.OutputMode valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      desc - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null