# Cloud KMS V1 Client - Class ListRetiredResourcesRequest (2.9.0)

2.9.0 (latest) 2.8.0 2.7.0 2.6.0 2.5.2 2.4.0 2.3.1 2.2.0 2.1.6 2.0.0 1.23.0 1.22.1 1.21.4 1.20.3 1.19.0 1.18.1 1.17.0 1.16.4 1.15.3 Reference documentation and code samples for the Cloud KMS V1 Client class ListRetiredResourcesRequest.

Request message for
[KeyManagementService.ListRetiredResources](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.Client.KeyManagementServiceClient#_Google_Cloud_Kms_V1_Client_KeyManagementServiceClient__listRetiredResources__).

Generated from protobuf message `google.cloud.kms.v1.ListRetiredResourcesRequest`

## Namespace

Google \\ Cloud \\ Kms \\ V1

## Methods

### __construct

Constructor.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `data` | `mixed` |

### getParent

Required. The project-specific location holding the
[RetiredResources](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.RetiredResource), in the format
`projects/*/locations/*`.

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

### setParent

Required. The project-specific location holding the
[RetiredResources](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.RetiredResource), in the format
`projects/*/locations/*`.

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

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

### getPageSize

Optional. Optional limit on the number of
[RetiredResources](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.RetiredResource) to be included in
the response. Further
[RetiredResources](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.RetiredResource) can subsequently be
obtained by including the
[ListRetiredResourcesResponse.next_page_token](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.ListRetiredResourcesResponse#_Google_Cloud_Kms_V1_ListRetiredResourcesResponse__getNextPageToken__)
in a subsequent request. If unspecified, the server will pick an
appropriate default.

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

### setPageSize

Optional. Optional limit on the number of
[RetiredResources](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.RetiredResource) to be included in
the response. Further
[RetiredResources](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.RetiredResource) can subsequently be
obtained by including the
[ListRetiredResourcesResponse.next_page_token](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.ListRetiredResourcesResponse#_Google_Cloud_Kms_V1_ListRetiredResourcesResponse__getNextPageToken__)
in a subsequent request. If unspecified, the server will pick an
appropriate default.

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

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

### getPageToken

Optional. Optional pagination token, returned earlier via
[ListRetiredResourcesResponse.next_page_token](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.ListRetiredResourcesResponse#_Google_Cloud_Kms_V1_ListRetiredResourcesResponse__getNextPageToken__).

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

### setPageToken

Optional. Optional pagination token, returned earlier via
[ListRetiredResourcesResponse.next_page_token](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.ListRetiredResourcesResponse#_Google_Cloud_Kms_V1_ListRetiredResourcesResponse__getNextPageToken__).

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

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

### static::build

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `parent` | `string` Required. The project-specific location holding the [RetiredResources](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.RetiredResource), in the format `projects/*/locations/*`. Please see KeyManagementServiceClient::locationName() for help formatting this field. |

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