Package com.google.spanner.v1

Enum ReadRequest.OrderBy

java.lang.Object
java.lang.Enum<ReadRequest.OrderBy>
com.google.spanner.v1.ReadRequest.OrderBy
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<ReadRequest.OrderBy>
Enclosing class:
ReadRequest
public static enum ReadRequest.OrderBy extends Enum<ReadRequest.OrderBy> implements com.google.protobuf.ProtocolMessageEnum
 An option to control the order in which rows are returned from a read.
Protobuf enum google.spanner.v1.ReadRequest.OrderBy

  • Enum Constant Details

    • ORDER_BY_UNSPECIFIED

      public static final ReadRequest.OrderBy ORDER_BY_UNSPECIFIED
       Default value.

 ORDER_BY_UNSPECIFIED is equivalent to ORDER_BY_PRIMARY_KEY.
      ORDER_BY_UNSPECIFIED = 0;

    • ORDER_BY_PRIMARY_KEY

      public static final ReadRequest.OrderBy ORDER_BY_PRIMARY_KEY
       Read rows are returned in primary key order.

 In the event that this option is used in conjunction with the
 `partition_token` field, the API will return an `INVALID_ARGUMENT` error.
      ORDER_BY_PRIMARY_KEY = 1;

    • ORDER_BY_NO_ORDER

      public static final ReadRequest.OrderBy ORDER_BY_NO_ORDER
       Read rows are returned in any order.
      ORDER_BY_NO_ORDER = 2;

    • UNRECOGNIZED

      public static final ReadRequest.OrderBy UNRECOGNIZED

  • Field Details

    • ORDER_BY_UNSPECIFIED_VALUE

      public static final int ORDER_BY_UNSPECIFIED_VALUE
       Default value.

 ORDER_BY_UNSPECIFIED is equivalent to ORDER_BY_PRIMARY_KEY.
      ORDER_BY_UNSPECIFIED = 0;
      See Also:

    • ORDER_BY_PRIMARY_KEY_VALUE

      public static final int ORDER_BY_PRIMARY_KEY_VALUE
       Read rows are returned in primary key order.

 In the event that this option is used in conjunction with the
 `partition_token` field, the API will return an `INVALID_ARGUMENT` error.
      ORDER_BY_PRIMARY_KEY = 1;
      See Also:

    • ORDER_BY_NO_ORDER_VALUE

      public static final int ORDER_BY_NO_ORDER_VALUE
       Read rows are returned in any order.
      ORDER_BY_NO_ORDER = 2;
      See Also:

  • Method Details

    • values

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

    • valueOf

      public static ReadRequest.OrderBy valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type 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 ReadRequest.OrderBy valueOf(int value)
      Deprecated.
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name
      NullPointerException - if the argument is null

    • forNumber

      public static ReadRequest.OrderBy 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<ReadRequest.OrderBy> 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 ReadRequest.OrderBy valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name
      NullPointerException - if the argument is null