Package com.google.spanner.v1

Interface TabletOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getDistance()
    Distances help the client pick the closest tablet out of the list of tablets for a given request.
    com.google.protobuf.ByteString
    getIncarnation()
    `incarnation` indicates the freshness of the tablet information contained in this proto.
    String
    getLocation()
    Where this tablet is located.
    com.google.protobuf.ByteString
    getLocationBytes()
    Where this tablet is located.
    Tablet.Role
    getRole()
    The role of the tablet.
    int
    getRoleValue()
    The role of the tablet.
    String
    getServerAddress()
    The address of the server that is serving this tablet -- either an IP address or DNS hostname and a port number.
    com.google.protobuf.ByteString
    getServerAddressBytes()
    The address of the server that is serving this tablet -- either an IP address or DNS hostname and a port number.
    boolean
    getSkip()
    If true, the tablet should not be chosen by the client.
    long
    getTabletUid()
    The UID of the tablet, unique within the database.

    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

    • getTabletUid

      long getTabletUid()
       The UID of the tablet, unique within the database. Matches the
 `tablet_uids` and `leader_tablet_uid` fields in `Group`.
      uint64 tablet_uid = 1;
      Returns:
      The tabletUid.

    • getServerAddress

      String getServerAddress()
       The address of the server that is serving this tablet -- either an IP
 address or DNS hostname and a port number.
      string server_address = 2;
      Returns:
      The serverAddress.

    • getServerAddressBytes

      com.google.protobuf.ByteString getServerAddressBytes()
       The address of the server that is serving this tablet -- either an IP
 address or DNS hostname and a port number.
      string server_address = 2;
      Returns:
      The bytes for serverAddress.

    • getLocation

      String getLocation()
       Where this tablet is located. This is the name of a Google Cloud region,
 such as "us-central1".
      string location = 3;
      Returns:
      The location.

    • getLocationBytes

      com.google.protobuf.ByteString getLocationBytes()
       Where this tablet is located. This is the name of a Google Cloud region,
 such as "us-central1".
      string location = 3;
      Returns:
      The bytes for location.

    • getRoleValue

      int getRoleValue()
       The role of the tablet.
      .google.spanner.v1.Tablet.Role role = 4;
      Returns:
      The enum numeric value on the wire for role.

    • getRole

      Tablet.Role getRole()
       The role of the tablet.
      .google.spanner.v1.Tablet.Role role = 4;
      Returns:
      The role.

    • getIncarnation

      com.google.protobuf.ByteString getIncarnation()
       `incarnation` indicates the freshness of the tablet information contained
 in this proto. Incarnations can be compared lexicographically; if
 incarnation A is greater than incarnation B, then the `Tablet`
 corresponding to A is newer than the `Tablet` corresponding to B, and
 should be used preferentially.
      bytes incarnation = 5;
      Returns:
      The incarnation.

    • getDistance

      int getDistance()
       Distances help the client pick the closest tablet out of the list of
 tablets for a given request. Tablets with lower distances should generally
 be preferred. Tablets with the same distance are approximately equally
 close; the client can choose arbitrarily.

 Distances do not correspond precisely to expected latency, geographical
 distance, or anything else. Distances should be compared only between
 tablets of the same group; they are not meaningful between different
 groups.

 A value of zero indicates that the tablet may be in the same zone as
 the client, and have minimum network latency. A value less than or equal to
 five indicates that the tablet is thought to be in the same region as the
 client, and may have a few milliseconds of network latency. Values greater
 than five are most likely in a different region, with non-trivial network
 latency.

 Clients should use the following algorithm:
   * If the request is using a directed read, eliminate any tablets that
     do not match the directed read's target zone and/or replica type.
   * (Read-write transactions only) Choose leader tablet if it has an
     distance <=5.
   * Group and sort tablets by distance. Choose a random
     tablet with the lowest distance. If the request
     is not a directed read, only consider replicas with distances <=5.
   * Send the request to the fallback endpoint.

 The tablet picked by this algorithm may be skipped, either because it is
 marked as `skip` by the server or because the corresponding server is
 unreachable, flow controlled, etc. Skipped tablets should be added to the
 `skipped_tablet_uid` field in `RoutingHint`; the algorithm above should
 then be re-run without including the skipped tablet(s) to pick the next
 best tablet.
      uint32 distance = 6;
      Returns:
      The distance.

    • getSkip

      boolean getSkip()
       If true, the tablet should not be chosen by the client. Typically, this
 signals that the tablet is unhealthy in some way. Tablets with `skip`
 set to true should be reported back to the server in
 `RoutingHint.skipped_tablet_uid`; this cues the server to send updated
 information for this tablet should it become usable again.
      bool skip = 7;
      Returns:
      The skip.