Cloud Spanner V1 Client - Class CacheUpdate (2.1.0)

Reference documentation and code samples for the Cloud Spanner V1 Client class CacheUpdate.

A CacheUpdate expresses a set of changes the client should incorporate into its location cache. These changes may or may not be newer than what the client has in its cache, and should be discarded if necessary. CacheUpdates can be obtained in response to requests that included a RoutingHint field, but may also be obtained by explicit location-fetching RPCs which may be added in the future.

Generated from protobuf message google.spanner.v1.CacheUpdate

Namespace

Google \ Cloud \ Spanner \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ database_id int|string

An internal ID for the database. Database names can be reused if a database is deleted and re-created. Each time the database is re-created, it will get a new database ID, which will never be re-used for any other database.

↳ range array<Range>

A list of ranges to be cached.

↳ group array<Group>

A list of groups to be cached.

↳ key_recipes RecipeList

A list of recipes to be cached.

getDatabaseId

An internal ID for the database. Database names can be reused if a database is deleted and re-created. Each time the database is re-created, it will get a new database ID, which will never be re-used for any other database.

Returns
Type Description
int|string

setDatabaseId

An internal ID for the database. Database names can be reused if a database is deleted and re-created. Each time the database is re-created, it will get a new database ID, which will never be re-used for any other database.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getRange

A list of ranges to be cached.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setRange

A list of ranges to be cached.

Parameter
Name Description
var array<Range>
Returns
Type Description
$this

getGroup

A list of groups to be cached.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setGroup

A list of groups to be cached.

Parameter
Name Description
var array<Group>
Returns
Type Description
$this

getKeyRecipes

A list of recipes to be cached.

Returns
Type Description
RecipeList|null

hasKeyRecipes

clearKeyRecipes

setKeyRecipes

A list of recipes to be cached.

Parameter
Name Description
var RecipeList
Returns
Type Description
$this