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 \ V1
Methods
__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 projects/<project>/instances/<instance>. Use {instance} = '-' to list instance partitions for all Instances in a project, e.g., projects/myproject/instances/-.
↳ 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.
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>. Use {instance}
= '-' to list instance partitions for all Instances in a project, e.g.,
projects/myproject/instances/-.
Returns
Type
Description
string
setParent
Required. The instance whose instance partitions should be listed. Values
are of the form projects/<project>/instances/<instance>. Use {instance}
= '-' to list instance partitions for all Instances in a project, e.g.,
projects/myproject/instances/-.
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.
Required. The instance whose instance partitions should be listed. Values
are of the form projects/<project>/instances/<instance>. Use {instance}
= '-' to list instance partitions for all Instances in a project, e.g.,
projects/myproject/instances/-. Please see
InstanceAdminClient::instanceName() for help formatting this field.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud Spanner V1 Client - Class ListInstancePartitionsRequest (1.104.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.104.0 (latest)](/php/docs/reference/cloud-spanner/latest/Admin.Instance.V1.ListInstancePartitionsRequest)\n- [1.103.0](/php/docs/reference/cloud-spanner/1.103.0/Admin.Instance.V1.ListInstancePartitionsRequest)\n- [1.102.0](/php/docs/reference/cloud-spanner/1.102.0/Admin.Instance.V1.ListInstancePartitionsRequest)\n- [1.101.0](/php/docs/reference/cloud-spanner/1.101.0/Admin.Instance.V1.ListInstancePartitionsRequest)\n- [1.100.0](/php/docs/reference/cloud-spanner/1.100.0/Admin.Instance.V1.ListInstancePartitionsRequest)\n- [1.98.0](/php/docs/reference/cloud-spanner/1.98.0/Admin.Instance.V1.ListInstancePartitionsRequest)\n- [1.97.0](/php/docs/reference/cloud-spanner/1.97.0/Admin.Instance.V1.ListInstancePartitionsRequest)\n- [1.96.0](/php/docs/reference/cloud-spanner/1.96.0/Admin.Instance.V1.ListInstancePartitionsRequest)\n- [1.95.0](/php/docs/reference/cloud-spanner/1.95.0/Admin.Instance.V1.ListInstancePartitionsRequest)\n- [1.94.0](/php/docs/reference/cloud-spanner/1.94.0/Admin.Instance.V1.ListInstancePartitionsRequest)\n- [1.93.1](/php/docs/reference/cloud-spanner/1.93.1/Admin.Instance.V1.ListInstancePartitionsRequest)\n- [1.92.1](/php/docs/reference/cloud-spanner/1.92.1/Admin.Instance.V1.ListInstancePartitionsRequest)\n- [1.91.0](/php/docs/reference/cloud-spanner/1.91.0/Admin.Instance.V1.ListInstancePartitionsRequest)\n- [1.90.0](/php/docs/reference/cloud-spanner/1.90.0/Admin.Instance.V1.ListInstancePartitionsRequest)\n- [1.89.0](/php/docs/reference/cloud-spanner/1.89.0/Admin.Instance.V1.ListInstancePartitionsRequest)\n- [1.88.0](/php/docs/reference/cloud-spanner/1.88.0/Admin.Instance.V1.ListInstancePartitionsRequest)\n- [1.87.0](/php/docs/reference/cloud-spanner/1.87.0/Admin.Instance.V1.ListInstancePartitionsRequest)\n- [1.86.0](/php/docs/reference/cloud-spanner/1.86.0/Admin.Instance.V1.ListInstancePartitionsRequest)\n- [1.85.0](/php/docs/reference/cloud-spanner/1.85.0/Admin.Instance.V1.ListInstancePartitionsRequest)\n- [1.84.0](/php/docs/reference/cloud-spanner/1.84.0/Admin.Instance.V1.ListInstancePartitionsRequest)\n- [1.83.0](/php/docs/reference/cloud-spanner/1.83.0/Admin.Instance.V1.ListInstancePartitionsRequest)\n- [1.82.0](/php/docs/reference/cloud-spanner/1.82.0/Admin.Instance.V1.ListInstancePartitionsRequest)\n- [1.81.0](/php/docs/reference/cloud-spanner/1.81.0/Admin.Instance.V1.ListInstancePartitionsRequest)\n- [1.80.0](/php/docs/reference/cloud-spanner/1.80.0/Admin.Instance.V1.ListInstancePartitionsRequest)\n- [1.79.0](/php/docs/reference/cloud-spanner/1.79.0/Admin.Instance.V1.ListInstancePartitionsRequest)\n- [1.78.0](/php/docs/reference/cloud-spanner/1.78.0/Admin.Instance.V1.ListInstancePartitionsRequest)\n- [1.77.0](/php/docs/reference/cloud-spanner/1.77.0/Admin.Instance.V1.ListInstancePartitionsRequest)\n- [1.76.1](/php/docs/reference/cloud-spanner/1.76.1/Admin.Instance.V1.ListInstancePartitionsRequest)\n- [1.68.0](/php/docs/reference/cloud-spanner/1.68.0/Admin.Instance.V1.ListInstancePartitionsRequest)\n- [1.67.0](/php/docs/reference/cloud-spanner/1.67.0/Admin.Instance.V1.ListInstancePartitionsRequest)\n- [1.66.0](/php/docs/reference/cloud-spanner/1.66.0/Admin.Instance.V1.ListInstancePartitionsRequest)\n- [1.65.0](/php/docs/reference/cloud-spanner/1.65.0/Admin.Instance.V1.ListInstancePartitionsRequest)\n- [1.64.0](/php/docs/reference/cloud-spanner/1.64.0/Admin.Instance.V1.ListInstancePartitionsRequest)\n- [1.63.2](/php/docs/reference/cloud-spanner/1.63.2/Admin.Instance.V1.ListInstancePartitionsRequest)\n- [1.62.1](/php/docs/reference/cloud-spanner/1.62.1/Admin.Instance.V1.ListInstancePartitionsRequest)\n- [1.61.0](/php/docs/reference/cloud-spanner/1.61.0/Admin.Instance.V1.ListInstancePartitionsRequest)\n- [1.60.0](/php/docs/reference/cloud-spanner/1.60.0/Admin.Instance.V1.ListInstancePartitionsRequest)\n- [1.59.0](/php/docs/reference/cloud-spanner/1.59.0/Admin.Instance.V1.ListInstancePartitionsRequest)\n- [1.58.4](/php/docs/reference/cloud-spanner/1.58.4/Admin.Instance.V1.ListInstancePartitionsRequest)\n- [1.57.0](/php/docs/reference/cloud-spanner/1.57.0/Admin.Instance.V1.ListInstancePartitionsRequest)\n- [1.56.0](/php/docs/reference/cloud-spanner/1.56.0/Admin.Instance.V1.ListInstancePartitionsRequest)\n- [1.55.0](/php/docs/reference/cloud-spanner/1.55.0/Admin.Instance.V1.ListInstancePartitionsRequest)\n- [1.54.2](/php/docs/reference/cloud-spanner/1.54.2/Admin.Instance.V1.ListInstancePartitionsRequest) \nReference documentation and code samples for the Cloud Spanner V1 Client class ListInstancePartitionsRequest.\n\nThe request for\nListInstancePartitions.\n\nGenerated from protobuf message `google.spanner.admin.instance.v1.ListInstancePartitionsRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Spanner \\\\ Admin \\\\ Instance \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The instance whose instance partitions should be listed. Values\nare of the form `projects/\u003cproject\u003e/instances/\u003cinstance\u003e`. Use `{instance}\n= '-'` to list instance partitions for all Instances in a project, e.g.,\n`projects/myproject/instances/-`.\n\n### setParent\n\nRequired. The instance whose instance partitions should be listed. Values\nare of the form `projects/\u003cproject\u003e/instances/\u003cinstance\u003e`. Use `{instance}\n= '-'` to list instance partitions for all Instances in a project, e.g.,\n`projects/myproject/instances/-`.\n\n### getPageSize\n\nNumber of instance partitions to be returned in the response. If 0 or less,\ndefaults to the server's maximum allowed page size.\n\n### setPageSize\n\nNumber of instance partitions to be returned in the response. If 0 or less,\ndefaults to the server's maximum allowed page size.\n\n### getPageToken\n\nIf non-empty, `page_token` should contain a\n[next_page_token](/php/docs/reference/cloud-spanner/latest/Admin.Instance.V1.ListInstancePartitionsResponse#_Google_Cloud_Spanner_Admin_Instance_V1_ListInstancePartitionsResponse__getNextPageToken__)\nfrom a previous\n[ListInstancePartitionsResponse](/php/docs/reference/cloud-spanner/latest/Admin.Instance.V1.ListInstancePartitionsResponse).\n\n### setPageToken\n\nIf non-empty, `page_token` should contain a\n[next_page_token](/php/docs/reference/cloud-spanner/latest/Admin.Instance.V1.ListInstancePartitionsResponse#_Google_Cloud_Spanner_Admin_Instance_V1_ListInstancePartitionsResponse__getNextPageToken__)\nfrom a previous\n[ListInstancePartitionsResponse](/php/docs/reference/cloud-spanner/latest/Admin.Instance.V1.ListInstancePartitionsResponse).\n\n### getInstancePartitionDeadline\n\nOptional. Deadline used while retrieving metadata for instance partitions.\n\nInstance partitions whose metadata cannot be retrieved within this deadline\nwill be added to\n[unreachable](/php/docs/reference/cloud-spanner/latest/Admin.Instance.V1.ListInstancePartitionsResponse#_Google_Cloud_Spanner_Admin_Instance_V1_ListInstancePartitionsResponse__getUnreachable__)\nin\n[ListInstancePartitionsResponse](/php/docs/reference/cloud-spanner/latest/Admin.Instance.V1.ListInstancePartitionsResponse).\n\n### hasInstancePartitionDeadline\n\n### clearInstancePartitionDeadline\n\n### setInstancePartitionDeadline\n\nOptional. Deadline used while retrieving metadata for instance partitions.\n\nInstance partitions whose metadata cannot be retrieved within this deadline\nwill be added to\n[unreachable](/php/docs/reference/cloud-spanner/latest/Admin.Instance.V1.ListInstancePartitionsResponse#_Google_Cloud_Spanner_Admin_Instance_V1_ListInstancePartitionsResponse__getUnreachable__)\nin\n[ListInstancePartitionsResponse](/php/docs/reference/cloud-spanner/latest/Admin.Instance.V1.ListInstancePartitionsResponse).\n\n### static::build"]]
