Package com.google.spanner.v1

Enum TypeCode

java.lang.Object
java.lang.Enum<TypeCode>
com.google.spanner.v1.TypeCode
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<TypeCode>
public enum TypeCode extends Enum<TypeCode> implements com.google.protobuf.ProtocolMessageEnum
 `TypeCode` is used as part of [Type][google.spanner.v1.Type] to
 indicate the type of a Cloud Spanner value.

 Each legal value of a type can be encoded to or decoded from a JSON
 value, using the encodings described below. All Cloud Spanner values can
 be `null`, regardless of type; `null`s are always encoded as a JSON
 `null`.
Protobuf enum google.spanner.v1.TypeCode

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ARRAY
    Encoded as `list`, where the list elements are represented according to [array_element_type][google.spanner.v1.Type.array_element_type].
    BOOL
    Encoded as JSON `true` or `false`.
    BYTES
    Encoded as a base64-encoded `string`, as described in RFC 4648, section 4.
    DATE
    Encoded as `string` in RFC 3339 date format.
    ENUM
    Encoded as `string`, in decimal format.
    FLOAT32
    Encoded as `number`, or the strings `"NaN"`, `"Infinity"`, or `"-Infinity"`.
    FLOAT64
    Encoded as `number`, or the strings `"NaN"`, `"Infinity"`, or `"-Infinity"`.
    INT64
    Encoded as `string`, in decimal format.
    INTERVAL
    Encoded as `string`, in `ISO8601` duration format - `P[n]Y[n]M[n]DT[n]H[n]M[n[.fraction]]S` where `n` is an integer.
    JSON
    Encoded as a JSON-formatted `string` as described in RFC 7159.
    NUMERIC
    Encoded as `string`, in decimal format or scientific notation format.
    PROTO
    Encoded as a base64-encoded `string`, as described in RFC 4648, section 4.
    STRING
    Encoded as `string`.
    STRUCT
    Encoded as `list`, where list element `i` is represented according to [struct_type.fields[i]][google.spanner.v1.StructType.fields].
    TIMESTAMP
    Encoded as `string` in RFC 3339 timestamp format.
    TYPE_CODE_UNSPECIFIED
    Not specified.
    UNRECOGNIZED
     

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ARRAY_VALUE
    Encoded as `list`, where the list elements are represented according to [array_element_type][google.spanner.v1.Type.array_element_type].
    static final int
    BOOL_VALUE
    Encoded as JSON `true` or `false`.
    static final int
    BYTES_VALUE
    Encoded as a base64-encoded `string`, as described in RFC 4648, section 4.
    static final int
    DATE_VALUE
    Encoded as `string` in RFC 3339 date format.
    static final int
    ENUM_VALUE
    Encoded as `string`, in decimal format.
    static final int
    FLOAT32_VALUE
    Encoded as `number`, or the strings `"NaN"`, `"Infinity"`, or `"-Infinity"`.
    static final int
    FLOAT64_VALUE
    Encoded as `number`, or the strings `"NaN"`, `"Infinity"`, or `"-Infinity"`.
    static final int
    INT64_VALUE
    Encoded as `string`, in decimal format.
    static final int
    INTERVAL_VALUE
    Encoded as `string`, in `ISO8601` duration format - `P[n]Y[n]M[n]DT[n]H[n]M[n[.fraction]]S` where `n` is an integer.
    static final int
    JSON_VALUE
    Encoded as a JSON-formatted `string` as described in RFC 7159.
    static final int
    NUMERIC_VALUE
    Encoded as `string`, in decimal format or scientific notation format.
    static final int
    PROTO_VALUE
    Encoded as a base64-encoded `string`, as described in RFC 4648, section 4.
    static final int
    STRING_VALUE
    Encoded as `string`.
    static final int
    STRUCT_VALUE
    Encoded as `list`, where list element `i` is represented according to [struct_type.fields[i]][google.spanner.v1.StructType.fields].
    static final int
    TIMESTAMP_VALUE
    Encoded as `string` in RFC 3339 timestamp format.
    static final int
    TYPE_CODE_UNSPECIFIED_VALUE
    Not specified.

  • Method Summary

    Modifier and Type
    Method
    Description
    static TypeCode
    forNumber(int value)
     
    static final com.google.protobuf.Descriptors.EnumDescriptor
    getDescriptor()
     
    final com.google.protobuf.Descriptors.EnumDescriptor
    getDescriptorForType()
     
    final int
    getNumber()
     
    final com.google.protobuf.Descriptors.EnumValueDescriptor
    getValueDescriptor()
     
    static com.google.protobuf.Internal.EnumLiteMap<TypeCode>
    internalGetValueMap()
     
    static TypeCode
    valueOf(int value)
    Deprecated.
    static TypeCode
    valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
    Returns the enum constant of this type with the specified name.
    static TypeCode
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static TypeCode[]
    values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • TYPE_CODE_UNSPECIFIED

      public static final TypeCode TYPE_CODE_UNSPECIFIED
       Not specified.
      TYPE_CODE_UNSPECIFIED = 0;

    • BOOL

      public static final TypeCode BOOL
       Encoded as JSON `true` or `false`.
      BOOL = 1;

    • INT64

      public static final TypeCode INT64
       Encoded as `string`, in decimal format.
      INT64 = 2;

    • FLOAT64

      public static final TypeCode FLOAT64
       Encoded as `number`, or the strings `"NaN"`, `"Infinity"`, or
 `"-Infinity"`.
      FLOAT64 = 3;

    • FLOAT32

      public static final TypeCode FLOAT32
       Encoded as `number`, or the strings `"NaN"`, `"Infinity"`, or
 `"-Infinity"`.
      FLOAT32 = 15;

    • TIMESTAMP

      public static final TypeCode TIMESTAMP
       Encoded as `string` in RFC 3339 timestamp format. The time zone
 must be present, and must be `"Z"`.

 If the schema has the column option
 `allow_commit_timestamp=true`, the placeholder string
 `"spanner.commit_timestamp()"` can be used to instruct the system
 to insert the commit timestamp associated with the transaction
 commit.
      TIMESTAMP = 4;

    • DATE

      public static final TypeCode DATE
       Encoded as `string` in RFC 3339 date format.
      DATE = 5;

    • STRING

      public static final TypeCode STRING
       Encoded as `string`.
      STRING = 6;

    • BYTES

      public static final TypeCode BYTES
       Encoded as a base64-encoded `string`, as described in RFC 4648,
 section 4.
      BYTES = 7;

    • ARRAY

      public static final TypeCode ARRAY
       Encoded as `list`, where the list elements are represented
 according to
 [array_element_type][google.spanner.v1.Type.array_element_type].
      ARRAY = 8;

    • STRUCT

      public static final TypeCode STRUCT
       Encoded as `list`, where list element `i` is represented according
 to [struct_type.fields[i]][google.spanner.v1.StructType.fields].
      STRUCT = 9;

    • NUMERIC

      public static final TypeCode NUMERIC
       Encoded as `string`, in decimal format or scientific notation format.
 Decimal format:
 `[+-]Digits[.[Digits]]` or
 `[+-][Digits].Digits`

 Scientific notation:
 `[+-]Digits[.[Digits]][ExponentIndicator[+-]Digits]` or
 `[+-][Digits].Digits[ExponentIndicator[+-]Digits]`
 (ExponentIndicator is `"e"` or `"E"`)
      NUMERIC = 10;

    • JSON

      public static final TypeCode JSON
       Encoded as a JSON-formatted `string` as described in RFC 7159. The
 following rules are applied when parsing JSON input:

 - Whitespace characters are not preserved.
 - If a JSON object has duplicate keys, only the first key is preserved.
 - Members of a JSON object are not guaranteed to have their order
   preserved.
 - JSON array elements will have their order preserved.
      JSON = 11;

    • PROTO

      public static final TypeCode PROTO
       Encoded as a base64-encoded `string`, as described in RFC 4648,
 section 4.
      PROTO = 13;

    • ENUM

      public static final TypeCode ENUM
       Encoded as `string`, in decimal format.
      ENUM = 14;

    • INTERVAL

      public static final TypeCode INTERVAL
       Encoded as `string`, in `ISO8601` duration format -
 `P[n]Y[n]M[n]DT[n]H[n]M[n[.fraction]]S`
 where `n` is an integer.
 For example, `P1Y2M3DT4H5M6.5S` represents time duration of 1 year, 2
 months, 3 days, 4 hours, 5 minutes, and 6.5 seconds.
      INTERVAL = 16;

    • UNRECOGNIZED

      public static final TypeCode UNRECOGNIZED

  • Field Details

    • TYPE_CODE_UNSPECIFIED_VALUE

      public static final int TYPE_CODE_UNSPECIFIED_VALUE
       Not specified.
      TYPE_CODE_UNSPECIFIED = 0;
      See Also:

    • BOOL_VALUE

      public static final int BOOL_VALUE
       Encoded as JSON `true` or `false`.
      BOOL = 1;
      See Also:

    • INT64_VALUE

      public static final int INT64_VALUE
       Encoded as `string`, in decimal format.
      INT64 = 2;
      See Also:

    • FLOAT64_VALUE

      public static final int FLOAT64_VALUE
       Encoded as `number`, or the strings `"NaN"`, `"Infinity"`, or
 `"-Infinity"`.
      FLOAT64 = 3;
      See Also:

    • FLOAT32_VALUE

      public static final int FLOAT32_VALUE
       Encoded as `number`, or the strings `"NaN"`, `"Infinity"`, or
 `"-Infinity"`.
      FLOAT32 = 15;
      See Also:

    • TIMESTAMP_VALUE

      public static final int TIMESTAMP_VALUE
       Encoded as `string` in RFC 3339 timestamp format. The time zone
 must be present, and must be `"Z"`.

 If the schema has the column option
 `allow_commit_timestamp=true`, the placeholder string
 `"spanner.commit_timestamp()"` can be used to instruct the system
 to insert the commit timestamp associated with the transaction
 commit.
      TIMESTAMP = 4;
      See Also:

    • DATE_VALUE

      public static final int DATE_VALUE
       Encoded as `string` in RFC 3339 date format.
      DATE = 5;
      See Also:

    • STRING_VALUE

      public static final int STRING_VALUE
       Encoded as `string`.
      STRING = 6;
      See Also:

    • BYTES_VALUE

      public static final int BYTES_VALUE
       Encoded as a base64-encoded `string`, as described in RFC 4648,
 section 4.
      BYTES = 7;
      See Also:

    • ARRAY_VALUE

      public static final int ARRAY_VALUE
       Encoded as `list`, where the list elements are represented
 according to
 [array_element_type][google.spanner.v1.Type.array_element_type].
      ARRAY = 8;
      See Also:

    • STRUCT_VALUE

      public static final int STRUCT_VALUE
       Encoded as `list`, where list element `i` is represented according
 to [struct_type.fields[i]][google.spanner.v1.StructType.fields].
      STRUCT = 9;
      See Also:

    • NUMERIC_VALUE

      public static final int NUMERIC_VALUE
       Encoded as `string`, in decimal format or scientific notation format.
 Decimal format:
 `[+-]Digits[.[Digits]]` or
 `[+-][Digits].Digits`

 Scientific notation:
 `[+-]Digits[.[Digits]][ExponentIndicator[+-]Digits]` or
 `[+-][Digits].Digits[ExponentIndicator[+-]Digits]`
 (ExponentIndicator is `"e"` or `"E"`)
      NUMERIC = 10;
      See Also:

    • JSON_VALUE

      public static final int JSON_VALUE
       Encoded as a JSON-formatted `string` as described in RFC 7159. The
 following rules are applied when parsing JSON input:

 - Whitespace characters are not preserved.
 - If a JSON object has duplicate keys, only the first key is preserved.
 - Members of a JSON object are not guaranteed to have their order
   preserved.
 - JSON array elements will have their order preserved.
      JSON = 11;
      See Also:

    • PROTO_VALUE

      public static final int PROTO_VALUE
       Encoded as a base64-encoded `string`, as described in RFC 4648,
 section 4.
      PROTO = 13;
      See Also:

    • ENUM_VALUE

      public static final int ENUM_VALUE
       Encoded as `string`, in decimal format.
      ENUM = 14;
      See Also:

    • INTERVAL_VALUE

      public static final int INTERVAL_VALUE
       Encoded as `string`, in `ISO8601` duration format -
 `P[n]Y[n]M[n]DT[n]H[n]M[n[.fraction]]S`
 where `n` is an integer.
 For example, `P1Y2M3DT4H5M6.5S` represents time duration of 1 year, 2
 months, 3 days, 4 hours, 5 minutes, and 6.5 seconds.
      INTERVAL = 16;
      See Also:

  • Method Details

    • values

      public static TypeCode[] 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 TypeCode 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 TypeCode 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 TypeCode 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<TypeCode> 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 TypeCode 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