Reference documentation and code samples for the Cloud Spanner V1 Client class ListInstancePartitionsRequest.
The request for ListInstancePartitions.
Generated from protobuf message google.spanner.admin.instance.v1.ListInstancePartitionsRequest
Namespace
Google \ Cloud \ Spanner \ Admin \ Instance \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The instance whose instance partitions should be listed. Values are of the form |
↳ page_size |
int
Number of instance partitions to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size. |
↳ page_token |
string
If non-empty, |
↳ instance_partition_deadline |
Google\Protobuf\Timestamp
Optional. Deadline used while retrieving metadata for instance partitions. Instance partitions whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancePartitionsResponse. |
getParent
Required. The instance whose instance partitions should be listed. Values
are of the form projects/<project>/instances/<instance>.
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. The instance whose instance partitions should be listed. Values
are of the form projects/<project>/instances/<instance>.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageSize
Number of instance partitions to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
| Returns | |
|---|---|
| Type | Description |
int |
|
setPageSize
Number of instance partitions to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageToken
If non-empty, page_token should contain a
next_page_token
from a previous
ListInstancePartitionsResponse.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
If non-empty, page_token should contain a
next_page_token
from a previous
ListInstancePartitionsResponse.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getInstancePartitionDeadline
Optional. Deadline used while retrieving metadata for instance partitions.
Instance partitions whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancePartitionsResponse.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasInstancePartitionDeadline
clearInstancePartitionDeadline
setInstancePartitionDeadline
Optional. Deadline used while retrieving metadata for instance partitions.
Instance partitions whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancePartitionsResponse.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameter | |
|---|---|
| Name | Description |
parent |
string
Required. The instance whose instance partitions should be listed. Values
are of the form |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Spanner\Admin\Instance\V1\ListInstancePartitionsRequest |
|