Package com.google.spanner.v1

Interface KeyRecipe.PartOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
KeyRecipe.Part, KeyRecipe.Part.Builder
Enclosing class:
KeyRecipe
public static interface KeyRecipe.PartOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getIdentifier()
    `identifier` is the name of the column or query parameter.
    com.google.protobuf.ByteString
    getIdentifierBytes()
    `identifier` is the name of the column or query parameter.
    KeyRecipe.Part.NullOrder
    getNullOrder()
    How NULLs are represented in the encoded key part.
    int
    getNullOrderValue()
    How NULLs are represented in the encoded key part.
    KeyRecipe.Part.Order
    getOrder()
    Whether the key column is sorted ascending or descending.
    int
    getOrderValue()
    Whether the key column is sorted ascending or descending.
    boolean
    getRandom()
    If true, the client is responsible to fill in the value randomly.
    int
    getStructIdentifiers(int index)
    It is a repeated field to support fetching key columns from nested structs, such as `STRUCT` query parameters.
    int
    getStructIdentifiersCount()
    It is a repeated field to support fetching key columns from nested structs, such as `STRUCT` query parameters.
    List<Integer>
    getStructIdentifiersList()
    It is a repeated field to support fetching key columns from nested structs, such as `STRUCT` query parameters.
    int
    getTag()
    If non-zero, `tag` is the only field present in this `Part`.
    Type
    getType()
    The type of the key part.
    TypeOrBuilder
    getTypeOrBuilder()
    The type of the key part.
    com.google.protobuf.Value
    getValue()
    The constant value of the key part.
    com.google.protobuf.ValueOrBuilder
    getValueOrBuilder()
    The constant value of the key part.
    KeyRecipe.Part.ValueTypeCase
    getValueTypeCase()
     
    boolean
    hasIdentifier()
    `identifier` is the name of the column or query parameter.
    boolean
    hasRandom()
    If true, the client is responsible to fill in the value randomly.
    boolean
    hasType()
    The type of the key part.
    boolean
    hasValue()
    The constant value of the key part.

    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

    • getTag

      int getTag()
       If non-zero, `tag` is the only field present in this `Part`. The part
 is encoded by appending `tag` to the ssformat key.
      uint32 tag = 1;
      Returns:
      The tag.

    • getOrderValue

      int getOrderValue()
       Whether the key column is sorted ascending or descending. Only present
 if `tag` is zero.
      .google.spanner.v1.KeyRecipe.Part.Order order = 2;
      Returns:
      The enum numeric value on the wire for order.

    • getOrder

      KeyRecipe.Part.Order getOrder()
       Whether the key column is sorted ascending or descending. Only present
 if `tag` is zero.
      .google.spanner.v1.KeyRecipe.Part.Order order = 2;
      Returns:
      The order.

    • getNullOrderValue

      int getNullOrderValue()
       How NULLs are represented in the encoded key part. Only present if `tag`
 is zero.
      .google.spanner.v1.KeyRecipe.Part.NullOrder null_order = 3;
      Returns:
      The enum numeric value on the wire for nullOrder.

    • getNullOrder

      KeyRecipe.Part.NullOrder getNullOrder()
       How NULLs are represented in the encoded key part. Only present if `tag`
 is zero.
      .google.spanner.v1.KeyRecipe.Part.NullOrder null_order = 3;
      Returns:
      The nullOrder.

    • hasType

      boolean hasType()
       The type of the key part. Only present if `tag` is zero.
      .google.spanner.v1.Type type = 4;
      Returns:
      Whether the type field is set.

    • getType

      Type getType()
       The type of the key part. Only present if `tag` is zero.
      .google.spanner.v1.Type type = 4;
      Returns:
      The type.

    • getTypeOrBuilder

      TypeOrBuilder getTypeOrBuilder()
       The type of the key part. Only present if `tag` is zero.
      .google.spanner.v1.Type type = 4;

    • hasIdentifier

      boolean hasIdentifier()
       `identifier` is the name of the column or query parameter.
      string identifier = 5;
      Returns:
      Whether the identifier field is set.

    • getIdentifier

      String getIdentifier()
       `identifier` is the name of the column or query parameter.
      string identifier = 5;
      Returns:
      The identifier.

    • getIdentifierBytes

      com.google.protobuf.ByteString getIdentifierBytes()
       `identifier` is the name of the column or query parameter.
      string identifier = 5;
      Returns:
      The bytes for identifier.

    • hasValue

      boolean hasValue()
       The constant value of the key part.
 It is present when query uses a constant as a part of the key.
      .google.protobuf.Value value = 6;
      Returns:
      Whether the value field is set.

    • getValue

      com.google.protobuf.Value getValue()
       The constant value of the key part.
 It is present when query uses a constant as a part of the key.
      .google.protobuf.Value value = 6;
      Returns:
      The value.

    • getValueOrBuilder

      com.google.protobuf.ValueOrBuilder getValueOrBuilder()
       The constant value of the key part.
 It is present when query uses a constant as a part of the key.
      .google.protobuf.Value value = 6;

    • hasRandom

      boolean hasRandom()
       If true, the client is responsible to fill in the value randomly.
 It's relevant only for the INT64 type.
      bool random = 8;
      Returns:
      Whether the random field is set.

    • getRandom

      boolean getRandom()
       If true, the client is responsible to fill in the value randomly.
 It's relevant only for the INT64 type.
      bool random = 8;
      Returns:
      The random.

    • getStructIdentifiersList

      List<Integer> getStructIdentifiersList()
       It is a repeated field to support fetching key columns from nested
 structs, such as `STRUCT` query parameters.
      repeated int32 struct_identifiers = 7;
      Returns:
      A list containing the structIdentifiers.

    • getStructIdentifiersCount

      int getStructIdentifiersCount()
       It is a repeated field to support fetching key columns from nested
 structs, such as `STRUCT` query parameters.
      repeated int32 struct_identifiers = 7;
      Returns:
      The count of structIdentifiers.

    • getStructIdentifiers

      int getStructIdentifiers(int index)
       It is a repeated field to support fetching key columns from nested
 structs, such as `STRUCT` query parameters.
      repeated int32 struct_identifiers = 7;
      Parameters:
      index - The index of the element to return.
      Returns:
      The structIdentifiers at the given index.

    • getValueTypeCase

      KeyRecipe.Part.ValueTypeCase getValueTypeCase()