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

Request message for
[HsmManagement.ListSingleTenantHsmInstanceProposals](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.Client.HsmManagementClient#_Google_Cloud_Kms_V1_Client_HsmManagementClient__listSingleTenantHsmInstanceProposals__).

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

## Namespace

Google \\ Cloud \\ Kms \\ V1

## Methods

### __construct

Constructor.

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

### getParent

Required. The resource name of the single tenant HSM instance associated
with the
[SingleTenantHsmInstanceProposals](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.SingleTenantHsmInstanceProposal)
to list, in the format `projects/*/locations/*/singleTenantHsmInstances/*`.

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

### setParent

Required. The resource name of the single tenant HSM instance associated
with the
[SingleTenantHsmInstanceProposals](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.SingleTenantHsmInstanceProposal)
to list, in the format `projects/*/locations/*/singleTenantHsmInstances/*`.

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

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

### getPageSize

Optional. Optional limit on the number of
[SingleTenantHsmInstanceProposals](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.SingleTenantHsmInstanceProposal)
to include in the response. Further
[SingleTenantHsmInstanceProposals](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.SingleTenantHsmInstanceProposal)
can subsequently be obtained by including the
[ListSingleTenantHsmInstanceProposalsResponse.next_page_token](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.ListSingleTenantHsmInstanceProposalsResponse#_Google_Cloud_Kms_V1_ListSingleTenantHsmInstanceProposalsResponse__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
[SingleTenantHsmInstanceProposals](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.SingleTenantHsmInstanceProposal)
to include in the response. Further
[SingleTenantHsmInstanceProposals](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.SingleTenantHsmInstanceProposal)
can subsequently be obtained by including the
[ListSingleTenantHsmInstanceProposalsResponse.next_page_token](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.ListSingleTenantHsmInstanceProposalsResponse#_Google_Cloud_Kms_V1_ListSingleTenantHsmInstanceProposalsResponse__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
[ListSingleTenantHsmInstanceProposalsResponse.next_page_token](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.ListSingleTenantHsmInstanceProposalsResponse#_Google_Cloud_Kms_V1_ListSingleTenantHsmInstanceProposalsResponse__getNextPageToken__).

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

### setPageToken

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

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

| **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` |   |

### getShowDeleted

Optional. If set to true,
[HsmManagement.ListSingleTenantHsmInstanceProposals](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.Client.HsmManagementClient#_Google_Cloud_Kms_V1_Client_HsmManagementClient__listSingleTenantHsmInstanceProposals__)
will also return
[SingleTenantHsmInstanceProposals](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.SingleTenantHsmInstanceProposal)
in DELETED state.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `bool` |   |

### setShowDeleted

Optional. If set to true,
[HsmManagement.ListSingleTenantHsmInstanceProposals](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.Client.HsmManagementClient#_Google_Cloud_Kms_V1_Client_HsmManagementClient__listSingleTenantHsmInstanceProposals__)
will also return
[SingleTenantHsmInstanceProposals](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.SingleTenantHsmInstanceProposal)
in DELETED state.

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

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

### static::build

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `parent` | `string` Required. The resource name of the single tenant HSM instance associated with the [SingleTenantHsmInstanceProposals](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.SingleTenantHsmInstanceProposal) to list, in the format `projects/*/locations/*/singleTenantHsmInstances/*`. Please see HsmManagementClient::singleTenantHsmInstanceName() for help formatting this field. |

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