Cloud Bigtable V2 Client - Class HotTablet (2.0.1)

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

A tablet is a defined by a start and end key and is explained in https://cloud.google.com/bigtable/docs/overview#architecture and https://cloud.google.com/bigtable/docs/performance#optimization .

A Hot tablet is a tablet that exhibits high average cpu usage during the time interval from start time to end time.

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

Namespace

Google \ Cloud \ Bigtable \ Admin \ V2

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ name
string

The unique name of the hot tablet. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}/hotTablets/[a-zA-Z0-9_-]* .

↳ table_name
string

Name of the table that contains the tablet. Values are of the form projects/{project}/instances/{instance}/tables/[_a-zA-Z0-9][-_.a-zA-Z0-9]* .

↳ start_time
Google\Protobuf\Timestamp

Output only. The start time of the hot tablet.

↳ end_time
Google\Protobuf\Timestamp

Output only. The end time of the hot tablet.

↳ start_key
string

Tablet Start Key (inclusive).

↳ end_key
string

Tablet End Key (inclusive).

↳ node_cpu_usage_percent
float

Output only. The average CPU usage spent by a node on this tablet over the start_time to end_time time range. The percentage is the amount of CPU used by the node to serve the tablet, from 0% (tablet was not interacted with) to 100% (the node spent all cycles serving the hot tablet).

getName

The unique name of the hot tablet. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}/hotTablets/[a-zA-Z0-9_-]* .

Returns
Type
Description
string

setName

The unique name of the hot tablet. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}/hotTablets/[a-zA-Z0-9_-]* .

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getTableName

Name of the table that contains the tablet. Values are of the form projects/{project}/instances/{instance}/tables/[_a-zA-Z0-9][-_.a-zA-Z0-9]* .

Returns
Type
Description
string

setTableName

Name of the table that contains the tablet. Values are of the form projects/{project}/instances/{instance}/tables/[_a-zA-Z0-9][-_.a-zA-Z0-9]* .

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getStartTime

Output only. The start time of the hot tablet.

Returns
Type
Description

hasStartTime

clearStartTime

setStartTime

Output only. The start time of the hot tablet.

Parameter
Name
Description
Returns
Type
Description
$this

getEndTime

Output only. The end time of the hot tablet.

Returns
Type
Description

hasEndTime

clearEndTime

setEndTime

Output only. The end time of the hot tablet.

Parameter
Name
Description
Returns
Type
Description
$this

getStartKey

Tablet Start Key (inclusive).

Returns
Type
Description
string

setStartKey

Tablet Start Key (inclusive).

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getEndKey

Tablet End Key (inclusive).

Returns
Type
Description
string

setEndKey

Tablet End Key (inclusive).

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getNodeCpuUsagePercent

Output only. The average CPU usage spent by a node on this tablet over the start_time to end_time time range. The percentage is the amount of CPU used by the node to serve the tablet, from 0% (tablet was not interacted with) to 100% (the node spent all cycles serving the hot tablet).

Returns
Type
Description
float

setNodeCpuUsagePercent

Output only. The average CPU usage spent by a node on this tablet over the start_time to end_time time range. The percentage is the amount of CPU used by the node to serve the tablet, from 0% (tablet was not interacted with) to 100% (the node spent all cycles serving the hot tablet).

Parameter
Name
Description
var
float
Returns
Type
Description
$this
Create a Mobile Website
View Site in Mobile | Classic
Share by: