Package com.google.spanner.v1

Class RoutingHint.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<RoutingHint.Builder>
com.google.spanner.v1.RoutingHint.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RoutingHintOrBuilder, Cloneable
Enclosing class:
RoutingHint
public static final class RoutingHint.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<RoutingHint.Builder> implements RoutingHintOrBuilder
 `RoutingHint` can be optionally added to location-aware Spanner
 requests. It gives the server hints that can be used to route the request to
 an appropriate server, potentially significantly decreasing latency and
 improving throughput. To achieve improved performance, most fields must be
 filled in with accurate values.

 The presence of a valid `RoutingHint` tells the server that the client
 is location-aware.

 `RoutingHint` does not change the semantics of the request; it is
 purely a performance hint; the request will perform the same actions on the
 database's data as if `RoutingHint` were not present. However, if
 the `RoutingHint` is incomplete or incorrect, the response may include
 a `CacheUpdate` the client can use to correct its location cache.
Protobuf type google.spanner.v1.RoutingHint

  • Method Summary

    Modifier and Type
    Method
    Description
    RoutingHint.Builder
    addAllSkippedTabletUid(Iterable<? extends RoutingHint.SkippedTablet> values)
    If the client had multiple options for tablet selection, and some of its first choices were unhealthy (e.g., the server is unreachable, or `Tablet.skip` is true), this field will contain the tablet UIDs of those tablets, with their incarnations.
    RoutingHint.Builder
    addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
     
    RoutingHint.Builder
    addSkippedTabletUid(int index, RoutingHint.SkippedTablet value)
    If the client had multiple options for tablet selection, and some of its first choices were unhealthy (e.g., the server is unreachable, or `Tablet.skip` is true), this field will contain the tablet UIDs of those tablets, with their incarnations.
    RoutingHint.Builder
    addSkippedTabletUid(int index, RoutingHint.SkippedTablet.Builder builderForValue)
    If the client had multiple options for tablet selection, and some of its first choices were unhealthy (e.g., the server is unreachable, or `Tablet.skip` is true), this field will contain the tablet UIDs of those tablets, with their incarnations.
    RoutingHint.Builder
    addSkippedTabletUid(RoutingHint.SkippedTablet value)
    If the client had multiple options for tablet selection, and some of its first choices were unhealthy (e.g., the server is unreachable, or `Tablet.skip` is true), this field will contain the tablet UIDs of those tablets, with their incarnations.
    RoutingHint.Builder
    addSkippedTabletUid(RoutingHint.SkippedTablet.Builder builderForValue)
    If the client had multiple options for tablet selection, and some of its first choices were unhealthy (e.g., the server is unreachable, or `Tablet.skip` is true), this field will contain the tablet UIDs of those tablets, with their incarnations.
    RoutingHint.SkippedTablet.Builder
    addSkippedTabletUidBuilder()
    If the client had multiple options for tablet selection, and some of its first choices were unhealthy (e.g., the server is unreachable, or `Tablet.skip` is true), this field will contain the tablet UIDs of those tablets, with their incarnations.
    RoutingHint.SkippedTablet.Builder
    addSkippedTabletUidBuilder(int index)
    If the client had multiple options for tablet selection, and some of its first choices were unhealthy (e.g., the server is unreachable, or `Tablet.skip` is true), this field will contain the tablet UIDs of those tablets, with their incarnations.
    RoutingHint
    build()
     
    RoutingHint
    buildPartial()
     
    RoutingHint.Builder
    clear()
     
    RoutingHint.Builder
    clearClientLocation()
    If present, the client's current location.
    RoutingHint.Builder
    clearDatabaseId()
    The database ID of the database being accessed, see `CacheUpdate.database_id`.
    RoutingHint.Builder
    clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
     
    RoutingHint.Builder
    clearGroupUid()
    The group UID of the group that the client believes serves the range defined by `key` and `limit_key`.
    RoutingHint.Builder
    clearKey()
    The key / key range that this request accesses.
    RoutingHint.Builder
    clearLimitKey()
    If this request targets a key range, this is the exclusive end of the range.
    RoutingHint.Builder
    clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
     
    RoutingHint.Builder
    clearOperationUid()
    A session-scoped unique ID for the operation, computed client-side.
    RoutingHint.Builder
    clearSchemaGeneration()
    The schema generation of the recipe that was used to generate `key` and `limit_key`.
    RoutingHint.Builder
    clearSkippedTabletUid()
    If the client had multiple options for tablet selection, and some of its first choices were unhealthy (e.g., the server is unreachable, or `Tablet.skip` is true), this field will contain the tablet UIDs of those tablets, with their incarnations.
    RoutingHint.Builder
    clearSplitId()
    The split ID of the split that the client believes contains the range defined by `key` and `limit_key`.
    RoutingHint.Builder
    clearTabletUid()
    The tablet UID of the tablet from group `group_uid` that the client believes is best to serve this request.
    RoutingHint.Builder
    clone()
     
    String
    getClientLocation()
    If present, the client's current location.
    com.google.protobuf.ByteString
    getClientLocationBytes()
    If present, the client's current location.
    long
    getDatabaseId()
    The database ID of the database being accessed, see `CacheUpdate.database_id`.
    RoutingHint
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    long
    getGroupUid()
    The group UID of the group that the client believes serves the range defined by `key` and `limit_key`.
    com.google.protobuf.ByteString
    getKey()
    The key / key range that this request accesses.
    com.google.protobuf.ByteString
    getLimitKey()
    If this request targets a key range, this is the exclusive end of the range.
    long
    getOperationUid()
    A session-scoped unique ID for the operation, computed client-side.
    com.google.protobuf.ByteString
    getSchemaGeneration()
    The schema generation of the recipe that was used to generate `key` and `limit_key`.
    RoutingHint.SkippedTablet
    getSkippedTabletUid(int index)
    If the client had multiple options for tablet selection, and some of its first choices were unhealthy (e.g., the server is unreachable, or `Tablet.skip` is true), this field will contain the tablet UIDs of those tablets, with their incarnations.
    RoutingHint.SkippedTablet.Builder
    getSkippedTabletUidBuilder(int index)
    If the client had multiple options for tablet selection, and some of its first choices were unhealthy (e.g., the server is unreachable, or `Tablet.skip` is true), this field will contain the tablet UIDs of those tablets, with their incarnations.
    List<RoutingHint.SkippedTablet.Builder>
    getSkippedTabletUidBuilderList()
    If the client had multiple options for tablet selection, and some of its first choices were unhealthy (e.g., the server is unreachable, or `Tablet.skip` is true), this field will contain the tablet UIDs of those tablets, with their incarnations.
    int
    getSkippedTabletUidCount()
    If the client had multiple options for tablet selection, and some of its first choices were unhealthy (e.g., the server is unreachable, or `Tablet.skip` is true), this field will contain the tablet UIDs of those tablets, with their incarnations.
    List<RoutingHint.SkippedTablet>
    getSkippedTabletUidList()
    If the client had multiple options for tablet selection, and some of its first choices were unhealthy (e.g., the server is unreachable, or `Tablet.skip` is true), this field will contain the tablet UIDs of those tablets, with their incarnations.
    RoutingHint.SkippedTabletOrBuilder
    getSkippedTabletUidOrBuilder(int index)
    If the client had multiple options for tablet selection, and some of its first choices were unhealthy (e.g., the server is unreachable, or `Tablet.skip` is true), this field will contain the tablet UIDs of those tablets, with their incarnations.
    List<? extends RoutingHint.SkippedTabletOrBuilder>
    getSkippedTabletUidOrBuilderList()
    If the client had multiple options for tablet selection, and some of its first choices were unhealthy (e.g., the server is unreachable, or `Tablet.skip` is true), this field will contain the tablet UIDs of those tablets, with their incarnations.
    long
    getSplitId()
    The split ID of the split that the client believes contains the range defined by `key` and `limit_key`.
    long
    getTabletUid()
    The tablet UID of the tablet from group `group_uid` that the client believes is best to serve this request.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    RoutingHint.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    RoutingHint.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    RoutingHint.Builder
    mergeFrom(RoutingHint other)
     
    final RoutingHint.Builder
    mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
     
    RoutingHint.Builder
    removeSkippedTabletUid(int index)
    If the client had multiple options for tablet selection, and some of its first choices were unhealthy (e.g., the server is unreachable, or `Tablet.skip` is true), this field will contain the tablet UIDs of those tablets, with their incarnations.
    RoutingHint.Builder
    setClientLocation(String value)
    If present, the client's current location.
    RoutingHint.Builder
    setClientLocationBytes(com.google.protobuf.ByteString value)
    If present, the client's current location.
    RoutingHint.Builder
    setDatabaseId(long value)
    The database ID of the database being accessed, see `CacheUpdate.database_id`.
    RoutingHint.Builder
    setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
     
    RoutingHint.Builder
    setGroupUid(long value)
    The group UID of the group that the client believes serves the range defined by `key` and `limit_key`.
    RoutingHint.Builder
    setKey(com.google.protobuf.ByteString value)
    The key / key range that this request accesses.
    RoutingHint.Builder
    setLimitKey(com.google.protobuf.ByteString value)
    If this request targets a key range, this is the exclusive end of the range.
    RoutingHint.Builder
    setOperationUid(long value)
    A session-scoped unique ID for the operation, computed client-side.
    RoutingHint.Builder
    setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
     
    RoutingHint.Builder
    setSchemaGeneration(com.google.protobuf.ByteString value)
    The schema generation of the recipe that was used to generate `key` and `limit_key`.
    RoutingHint.Builder
    setSkippedTabletUid(int index, RoutingHint.SkippedTablet value)
    If the client had multiple options for tablet selection, and some of its first choices were unhealthy (e.g., the server is unreachable, or `Tablet.skip` is true), this field will contain the tablet UIDs of those tablets, with their incarnations.
    RoutingHint.Builder
    setSkippedTabletUid(int index, RoutingHint.SkippedTablet.Builder builderForValue)
    If the client had multiple options for tablet selection, and some of its first choices were unhealthy (e.g., the server is unreachable, or `Tablet.skip` is true), this field will contain the tablet UIDs of those tablets, with their incarnations.
    RoutingHint.Builder
    setSplitId(long value)
    The split ID of the split that the client believes contains the range defined by `key` and `limit_key`.
    RoutingHint.Builder
    setTabletUid(long value)
    The tablet UID of the tablet from group `group_uid` that the client believes is best to serve this request.
    final RoutingHint.Builder
    setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

    getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

    Methods inherited from class com.google.protobuf.AbstractMessage.Builder

    findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

    Methods inherited from interface com.google.protobuf.MessageLite.Builder

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<RoutingHint.Builder>

    • clear

      public RoutingHint.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<RoutingHint.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<RoutingHint.Builder>

    • getDefaultInstanceForType

      public RoutingHint getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public RoutingHint build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public RoutingHint buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • clone

      public RoutingHint.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<RoutingHint.Builder>

    • setField

      public RoutingHint.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<RoutingHint.Builder>

    • clearField

      public RoutingHint.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<RoutingHint.Builder>

    • clearOneof

      public RoutingHint.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<RoutingHint.Builder>

    • setRepeatedField

      public RoutingHint.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RoutingHint.Builder>

    • addRepeatedField

      public RoutingHint.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RoutingHint.Builder>

    • mergeFrom

      public RoutingHint.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RoutingHint.Builder>

    • mergeFrom

      public RoutingHint.Builder mergeFrom(RoutingHint other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<RoutingHint.Builder>

    • mergeFrom

      public RoutingHint.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RoutingHint.Builder>
      Throws:
      IOException

    • getOperationUid

      public long getOperationUid()
       A session-scoped unique ID for the operation, computed client-side.
 Requests with the same `operation_uid` should have a shared 'shape',
 meaning that some fields are expected to be the same, such as the SQL
 query, the target table/columns (for reads) etc. Requests with the same
 `operation_uid` are meant to differ only in fields like keys/key
 ranges/query parameters, transaction IDs, etc.

 `operation_uid` must be non-zero for `RoutingHint` to be valid.
      uint64 operation_uid = 1;
      Specified by:
      getOperationUid in interface RoutingHintOrBuilder
      Returns:
      The operationUid.

    • setOperationUid

      public RoutingHint.Builder setOperationUid(long value)
       A session-scoped unique ID for the operation, computed client-side.
 Requests with the same `operation_uid` should have a shared 'shape',
 meaning that some fields are expected to be the same, such as the SQL
 query, the target table/columns (for reads) etc. Requests with the same
 `operation_uid` are meant to differ only in fields like keys/key
 ranges/query parameters, transaction IDs, etc.

 `operation_uid` must be non-zero for `RoutingHint` to be valid.
      uint64 operation_uid = 1;
      Parameters:
      value - The operationUid to set.
      Returns:
      This builder for chaining.

    • clearOperationUid

      public RoutingHint.Builder clearOperationUid()
       A session-scoped unique ID for the operation, computed client-side.
 Requests with the same `operation_uid` should have a shared 'shape',
 meaning that some fields are expected to be the same, such as the SQL
 query, the target table/columns (for reads) etc. Requests with the same
 `operation_uid` are meant to differ only in fields like keys/key
 ranges/query parameters, transaction IDs, etc.

 `operation_uid` must be non-zero for `RoutingHint` to be valid.
      uint64 operation_uid = 1;
      Returns:
      This builder for chaining.

    • getDatabaseId

      public long getDatabaseId()
       The database ID of the database being accessed, see
 `CacheUpdate.database_id`. Should match the cache entries that were used
 to generate the rest of the fields in this `RoutingHint`.
      uint64 database_id = 2;
      Specified by:
      getDatabaseId in interface RoutingHintOrBuilder
      Returns:
      The databaseId.

    • setDatabaseId

      public RoutingHint.Builder setDatabaseId(long value)
       The database ID of the database being accessed, see
 `CacheUpdate.database_id`. Should match the cache entries that were used
 to generate the rest of the fields in this `RoutingHint`.
      uint64 database_id = 2;
      Parameters:
      value - The databaseId to set.
      Returns:
      This builder for chaining.

    • clearDatabaseId

      public RoutingHint.Builder clearDatabaseId()
       The database ID of the database being accessed, see
 `CacheUpdate.database_id`. Should match the cache entries that were used
 to generate the rest of the fields in this `RoutingHint`.
      uint64 database_id = 2;
      Returns:
      This builder for chaining.

    • getSchemaGeneration

      public com.google.protobuf.ByteString getSchemaGeneration()
       The schema generation of the recipe that was used to generate `key` and
 `limit_key`. See also `RecipeList.schema_generation`.
      bytes schema_generation = 3;
      Specified by:
      getSchemaGeneration in interface RoutingHintOrBuilder
      Returns:
      The schemaGeneration.

    • setSchemaGeneration

      public RoutingHint.Builder setSchemaGeneration(com.google.protobuf.ByteString value)
       The schema generation of the recipe that was used to generate `key` and
 `limit_key`. See also `RecipeList.schema_generation`.
      bytes schema_generation = 3;
      Parameters:
      value - The schemaGeneration to set.
      Returns:
      This builder for chaining.

    • clearSchemaGeneration

      public RoutingHint.Builder clearSchemaGeneration()
       The schema generation of the recipe that was used to generate `key` and
 `limit_key`. See also `RecipeList.schema_generation`.
      bytes schema_generation = 3;
      Returns:
      This builder for chaining.

    • getKey

      public com.google.protobuf.ByteString getKey()
       The key / key range that this request accesses. For operations that
 access a single key, `key` should be set and `limit_key` should be empty.
 For operations that access a key range, `key` and `limit_key` should both
 be set, to the inclusive start and exclusive end of the range respectively.

 The keys are encoded in "sortable string format" (ssformat), using a
 `KeyRecipe` that is appropriate for the request. See `KeyRecipe` for more
 details.
      bytes key = 4;
      Specified by:
      getKey in interface RoutingHintOrBuilder
      Returns:
      The key.

    • setKey

      public RoutingHint.Builder setKey(com.google.protobuf.ByteString value)
       The key / key range that this request accesses. For operations that
 access a single key, `key` should be set and `limit_key` should be empty.
 For operations that access a key range, `key` and `limit_key` should both
 be set, to the inclusive start and exclusive end of the range respectively.

 The keys are encoded in "sortable string format" (ssformat), using a
 `KeyRecipe` that is appropriate for the request. See `KeyRecipe` for more
 details.
      bytes key = 4;
      Parameters:
      value - The key to set.
      Returns:
      This builder for chaining.

    • clearKey

      public RoutingHint.Builder clearKey()
       The key / key range that this request accesses. For operations that
 access a single key, `key` should be set and `limit_key` should be empty.
 For operations that access a key range, `key` and `limit_key` should both
 be set, to the inclusive start and exclusive end of the range respectively.

 The keys are encoded in "sortable string format" (ssformat), using a
 `KeyRecipe` that is appropriate for the request. See `KeyRecipe` for more
 details.
      bytes key = 4;
      Returns:
      This builder for chaining.

    • getLimitKey

      public com.google.protobuf.ByteString getLimitKey()
       If this request targets a key range, this is the exclusive end of the
 range. See `key` for more details.
      bytes limit_key = 5;
      Specified by:
      getLimitKey in interface RoutingHintOrBuilder
      Returns:
      The limitKey.

    • setLimitKey

      public RoutingHint.Builder setLimitKey(com.google.protobuf.ByteString value)
       If this request targets a key range, this is the exclusive end of the
 range. See `key` for more details.
      bytes limit_key = 5;
      Parameters:
      value - The limitKey to set.
      Returns:
      This builder for chaining.

    • clearLimitKey

      public RoutingHint.Builder clearLimitKey()
       If this request targets a key range, this is the exclusive end of the
 range. See `key` for more details.
      bytes limit_key = 5;
      Returns:
      This builder for chaining.

    • getGroupUid

      public long getGroupUid()
       The group UID of the group that the client believes serves the range
 defined by `key` and `limit_key`. See `Range.group_uid` for more details.
      uint64 group_uid = 6;
      Specified by:
      getGroupUid in interface RoutingHintOrBuilder
      Returns:
      The groupUid.

    • setGroupUid

      public RoutingHint.Builder setGroupUid(long value)
       The group UID of the group that the client believes serves the range
 defined by `key` and `limit_key`. See `Range.group_uid` for more details.
      uint64 group_uid = 6;
      Parameters:
      value - The groupUid to set.
      Returns:
      This builder for chaining.

    • clearGroupUid

      public RoutingHint.Builder clearGroupUid()
       The group UID of the group that the client believes serves the range
 defined by `key` and `limit_key`. See `Range.group_uid` for more details.
      uint64 group_uid = 6;
      Returns:
      This builder for chaining.

    • getSplitId

      public long getSplitId()
       The split ID of the split that the client believes contains the range
 defined by `key` and `limit_key`. See `Range.split_id` for more details.
      uint64 split_id = 7;
      Specified by:
      getSplitId in interface RoutingHintOrBuilder
      Returns:
      The splitId.

    • setSplitId

      public RoutingHint.Builder setSplitId(long value)
       The split ID of the split that the client believes contains the range
 defined by `key` and `limit_key`. See `Range.split_id` for more details.
      uint64 split_id = 7;
      Parameters:
      value - The splitId to set.
      Returns:
      This builder for chaining.

    • clearSplitId

      public RoutingHint.Builder clearSplitId()
       The split ID of the split that the client believes contains the range
 defined by `key` and `limit_key`. See `Range.split_id` for more details.
      uint64 split_id = 7;
      Returns:
      This builder for chaining.

    • getTabletUid

      public long getTabletUid()
       The tablet UID of the tablet from group `group_uid` that the client
 believes is best to serve this request. See `Group.local_tablet_uids` and
 `Group.leader_tablet_uid`.
      uint64 tablet_uid = 8;
      Specified by:
      getTabletUid in interface RoutingHintOrBuilder
      Returns:
      The tabletUid.

    • setTabletUid

      public RoutingHint.Builder setTabletUid(long value)
       The tablet UID of the tablet from group `group_uid` that the client
 believes is best to serve this request. See `Group.local_tablet_uids` and
 `Group.leader_tablet_uid`.
      uint64 tablet_uid = 8;
      Parameters:
      value - The tabletUid to set.
      Returns:
      This builder for chaining.

    • clearTabletUid

      public RoutingHint.Builder clearTabletUid()
       The tablet UID of the tablet from group `group_uid` that the client
 believes is best to serve this request. See `Group.local_tablet_uids` and
 `Group.leader_tablet_uid`.
      uint64 tablet_uid = 8;
      Returns:
      This builder for chaining.

    • getSkippedTabletUidList

      public List<RoutingHint.SkippedTablet> getSkippedTabletUidList()
       If the client had multiple options for tablet selection, and some of its
 first choices were unhealthy (e.g., the server is unreachable, or
 `Tablet.skip` is true), this field will contain the tablet UIDs of those
 tablets, with their incarnations. The server may include a `CacheUpdate`
 with new locations for those tablets.
      repeated .google.spanner.v1.RoutingHint.SkippedTablet skipped_tablet_uid = 9;
      Specified by:
      getSkippedTabletUidList in interface RoutingHintOrBuilder

    • getSkippedTabletUidCount

      public int getSkippedTabletUidCount()
       If the client had multiple options for tablet selection, and some of its
 first choices were unhealthy (e.g., the server is unreachable, or
 `Tablet.skip` is true), this field will contain the tablet UIDs of those
 tablets, with their incarnations. The server may include a `CacheUpdate`
 with new locations for those tablets.
      repeated .google.spanner.v1.RoutingHint.SkippedTablet skipped_tablet_uid = 9;
      Specified by:
      getSkippedTabletUidCount in interface RoutingHintOrBuilder

    • getSkippedTabletUid

      public RoutingHint.SkippedTablet getSkippedTabletUid(int index)
       If the client had multiple options for tablet selection, and some of its
 first choices were unhealthy (e.g., the server is unreachable, or
 `Tablet.skip` is true), this field will contain the tablet UIDs of those
 tablets, with their incarnations. The server may include a `CacheUpdate`
 with new locations for those tablets.
      repeated .google.spanner.v1.RoutingHint.SkippedTablet skipped_tablet_uid = 9;
      Specified by:
      getSkippedTabletUid in interface RoutingHintOrBuilder

    • setSkippedTabletUid

      public RoutingHint.Builder setSkippedTabletUid(int index, RoutingHint.SkippedTablet value)
       If the client had multiple options for tablet selection, and some of its
 first choices were unhealthy (e.g., the server is unreachable, or
 `Tablet.skip` is true), this field will contain the tablet UIDs of those
 tablets, with their incarnations. The server may include a `CacheUpdate`
 with new locations for those tablets.
      repeated .google.spanner.v1.RoutingHint.SkippedTablet skipped_tablet_uid = 9;

    • setSkippedTabletUid

      public RoutingHint.Builder setSkippedTabletUid(int index, RoutingHint.SkippedTablet.Builder builderForValue)
       If the client had multiple options for tablet selection, and some of its
 first choices were unhealthy (e.g., the server is unreachable, or
 `Tablet.skip` is true), this field will contain the tablet UIDs of those
 tablets, with their incarnations. The server may include a `CacheUpdate`
 with new locations for those tablets.
      repeated .google.spanner.v1.RoutingHint.SkippedTablet skipped_tablet_uid = 9;

    • addSkippedTabletUid

      public RoutingHint.Builder addSkippedTabletUid(RoutingHint.SkippedTablet value)
       If the client had multiple options for tablet selection, and some of its
 first choices were unhealthy (e.g., the server is unreachable, or
 `Tablet.skip` is true), this field will contain the tablet UIDs of those
 tablets, with their incarnations. The server may include a `CacheUpdate`
 with new locations for those tablets.
      repeated .google.spanner.v1.RoutingHint.SkippedTablet skipped_tablet_uid = 9;

    • addSkippedTabletUid

      public RoutingHint.Builder addSkippedTabletUid(int index, RoutingHint.SkippedTablet value)
       If the client had multiple options for tablet selection, and some of its
 first choices were unhealthy (e.g., the server is unreachable, or
 `Tablet.skip` is true), this field will contain the tablet UIDs of those
 tablets, with their incarnations. The server may include a `CacheUpdate`
 with new locations for those tablets.
      repeated .google.spanner.v1.RoutingHint.SkippedTablet skipped_tablet_uid = 9;

    • addSkippedTabletUid

      public RoutingHint.Builder addSkippedTabletUid(RoutingHint.SkippedTablet.Builder builderForValue)
       If the client had multiple options for tablet selection, and some of its
 first choices were unhealthy (e.g., the server is unreachable, or
 `Tablet.skip` is true), this field will contain the tablet UIDs of those
 tablets, with their incarnations. The server may include a `CacheUpdate`
 with new locations for those tablets.
      repeated .google.spanner.v1.RoutingHint.SkippedTablet skipped_tablet_uid = 9;

    • addSkippedTabletUid

      public RoutingHint.Builder addSkippedTabletUid(int index, RoutingHint.SkippedTablet.Builder builderForValue)
       If the client had multiple options for tablet selection, and some of its
 first choices were unhealthy (e.g., the server is unreachable, or
 `Tablet.skip` is true), this field will contain the tablet UIDs of those
 tablets, with their incarnations. The server may include a `CacheUpdate`
 with new locations for those tablets.
      repeated .google.spanner.v1.RoutingHint.SkippedTablet skipped_tablet_uid = 9;

    • addAllSkippedTabletUid

      public RoutingHint.Builder addAllSkippedTabletUid(Iterable<? extends RoutingHint.SkippedTablet> values)
       If the client had multiple options for tablet selection, and some of its
 first choices were unhealthy (e.g., the server is unreachable, or
 `Tablet.skip` is true), this field will contain the tablet UIDs of those
 tablets, with their incarnations. The server may include a `CacheUpdate`
 with new locations for those tablets.
      repeated .google.spanner.v1.RoutingHint.SkippedTablet skipped_tablet_uid = 9;

    • clearSkippedTabletUid

      public RoutingHint.Builder clearSkippedTabletUid()
       If the client had multiple options for tablet selection, and some of its
 first choices were unhealthy (e.g., the server is unreachable, or
 `Tablet.skip` is true), this field will contain the tablet UIDs of those
 tablets, with their incarnations. The server may include a `CacheUpdate`
 with new locations for those tablets.
      repeated .google.spanner.v1.RoutingHint.SkippedTablet skipped_tablet_uid = 9;

    • removeSkippedTabletUid

      public RoutingHint.Builder removeSkippedTabletUid(int index)
       If the client had multiple options for tablet selection, and some of its
 first choices were unhealthy (e.g., the server is unreachable, or
 `Tablet.skip` is true), this field will contain the tablet UIDs of those
 tablets, with their incarnations. The server may include a `CacheUpdate`
 with new locations for those tablets.
      repeated .google.spanner.v1.RoutingHint.SkippedTablet skipped_tablet_uid = 9;

    • getSkippedTabletUidBuilder

      public RoutingHint.SkippedTablet.Builder getSkippedTabletUidBuilder(int index)
       If the client had multiple options for tablet selection, and some of its
 first choices were unhealthy (e.g., the server is unreachable, or
 `Tablet.skip` is true), this field will contain the tablet UIDs of those
 tablets, with their incarnations. The server may include a `CacheUpdate`
 with new locations for those tablets.
      repeated .google.spanner.v1.RoutingHint.SkippedTablet skipped_tablet_uid = 9;

    • getSkippedTabletUidOrBuilder

      public RoutingHint.SkippedTabletOrBuilder getSkippedTabletUidOrBuilder(int index)
       If the client had multiple options for tablet selection, and some of its
 first choices were unhealthy (e.g., the server is unreachable, or
 `Tablet.skip` is true), this field will contain the tablet UIDs of those
 tablets, with their incarnations. The server may include a `CacheUpdate`
 with new locations for those tablets.
      repeated .google.spanner.v1.RoutingHint.SkippedTablet skipped_tablet_uid = 9;
      Specified by:
      getSkippedTabletUidOrBuilder in interface RoutingHintOrBuilder

    • getSkippedTabletUidOrBuilderList

      public List<? extends RoutingHint.SkippedTabletOrBuilder> getSkippedTabletUidOrBuilderList()
       If the client had multiple options for tablet selection, and some of its
 first choices were unhealthy (e.g., the server is unreachable, or
 `Tablet.skip` is true), this field will contain the tablet UIDs of those
 tablets, with their incarnations. The server may include a `CacheUpdate`
 with new locations for those tablets.
      repeated .google.spanner.v1.RoutingHint.SkippedTablet skipped_tablet_uid = 9;
      Specified by:
      getSkippedTabletUidOrBuilderList in interface RoutingHintOrBuilder

    • addSkippedTabletUidBuilder

      public RoutingHint.SkippedTablet.Builder addSkippedTabletUidBuilder()
       If the client had multiple options for tablet selection, and some of its
 first choices were unhealthy (e.g., the server is unreachable, or
 `Tablet.skip` is true), this field will contain the tablet UIDs of those
 tablets, with their incarnations. The server may include a `CacheUpdate`
 with new locations for those tablets.
      repeated .google.spanner.v1.RoutingHint.SkippedTablet skipped_tablet_uid = 9;

    • addSkippedTabletUidBuilder

      public RoutingHint.SkippedTablet.Builder addSkippedTabletUidBuilder(int index)
       If the client had multiple options for tablet selection, and some of its
 first choices were unhealthy (e.g., the server is unreachable, or
 `Tablet.skip` is true), this field will contain the tablet UIDs of those
 tablets, with their incarnations. The server may include a `CacheUpdate`
 with new locations for those tablets.
      repeated .google.spanner.v1.RoutingHint.SkippedTablet skipped_tablet_uid = 9;

    • getSkippedTabletUidBuilderList

      public List<RoutingHint.SkippedTablet.Builder> getSkippedTabletUidBuilderList()
       If the client had multiple options for tablet selection, and some of its
 first choices were unhealthy (e.g., the server is unreachable, or
 `Tablet.skip` is true), this field will contain the tablet UIDs of those
 tablets, with their incarnations. The server may include a `CacheUpdate`
 with new locations for those tablets.
      repeated .google.spanner.v1.RoutingHint.SkippedTablet skipped_tablet_uid = 9;

    • getClientLocation

      public String getClientLocation()
       If present, the client's current location. This should be the name of a
 Google Cloud zone or region, such as "us-central1".

 If absent, the client's location will be assumed to be the same as the
 location of the server the client ends up connected to.

 Locations are primarily valuable for clients that connect from regions
 other than the ones that contain the Spanner database.
      string client_location = 10;
      Specified by:
      getClientLocation in interface RoutingHintOrBuilder
      Returns:
      The clientLocation.

    • getClientLocationBytes

      public com.google.protobuf.ByteString getClientLocationBytes()
       If present, the client's current location. This should be the name of a
 Google Cloud zone or region, such as "us-central1".

 If absent, the client's location will be assumed to be the same as the
 location of the server the client ends up connected to.

 Locations are primarily valuable for clients that connect from regions
 other than the ones that contain the Spanner database.
      string client_location = 10;
      Specified by:
      getClientLocationBytes in interface RoutingHintOrBuilder
      Returns:
      The bytes for clientLocation.

    • setClientLocation

      public RoutingHint.Builder setClientLocation(String value)
       If present, the client's current location. This should be the name of a
 Google Cloud zone or region, such as "us-central1".

 If absent, the client's location will be assumed to be the same as the
 location of the server the client ends up connected to.

 Locations are primarily valuable for clients that connect from regions
 other than the ones that contain the Spanner database.
      string client_location = 10;
      Parameters:
      value - The clientLocation to set.
      Returns:
      This builder for chaining.

    • clearClientLocation

      public RoutingHint.Builder clearClientLocation()
       If present, the client's current location. This should be the name of a
 Google Cloud zone or region, such as "us-central1".

 If absent, the client's location will be assumed to be the same as the
 location of the server the client ends up connected to.

 Locations are primarily valuable for clients that connect from regions
 other than the ones that contain the Spanner database.
      string client_location = 10;
      Returns:
      This builder for chaining.

    • setClientLocationBytes

      public RoutingHint.Builder setClientLocationBytes(com.google.protobuf.ByteString value)
       If present, the client's current location. This should be the name of a
 Google Cloud zone or region, such as "us-central1".

 If absent, the client's location will be assumed to be the same as the
 location of the server the client ends up connected to.

 Locations are primarily valuable for clients that connect from regions
 other than the ones that contain the Spanner database.
      string client_location = 10;
      Parameters:
      value - The bytes for clientLocation to set.
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final RoutingHint.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RoutingHint.Builder>

    • mergeUnknownFields

      public final RoutingHint.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RoutingHint.Builder>