Cloud Bigtable V2 Client - Class ListHotTabletsRequest (1.25.0)

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

Request message for BigtableInstanceAdmin.ListHotTablets.

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

Namespace

Google \ Cloud \ Bigtable \ Admin \ V2

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The cluster name to list hot tablets. Value is in the following form: projects/{project}/instances/{instance}/clusters/{cluster}.

↳ start_time Google\Protobuf\Timestamp

The start time to list hot tablets. The hot tablets in the response will have start times between the requested start time and end time. Start time defaults to Now if it is unset, and end time defaults to Now - 24 hours if it is unset. The start time should be less than the end time, and the maximum allowed time range between start time and end time is 48 hours. Start time and end time should have values between Now and Now - 14 days.

↳ end_time Google\Protobuf\Timestamp

The end time to list hot tablets.

↳ page_size int

Maximum number of results per page. A page_size that is empty or zero lets the server choose the number of items to return. A page_size which is strictly positive will return at most that many items. A negative page_size will cause an error. Following the first request, subsequent paginated calls do not need a page_size field. If a page_size is set in subsequent calls, it must match the page_size given in the first request.

↳ page_token string

The value of next_page_token returned by a previous call.

getParent

Required. The cluster name to list hot tablets.

Value is in the following form: projects/{project}/instances/{instance}/clusters/{cluster}.

Returns
TypeDescription
string

setParent

Required. The cluster name to list hot tablets.

Value is in the following form: projects/{project}/instances/{instance}/clusters/{cluster}.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getStartTime

The start time to list hot tablets. The hot tablets in the response will have start times between the requested start time and end time. Start time defaults to Now if it is unset, and end time defaults to Now - 24 hours if it is unset. The start time should be less than the end time, and the maximum allowed time range between start time and end time is 48 hours.

Start time and end time should have values between Now and Now - 14 days.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasStartTime

clearStartTime

setStartTime

The start time to list hot tablets. The hot tablets in the response will have start times between the requested start time and end time. Start time defaults to Now if it is unset, and end time defaults to Now - 24 hours if it is unset. The start time should be less than the end time, and the maximum allowed time range between start time and end time is 48 hours.

Start time and end time should have values between Now and Now - 14 days.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getEndTime

The end time to list hot tablets.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasEndTime

clearEndTime

setEndTime

The end time to list hot tablets.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getPageSize

Maximum number of results per page.

A page_size that is empty or zero lets the server choose the number of items to return. A page_size which is strictly positive will return at most that many items. A negative page_size will cause an error. Following the first request, subsequent paginated calls do not need a page_size field. If a page_size is set in subsequent calls, it must match the page_size given in the first request.

Returns
TypeDescription
int

setPageSize

Maximum number of results per page.

A page_size that is empty or zero lets the server choose the number of items to return. A page_size which is strictly positive will return at most that many items. A negative page_size will cause an error. Following the first request, subsequent paginated calls do not need a page_size field. If a page_size is set in subsequent calls, it must match the page_size given in the first request.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

The value of next_page_token returned by a previous call.

Returns
TypeDescription
string

setPageToken

The value of next_page_token returned by a previous call.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
parent string

Required. The cluster name to list hot tablets. Value is in the following form: projects/{project}/instances/{instance}/clusters/{cluster}. Please see Google\Cloud\Bigtable\Admin\V2\BigtableInstanceAdminClient::clusterName() for help formatting this field.

Returns
TypeDescription
Google\Cloud\Bigtable\Admin\V2\ListHotTabletsRequest