# Interface ListPreviewsRequestOrBuilder (0.70.0)

0.70.0 (latest) 0.68.0 0.65.0 0.64.0 0.62.0 0.60.0 0.59.0 0.58.0 0.57.0 0.55.0 0.53.0 0.52.0 0.51.0 0.50.0 0.49.0 0.47.0 0.45.0 0.44.0 0.41.0 0.40.0 0.39.0 0.37.0 0.36.0 0.35.0 0.34.0 0.33.0 0.32.0 0.31.0 0.30.0 0.29.0 0.28.0 0.26.0 0.25.0 0.24.0 0.23.0 0.22.0 0.21.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.1.0

    public interface ListPreviewsRequestOrBuilder 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. Lists the Deployments that match the filter expression. A filter
expression filters the resources listed in the response. The expression
must be of the form '{field} {operator} {value}' where operators: '\<', '\>',
'\<=', '\>=', '!=', '=', ':' are supported (colon ':' represents a HAS
operator which is roughly synonymous with equality). {field} can refer to a
proto or JSON field, or a synthetic field. Field names can be camelCase or
snake_case.

Examples:

- Filter by name:
  name = "projects/foo/locations/us-central1/deployments/bar

- Filter by labels:

- Resources that have a key called 'foo' labels.foo:\*
- Resources that have a key called 'foo' whose value is 'bar'
  labels.foo = bar

- Filter by state:

- Deployments in CREATING state. state=CREATING

`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. Lists the Deployments that match the filter expression. A filter
expression filters the resources listed in the response. The expression
must be of the form '{field} {operator} {value}' where operators: '\<', '\>',
'\<=', '\>=', '!=', '=', ':' are supported (colon ':' represents a HAS
operator which is roughly synonymous with equality). {field} can refer to a
proto or JSON field, or a synthetic field. Field names can be camelCase or
snake_case.

Examples:

- Filter by name:
  name = "projects/foo/locations/us-central1/deployments/bar

- Filter by labels:

- Resources that have a key called 'foo' labels.foo:\*
- Resources that have a key called 'foo' whose value is 'bar'
  labels.foo = bar

- Filter by state:

- Deployments in CREATING state. state=CREATING

`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. Field to use to sort the list.

`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. Field to use to sort the list.

`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. When requesting a page of resources, 'page_size' specifies number
of resources to return. If unspecified, at most 500 will be returned. The
maximum value is 1000.

`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. Token returned by previous call to 'ListDeployments' which
specifies the position in the list from where to continue listing the
resources.

`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. Token returned by previous call to 'ListDeployments' which
specifies the position in the list from where to continue listing the
resources.

`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 parent in whose context the Previews are listed. The parent
value is in the format: 'projects/{project_id}/locations/{location}'.

`
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 parent in whose context the Previews are listed. The parent
value is in the format: 'projects/{project_id}/locations/{location}'.

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