Interface RoutingHintOrBuilder (6.107.0)

public interface RoutingHintOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getClientLocation()

public abstract 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
Type	Description
`String`	The clientLocation.

getClientLocationBytes()

public abstract 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
Type	Description
`ByteString`	The bytes for clientLocation.

getDatabaseId()

public abstract 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
Type	Description
`long`	The databaseId.

getGroupUid()

public abstract 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
Type	Description
`long`	The groupUid.

getKey()

public abstract 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
Type	Description
`ByteString`	The key.

getLimitKey()

public abstract 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
Type	Description
`ByteString`	The limitKey.

getOperationUid()

public abstract 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
Type	Description
`long`	The operationUid.

getSchemaGeneration()

public abstract 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
Type	Description
`ByteString`	The schemaGeneration.

getSkippedTabletUid(int index)

public abstract 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.