# Cloud Key Management Service (KMS) V1 API - Class Google::Cloud::Kms::V1::ListSingleTenantHsmInstanceProposalsRequest (v1.13.0)

1.13.0 (latest) 1.12.1 1.11.0 1.10.0 1.9.2 1.8.0 1.7.0 1.6.0 1.5.1 1.4.0 1.3.2 1.2.1 1.1.0 1.0.2 0.27.0 0.26.0 0.25.1 0.24.3 0.23.0 0.22.1 0.21.0 0.20.0 0.19.0 0.18.1 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.2 Reference documentation and code samples for the Cloud Key Management Service (KMS) V1 API class Google::Cloud::Kms::V1::ListSingleTenantHsmInstanceProposalsRequest.

Request message for
[HsmManagement.ListSingleTenantHsmInstanceProposals](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-HsmManagement-Client#Google__Cloud__Kms__V1__HsmManagement__Client_list_single_tenant_hsm_instance_proposals_instance_ "Google::Cloud::Kms::V1::HsmManagement::Client#list_single_tenant_hsm_instance_proposals (method)").

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #filter

    def filter() -> ::String

**Returns**

- (::String) --- 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).

### #filter=

    def filter=(value) -> ::String

**Parameter**

- **value** (::String) --- 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**

- (::String) --- 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).

### #order_by

    def order_by() -> ::String

**Returns**

- (::String) --- 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).

### #order_by=

    def order_by=(value) -> ::String

**Parameter**

- **value** (::String) --- 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**

- (::String) --- 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).

### #page_size

    def page_size() -> ::Integer

**Returns**

- (::Integer) --- Optional. Optional limit on the number of [SingleTenantHsmInstanceProposals](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstanceProposal "Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal (class)") to include in the response. Further [SingleTenantHsmInstanceProposals](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstanceProposal "Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal (class)") can subsequently be obtained by including the [ListSingleTenantHsmInstanceProposalsResponse.next_page_token](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-ListSingleTenantHsmInstanceProposalsResponse#Google__Cloud__Kms__V1__ListSingleTenantHsmInstanceProposalsResponse_next_page_token_instance_ "Google::Cloud::Kms::V1::ListSingleTenantHsmInstanceProposalsResponse#next_page_token (method)") in a subsequent request. If unspecified, the server will pick an appropriate default.

### #page_size=

    def page_size=(value) -> ::Integer

**Parameter**

- **value** (::Integer) --- Optional. Optional limit on the number of [SingleTenantHsmInstanceProposals](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstanceProposal "Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal (class)") to include in the response. Further [SingleTenantHsmInstanceProposals](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstanceProposal "Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal (class)") can subsequently be obtained by including the [ListSingleTenantHsmInstanceProposalsResponse.next_page_token](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-ListSingleTenantHsmInstanceProposalsResponse#Google__Cloud__Kms__V1__ListSingleTenantHsmInstanceProposalsResponse_next_page_token_instance_ "Google::Cloud::Kms::V1::ListSingleTenantHsmInstanceProposalsResponse#next_page_token (method)") in a subsequent request. If unspecified, the server will pick an appropriate default.
**Returns**

- (::Integer) --- Optional. Optional limit on the number of [SingleTenantHsmInstanceProposals](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstanceProposal "Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal (class)") to include in the response. Further [SingleTenantHsmInstanceProposals](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstanceProposal "Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal (class)") can subsequently be obtained by including the [ListSingleTenantHsmInstanceProposalsResponse.next_page_token](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-ListSingleTenantHsmInstanceProposalsResponse#Google__Cloud__Kms__V1__ListSingleTenantHsmInstanceProposalsResponse_next_page_token_instance_ "Google::Cloud::Kms::V1::ListSingleTenantHsmInstanceProposalsResponse#next_page_token (method)") in a subsequent request. If unspecified, the server will pick an appropriate default.

### #page_token

    def page_token() -> ::String

**Returns**

- (::String) --- Optional. Optional pagination token, returned earlier via [ListSingleTenantHsmInstanceProposalsResponse.next_page_token](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-ListSingleTenantHsmInstanceProposalsResponse#Google__Cloud__Kms__V1__ListSingleTenantHsmInstanceProposalsResponse_next_page_token_instance_ "Google::Cloud::Kms::V1::ListSingleTenantHsmInstanceProposalsResponse#next_page_token (method)").

### #page_token=

    def page_token=(value) -> ::String

**Parameter**

- **value** (::String) --- Optional. Optional pagination token, returned earlier via [ListSingleTenantHsmInstanceProposalsResponse.next_page_token](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-ListSingleTenantHsmInstanceProposalsResponse#Google__Cloud__Kms__V1__ListSingleTenantHsmInstanceProposalsResponse_next_page_token_instance_ "Google::Cloud::Kms::V1::ListSingleTenantHsmInstanceProposalsResponse#next_page_token (method)").
**Returns**

- (::String) --- Optional. Optional pagination token, returned earlier via [ListSingleTenantHsmInstanceProposalsResponse.next_page_token](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-ListSingleTenantHsmInstanceProposalsResponse#Google__Cloud__Kms__V1__ListSingleTenantHsmInstanceProposalsResponse_next_page_token_instance_ "Google::Cloud::Kms::V1::ListSingleTenantHsmInstanceProposalsResponse#next_page_token (method)").

### #parent

    def parent() -> ::String

**Returns**

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

### #parent=

    def parent=(value) -> ::String

**Parameter**

- **value** (::String) --- Required. The resource name of the single tenant HSM instance associated with the [SingleTenantHsmInstanceProposals](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstanceProposal "Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal (class)") to list, in the format `projects/*/locations/*/singleTenantHsmInstances/*`.
**Returns**

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

### #show_deleted

    def show_deleted() -> ::Boolean

**Returns**

- (::Boolean) --- Optional. If set to true, [HsmManagement.ListSingleTenantHsmInstanceProposals](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-HsmManagement-Client#Google__Cloud__Kms__V1__HsmManagement__Client_list_single_tenant_hsm_instance_proposals_instance_ "Google::Cloud::Kms::V1::HsmManagement::Client#list_single_tenant_hsm_instance_proposals (method)") will also return [SingleTenantHsmInstanceProposals](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstanceProposal "Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal (class)") in DELETED state.

### #show_deleted=

    def show_deleted=(value) -> ::Boolean

**Parameter**

- **value** (::Boolean) --- Optional. If set to true, [HsmManagement.ListSingleTenantHsmInstanceProposals](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-HsmManagement-Client#Google__Cloud__Kms__V1__HsmManagement__Client_list_single_tenant_hsm_instance_proposals_instance_ "Google::Cloud::Kms::V1::HsmManagement::Client#list_single_tenant_hsm_instance_proposals (method)") will also return [SingleTenantHsmInstanceProposals](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstanceProposal "Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal (class)") in DELETED state.
**Returns**

- (::Boolean) --- Optional. If set to true, [HsmManagement.ListSingleTenantHsmInstanceProposals](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-HsmManagement-Client#Google__Cloud__Kms__V1__HsmManagement__Client_list_single_tenant_hsm_instance_proposals_instance_ "Google::Cloud::Kms::V1::HsmManagement::Client#list_single_tenant_hsm_instance_proposals (method)") will also return [SingleTenantHsmInstanceProposals](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstanceProposal "Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal (class)") in DELETED state.