clusters_memory_layer

Creates, updates, deletes, gets or lists a clusters_memory_layer resource.

Overview

Name	clusters_memory_layer
Type	Resource
Id	google.bigtableadmin.clusters_memory_layer

Fields

The following fields are returned by SELECT queries:

get_memory_layer

Name	Datatype	Description
name	string	Identifier. Name of the memory layer. This is always: "projects/{project}/instances/{instance}/clusters/{cluster}/memoryLayer".
etag	string	Optional. The etag for this memory layer. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The server returns an ABORTED error on a mismatched etag.
memoryConfig	object	The configuration of this memory layer. Set an empty memory_config to enable the memory layer. Unset this to disable the memory layer. (id: GoogleBigtableAdminV2MemoryLayerMemoryConfig)
state	string	Output only. The current state of the memory layer. (STATE_NOT_KNOWN, READY, ENABLING, RESIZING, DISABLED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_memory_layer	select	projectsId, instancesId, clustersId		Gets information about the memory layer of a cluster.
update_memory_layer	update	projectsId, instancesId, clustersId	updateMask	Updates the memory layer of a cluster. To enable the memory layer, set the memory_config. To disable the memory layer, unset the memory_config.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
clustersId	string
instancesId	string
projectsId	string
updateMask	string (google-fieldmask)

SELECT examples

get_memory_layer

Gets information about the memory layer of a cluster.

SELECT
name,
etag,
memoryConfig,
state
FROM google.bigtableadmin.clusters_memory_layer
WHERE projectsId = '{{ projectsId }}' -- required
AND instancesId = '{{ instancesId }}' -- required
AND clustersId = '{{ clustersId }}' -- required
;

UPDATE examples

update_memory_layer

Updates the memory layer of a cluster. To enable the memory layer, set the memory_config. To disable the memory layer, unset the memory_config.

UPDATE google.bigtableadmin.clusters_memory_layer
SET 
data__etag = '{{ etag }}',
data__memoryConfig = '{{ memoryConfig }}',
data__name = '{{ name }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND instancesId = '{{ instancesId }}' --required
AND clustersId = '{{ clustersId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;