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

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

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

## Namespace

Google \\ Cloud \\ Kms \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ key_rings` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.KeyRing>` The list of [KeyRings](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.KeyRing). |
| `↳ next_page_token` | `string` A token to retrieve next page of results. Pass this value in [ListKeyRingsRequest.page_token](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.ListKeyRingsRequest#_Google_Cloud_Kms_V1_ListKeyRingsRequest__getPageToken__) to retrieve the next page of results. |
| `↳ total_size` | `int` The total number of [KeyRings](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.KeyRing) that matched the query. This field is not populated if [ListKeyRingsRequest.filter](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.ListKeyRingsRequest#_Google_Cloud_Kms_V1_ListKeyRingsRequest__getFilter__) is applied. |

### getKeyRings

The list of [KeyRings](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.KeyRing).

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/RepeatedField<https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.KeyRing>` |   |

### setKeyRings

The list of [KeyRings](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.KeyRing).

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.KeyRing>` |

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

### getNextPageToken

A token to retrieve next page of results. Pass this value in
[ListKeyRingsRequest.page_token](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.ListKeyRingsRequest#_Google_Cloud_Kms_V1_ListKeyRingsRequest__getPageToken__)
to retrieve the next page of results.

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

### setNextPageToken

A token to retrieve next page of results. Pass this value in
[ListKeyRingsRequest.page_token](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.ListKeyRingsRequest#_Google_Cloud_Kms_V1_ListKeyRingsRequest__getPageToken__)
to retrieve the next page of results.

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

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

### getTotalSize

The total number of [KeyRings](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.KeyRing) that matched
the query.

This field is not populated if
[ListKeyRingsRequest.filter](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.ListKeyRingsRequest#_Google_Cloud_Kms_V1_ListKeyRingsRequest__getFilter__)
is applied.

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

### setTotalSize

The total number of [KeyRings](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.KeyRing) that matched
the query.

This field is not populated if
[ListKeyRingsRequest.filter](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.ListKeyRingsRequest#_Google_Cloud_Kms_V1_ListKeyRingsRequest__getFilter__)
is applied.

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

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