# Cloud KMS V1 Client - Class ListCryptoKeysRequest (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 ListCryptoKeysRequest.

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

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

## Namespace

Google \\ Cloud \\ Kms \\ V1

## Methods

### __construct

Constructor.

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

### getParent

Required. The resource name of the [KeyRing](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.KeyRing)
to list, in the format `projects/*/locations/*/keyRings/*`.

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

### setParent

Required. The resource name of the [KeyRing](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.KeyRing)
to list, in the format `projects/*/locations/*/keyRings/*`.

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

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

### getPageSize

Optional. Optional limit on the number of
[CryptoKeys](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKey) to include in the response.

Further [CryptoKeys](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKey) can subsequently be
obtained by including the
[ListCryptoKeysResponse.next_page_token](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.ListCryptoKeysResponse#_Google_Cloud_Kms_V1_ListCryptoKeysResponse__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
[CryptoKeys](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKey) to include in the response.

Further [CryptoKeys](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKey) can subsequently be
obtained by including the
[ListCryptoKeysResponse.next_page_token](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.ListCryptoKeysResponse#_Google_Cloud_Kms_V1_ListCryptoKeysResponse__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
[ListCryptoKeysResponse.next_page_token](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.ListCryptoKeysResponse#_Google_Cloud_Kms_V1_ListCryptoKeysResponse__getNextPageToken__).

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

### setPageToken

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

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

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

### getVersionView

The fields of the primary version to include in the response.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` | Enum of type [CryptoKeyVersionView](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKeyVersion.CryptoKeyVersionView). |

### setVersionView

The fields of the primary version to include in the response.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [CryptoKeyVersionView](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKeyVersion.CryptoKeyVersionView). |

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

### getFilter

Optional. Only include resources that match the filter in the response. For
more information, see
[Sorting and filtering list
results](https://cloud.google.com/kms/docs/sorting-and-filtering).

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

### setFilter

Optional. Only include resources that match the filter in the response. For
more information, see
[Sorting and filtering list
results](https://cloud.google.com/kms/docs/sorting-and-filtering).

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

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

### getOrderBy

Optional. Specify how the results should be sorted. If not specified, the
results will be sorted in the default order. For more information, see
[Sorting and filtering list
results](https://cloud.google.com/kms/docs/sorting-and-filtering).

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

### setOrderBy

Optional. Specify how the results should be sorted. If not specified, the
results will be sorted in the default order. For more information, see
[Sorting and filtering list
results](https://cloud.google.com/kms/docs/sorting-and-filtering).

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

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

### static::build

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `parent` | `string` Required. The resource name of the [KeyRing](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.KeyRing) to list, in the format `projects/*/locations/*/keyRings/*`. Please see KeyManagementServiceClient::keyRingName() for help formatting this field. |

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