Google Cloud Config V1 Client - Class ListDeploymentGroupsRequest (1.8.0)

Reference documentation and code samples for the Google Cloud Config V1 Client class ListDeploymentGroupsRequest.

The request message for the ListDeploymentGroups method.

Generated from protobuf message google.cloud.config.v1.ListDeploymentGroupsRequest

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, which owns this collection of deployment groups. Format: 'projects/{project_id}/locations/{location}'.
`↳ page_size`	`int` 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.
`↳ page_token`	`string` Optional. Token returned by previous call to 'ListDeploymentGroups' which specifies the position in the list from where to continue listing the deployment groups.
`↳ filter`	`string` Optional. Lists the DeploymentGroups that match the filter expression. A filter expression filters the deployment groups 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/deploymentGroups/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: - DeploymentGroups in CREATING state. state=CREATING
`↳ order_by`	`string` Optional. Field to use to sort the list.

getParent

Required. The parent, which owns this collection of deployment groups.

Format: 'projects/{project_id}/locations/{location}'.

Returns
Type	Description
`string`

setParent

Required. The parent, which owns this collection of deployment groups.

Format: 'projects/{project_id}/locations/{location}'.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

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.

Returns
Type	Description
`int`

setPageSize

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.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getPageToken

Optional. Token returned by previous call to 'ListDeploymentGroups' which specifies the position in the list from where to continue listing the deployment groups.

Returns
Type	Description
`string`

setPageToken

Optional. Token returned by previous call to 'ListDeploymentGroups' which specifies the position in the list from where to continue listing the deployment groups.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getFilter

Optional. Lists the DeploymentGroups that match the filter expression. A filter expression filters the deployment groups 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/deploymentGroups/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:
- DeploymentGroups in CREATING state. state=CREATING

Returns
Type	Description
`string`

setFilter