Reference documentation and code samples for the Cloud Bigtable V2 Client class ListTablesRequest.
Request message for google.bigtable.admin.v2.BigtableTableAdmin.ListTables
Generated from protobuf message google.bigtable.admin.v2.ListTablesRequest
Namespace
Google \ Cloud \ Bigtable \ Admin \ V2Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data | arrayOptional. Data for populating the Message object. |
↳ parent | stringRequired. The unique name of the instance for which tables should be listed. Values are of the form |
↳ view | intThe view to be applied to the returned tables' fields. NAME_ONLY view (default) and REPLICATION_VIEW are supported. |
↳ page_size | intMaximum number of results per page. A page_size of 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 are not required to pass a page_size. If a page_size is set in subsequent calls, it must match the page_size given in the first request. |
↳ page_token | stringThe value of |
getParent
Required. The unique name of the instance for which tables should be listed. Values are of the form projects/{project}/instances/{instance}.
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
Required. The unique name of the instance for which tables should be listed. Values are of the form projects/{project}/instances/{instance}.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getView
The view to be applied to the returned tables' fields.
NAME_ONLY view (default) and REPLICATION_VIEW are supported.
| Returns | |
|---|---|
| Type | Description |
int | |
setView
The view to be applied to the returned tables' fields.
NAME_ONLY view (default) and REPLICATION_VIEW are supported.
| Parameter | |
|---|---|
| Name | Description |
var | int |
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageSize
Maximum number of results per page.
A page_size of 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 are not required to pass a page_size. If a page_size is set in subsequent calls, it must match the page_size given in the first request.
| Returns | |
|---|---|
| Type | Description |
int | |
setPageSize
Maximum number of results per page.
A page_size of 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 are not required to pass a page_size. If a page_size is set in subsequent calls, it must match the page_size given in the first request.
| Parameter | |
|---|---|
| Name | Description |
var | int |
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageToken
The value of next_page_token returned by a previous call.
| Returns | |
|---|---|
| Type | Description |
string | |
setPageToken
The value of next_page_token returned by a previous call.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
static::build
| Parameter | |
|---|---|
| Name | Description |
parent | stringRequired. The unique name of the instance for which tables should be listed. Values are of the form |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Bigtable\Admin\V2\ListTablesRequest | |