# Google Cloud Config V1 Client - Class ListDeploymentsRequest (1.8.0)

1.8.0 (latest) 1.7.2 1.6.1 1.5.0 1.4.1 1.3.0 1.2.1 1.1.0 1.0.1 0.5.2 0.2.0 0.1.3 Reference documentation and code samples for the Google Cloud Config V1 Client class ListDeploymentsRequest.

Generated from protobuf message `google.cloud.config.v1.ListDeploymentsRequest`

## Namespace

Google \\ Cloud \\ Config \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ parent` | `string` Required. The parent in whose context the Deployments are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}'. |
| `↳ page_size` | `int` 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. |
| `↳ page_token` | `string` Token returned by previous call to 'ListDeployments' which specifies the position in the list from where to continue listing the resources. |
| `↳ filter` | `string` 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 |
| `↳ order_by` | `string` Field to use to sort the list. |

### getParent

Required. The parent in whose context the Deployments are listed. The
parent value is in the format:
'projects/{project_id}/locations/{location}'.

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

### setParent

Required. The parent in whose context the Deployments are listed. The
parent value is in the format:
'projects/{project_id}/locations/{location}'.

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

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

### getPageSize

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.

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

### setPageSize

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.

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

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

### getPageToken

Token returned by previous call to 'ListDeployments' which specifies the
position in the list from where to continue listing the resources.

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

### setPageToken

Token returned by previous call to 'ListDeployments' which specifies the
position in the list from where to continue listing the resources.

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

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

### getFilter

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

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

### setFilter

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

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

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

### getOrderBy

Field to use to sort the list.

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

### setOrderBy

Field to use to sort the list.

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

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

### static::build

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `parent` | `string` Required. The parent in whose context the Deployments are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}'. Please see ConfigClient::locationName() for help formatting this field. |

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