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

2.2.3 (latest) 2.2.2 2.1.1 2.0.4 1.5.7 1.4.0 1.3.2 1.2.1 1.1.2 1.0.3 Reference documentation and code samples for the Google Cloud Filestore V1 Client class ListInstancesRequest.

ListInstancesRequest lists instances.

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

## Namespace

Google \\ Cloud \\ Filestore \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ parent` | `string` Required. The project and location for which to retrieve instance information, in the format `projects/{project_id}/locations/{location}`. In Cloud Filestore, locations map to Google Cloud zones, for example **us-west1-b** . To retrieve instance information for all locations, use "-" for the `{location}` value. |
| `↳ page_size` | `int` The maximum number of items to return. |
| `↳ page_token` | `string` The next_page_token value to use if there are additional results to retrieve for this list request. |
| `↳ order_by` | `string` Sort results. Supported values are "name", "name desc" or "" (unsorted). |
| `↳ filter` | `string` List filter. |

### getParent

Required. The project and location for which to retrieve instance
information, in the format `projects/{project_id}/locations/{location}`. In
Cloud Filestore, locations map to Google Cloud zones, for example
**us-west1-b** . To retrieve instance information for all locations, use "-"
for the
`{location}` value.

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

### setParent

Required. The project and location for which to retrieve instance
information, in the format `projects/{project_id}/locations/{location}`. In
Cloud Filestore, locations map to Google Cloud zones, for example
**us-west1-b** . To retrieve instance information for all locations, use "-"
for the
`{location}` value.

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

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

### getPageSize

The maximum number of items to return.

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

### setPageSize

The maximum number of items to return.

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

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

### getPageToken

The next_page_token value to use if there are additional
results to retrieve for this list request.

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

### setPageToken

The next_page_token value to use if there are additional
results to retrieve for this list request.

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

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

### getOrderBy

Sort results. Supported values are "name", "name desc" or "" (unsorted).

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

### setOrderBy

Sort results. Supported values are "name", "name desc" or "" (unsorted).

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

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

### getFilter

List filter.

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

### setFilter

List filter.

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

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

### static::build

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `parent` | `string` Required. The project and location for which to retrieve instance information, in the format `projects/{project_id}/locations/{location}`. In Cloud Filestore, locations map to Google Cloud zones, for example *us-west1-b* \*. To retrieve instance information for all locations, use "-" for the `{location}` value. Please see CloudFilestoreManagerClient::locationName() for help formatting this field. |

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