# Google Cloud Redis Cluster V1 Client - Class ListClustersRequest (0.8.0)

0.8.0 (latest) 0.7.0 0.6.4 0.5.1 0.4.1 0.3.2 0.2.5 0.1.0 Reference documentation and code samples for the Google Cloud Redis Cluster V1 Client class ListClustersRequest.

Request for ListClusters.

Generated from protobuf message `google.cloud.redis.cluster.v1.ListClustersRequest`

## Namespace

Google \\ Cloud \\ Redis \\ Cluster \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ parent` | `string` Required. The resource name of the cluster 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-cluster/latest/V1.ListClustersResponse#_Google_Cloud_Redis_Cluster_V1_ListClustersResponse__getNextPageToken__) to determine if there are more clusters left to be queried. |
| `↳ page_token` | `string` The `next_page_token` value returned from a previous ListClusters request, if any. |

### getParent

Required. The resource name of the cluster 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 cluster 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-cluster/latest/V1.ListClustersResponse#_Google_Cloud_Redis_Cluster_V1_ListClustersResponse__getNextPageToken__)
to determine if there are more clusters 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-cluster/latest/V1.ListClustersResponse#_Google_Cloud_Redis_Cluster_V1_ListClustersResponse__getNextPageToken__)
to determine if there are more clusters left to be queried.

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

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

### getPageToken

The `next_page_token` value returned from a previous
ListClusters request, if any.

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

### setPageToken

The `next_page_token` value returned from a previous
ListClusters 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 cluster location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region. Please see CloudRedisClusterClient::locationName() for help formatting this field. |

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