Package com.google.spanner.v1

Interface RoutingHintOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
RoutingHint, RoutingHint.Builder
public interface RoutingHintOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    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`.
    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.
    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.

    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

    • getOperationUid

      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;
      Returns:
      The operationUid.

    • getDatabaseId

      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;
      Returns:
      The databaseId.

    • getSchemaGeneration

      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;
      Returns:
      The schemaGeneration.

    • getKey

      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;
      Returns:
      The key.

    • getLimitKey

      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;
      Returns:
      The limitKey.

    • getGroupUid

      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;
      Returns:
      The groupUid.

    • getSplitId

      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;
      Returns:
      The splitId.

    • getTabletUid

      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;
      Returns:
      The tabletUid.

    • getSkippedTabletUidList

      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;

    • getSkippedTabletUid

      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;

    • getSkippedTabletUidCount

      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;

    • getSkippedTabletUidOrBuilderList

      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;

    • getSkippedTabletUidOrBuilder

      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;

    • getClientLocation

      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;
      Returns:
      The clientLocation.

    • getClientLocationBytes

      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;
      Returns:
      The bytes for clientLocation.