# Interface ListSingleTenantHsmInstanceProposalsRequestOrBuilder (2.96.0)

2.96.0 (latest) 2.94.0 2.91.0 2.90.0 2.88.0 2.86.0 2.85.0 2.84.0 2.83.0 2.81.0 2.79.0 2.78.0 2.77.0 2.76.0 2.75.0 2.73.0 2.71.0 2.70.0 2.67.0 2.66.0 2.65.0 2.63.0 2.62.0 2.61.0 2.60.0 2.59.0 2.58.0 2.57.0 2.56.0 2.55.0 2.54.0 2.52.0 2.51.0 2.50.0 2.49.0 2.48.0 2.47.0 2.46.0 2.45.0 2.44.0 2.43.0 2.42.0 2.40.0 2.39.0 2.38.0 2.37.0 2.36.0 2.35.0 2.34.0 2.33.0 2.32.0 2.31.0 2.30.0 2.27.0 2.26.0 2.25.0 2.24.0 2.23.0 2.22.0 2.21.0 2.20.0 2.19.0 2.18.0 2.17.0 2.16.0 2.15.0 2.14.0 2.12.0 2.11.0 2.10.0 2.9.0 2.8.0 2.7.0 2.6.8 2.5.3 2.4.4 2.3.1

    public interface ListSingleTenantHsmInstanceProposalsRequestOrBuilder extends MessageOrBuilder

## Implements

[MessageOrBuilder](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.MessageOrBuilder.html)

## Methods

### getFilter()

    public abstract String 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).

`string filter = 4 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The filter. |

### getFilterBytes()

    public abstract ByteString getFilterBytes()

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).

`string filter = 4 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for filter. |

### getOrderBy()

    public abstract String 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).

`string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The orderBy. |

### getOrderByBytes()

    public abstract ByteString getOrderByBytes()

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).

`string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for orderBy. |

### getPageSize()

    public abstract int getPageSize()

Optional. Optional limit on the number of
SingleTenantHsmInstanceProposals
to include in the response. Further
SingleTenantHsmInstanceProposals
can subsequently be obtained by including the
ListSingleTenantHsmInstanceProposalsResponse.next_page_token
in a subsequent request. If unspecified, the server will pick an
appropriate default.

`int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The pageSize. |

### getPageToken()

    public abstract String getPageToken()

Optional. Optional pagination token, returned earlier via
ListSingleTenantHsmInstanceProposalsResponse.next_page_token.

`string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The pageToken. |

### getPageTokenBytes()

    public abstract ByteString getPageTokenBytes()

Optional. Optional pagination token, returned earlier via
ListSingleTenantHsmInstanceProposalsResponse.next_page_token.

`string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for pageToken. |

### getParent()

    public abstract String getParent()

Required. The resource name of the single tenant HSM instance associated
with the
SingleTenantHsmInstanceProposals
to list, in the format `projects/*/locations/*/singleTenantHsmInstances/*`.

`
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The parent. |

### getParentBytes()

    public abstract ByteString getParentBytes()

Required. The resource name of the single tenant HSM instance associated
with the
SingleTenantHsmInstanceProposals
to list, in the format `projects/*/locations/*/singleTenantHsmInstances/*`.

`
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for parent. |

### getShowDeleted()

    public abstract boolean getShowDeleted()

Optional. If set to true,
HsmManagement.ListSingleTenantHsmInstanceProposals
will also return
SingleTenantHsmInstanceProposals
in DELETED state.

`bool show_deleted = 6 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The showDeleted. |