# Google Cloud Redis V1 Client - Class ListInstancesRequest (2.2.3)

2.2.3 (latest) 2.2.2 2.1.6 2.0.0 1.9.5 1.8.4 1.7.0 1.6.12 Reference documentation and code samples for the Google Cloud Redis V1 Client class ListInstancesRequest.

Request for [ListInstances](https://docs.cloud.google.com/php/docs/reference/cloud-redis/latest/V1.Client.CloudRedisClient#_Google_Cloud_Redis_V1_Client_CloudRedisClient__listInstances__).

Generated from protobuf message `google.cloud.redis.v1.ListInstancesRequest`

## Namespace

Google \\ Cloud \\ Redis \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ parent` | `string` Required. The resource name of the instance location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region. |
| `↳ page_size` | `int` The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's [`next_page_token`](https://docs.cloud.google.com/php/docs/reference/cloud-redis/latest/V1.ListInstancesResponse#_Google_Cloud_Redis_V1_ListInstancesResponse__getNextPageToken__) to determine if there are more instances left to be queried. |
| `↳ page_token` | `string` The `next_page_token` value returned from a previous [ListInstances](https://docs.cloud.google.com/php/docs/reference/cloud-redis/latest/V1.Client.CloudRedisClient#_Google_Cloud_Redis_V1_Client_CloudRedisClient__listInstances__) request, if any. |

### getParent

Required. The resource name of the instance location using the form:
`projects/{project_id}/locations/{location_id}`
where `location_id` refers to a GCP region.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setParent

Required. The resource name of the instance location using the form:
`projects/{project_id}/locations/{location_id}`
where `location_id` refers to a GCP region.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getPageSize

The maximum number of items to return.

If not specified, a default value of 1000 will be used by the service.
Regardless of the page_size value, the response may include a partial list
and a caller should only rely on response's
[`next_page_token`](https://docs.cloud.google.com/php/docs/reference/cloud-redis/latest/V1.ListInstancesResponse#_Google_Cloud_Redis_V1_ListInstancesResponse__getNextPageToken__)
to determine if there are more instances left to be queried.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` |   |

### setPageSize

The maximum number of items to return.

If not specified, a default value of 1000 will be used by the service.
Regardless of the page_size value, the response may include a partial list
and a caller should only rely on response's
[`next_page_token`](https://docs.cloud.google.com/php/docs/reference/cloud-redis/latest/V1.ListInstancesResponse#_Google_Cloud_Redis_V1_ListInstancesResponse__getNextPageToken__)
to determine if there are more instances left to be queried.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getPageToken

The `next_page_token` value returned from a previous
[ListInstances](https://docs.cloud.google.com/php/docs/reference/cloud-redis/latest/V1.Client.CloudRedisClient#_Google_Cloud_Redis_V1_Client_CloudRedisClient__listInstances__) request, if
any.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setPageToken

The `next_page_token` value returned from a previous
[ListInstances](https://docs.cloud.google.com/php/docs/reference/cloud-redis/latest/V1.Client.CloudRedisClient#_Google_Cloud_Redis_V1_Client_CloudRedisClient__listInstances__) request, if
any.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### static::build

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `parent` | `string` Required. The resource name of the instance location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region. Please see CloudRedisClient::locationName() for help formatting this field. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-redis/latest/V1.ListInstancesRequest` |   |