Cloud Bigtable V2 Client - Class MemoryLayer (2.29.0)

Reference documentation and code samples for the Cloud Bigtable V2 Client class MemoryLayer.

The memory layer of a cluster. A memory layer serves reads from memory without hitting the backing persistent data store.

Generated from protobuf message google.bigtable.admin.v2.MemoryLayer

Namespace

Google \ Cloud \ Bigtable \ Admin \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Identifier. Name of the memory layer. This is always: "projects/{project}/instances/{instance}/clusters/{cluster}/memoryLayer".

↳ memory_config MemoryLayer\MemoryConfig

The configuration of this memory layer. Set an empty memory_config to enable the memory layer. Unset this to disable the memory layer.

↳ 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.

↳ state int

Output only. The current state of the memory layer.

getName

Identifier. Name of the memory layer. This is always: "projects/{project}/instances/{instance}/clusters/{cluster}/memoryLayer".

Returns
Type Description
string

setName

Identifier. Name of the memory layer. This is always: "projects/{project}/instances/{instance}/clusters/{cluster}/memoryLayer".

Parameter
Name Description
var string
Returns
Type Description
$this

getMemoryConfig

The configuration of this memory layer. Set an empty memory_config to enable the memory layer. Unset this to disable the memory layer.

Returns
Type Description
MemoryLayer\MemoryConfig|null

hasMemoryConfig

clearMemoryConfig

setMemoryConfig

The configuration of this memory layer. Set an empty memory_config to enable the memory layer. Unset this to disable the memory layer.

Parameter
Name Description
var MemoryLayer\MemoryConfig
Returns
Type Description
$this

getEtag

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.

Returns
Type Description
string

setEtag

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getState

Output only. The current state of the memory layer.

Returns
Type Description
int Enum of type State.

setState

Output only. The current state of the memory layer.

Parameter
Name Description
var int

Enum of type State.

Returns
Type Description
$this