Google Cloud Deploy V1 Client - Class ListDeployPoliciesRequest (2.0.0)

Reference documentation and code samples for the Google Cloud Deploy V1 Client class ListDeployPoliciesRequest.

The request object for ListDeployPolicies.

Generated from protobuf message google.cloud.deploy.v1.ListDeployPoliciesRequest

Namespace

Google \ Cloud \ Deploy \ 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 deploy policies. Format must be `projects/{project_id}/locations/{location_name}`.
`↳ page_size`	`int` The maximum number of deploy policies to return. The service may return fewer than this value. If unspecified, at most 50 deploy policies will be returned. The maximum value is 1000; values above 1000 will be set to 1000.
`↳ page_token`	`string` A page token, received from a previous `ListDeployPolicies` call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters match the call that provided the page token.
`↳ filter`	`string` Filter deploy policies to be returned. See https://google.aip.dev/160 for more details. All fields can be used in the filter.
`↳ order_by`	`string` Field to sort by. See https://google.aip.dev/132#ordering for more details.

getParent

Required. The parent, which owns this collection of deploy policies. Format must be projects/{project_id}/locations/{location_name}.

Returns
Type	Description
`string`

setParent

Required. The parent, which owns this collection of deploy policies. Format must be projects/{project_id}/locations/{location_name}.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPageSize

The maximum number of deploy policies to return. The service may return fewer than this value. If unspecified, at most 50 deploy policies will be returned. The maximum value is 1000; values above 1000 will be set to 1000.

Returns
Type	Description
`int`

setPageSize

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getPageToken

A page token, received from a previous ListDeployPolicies call.

Provide this to retrieve the subsequent page. When paginating, all other provided parameters match the call that provided the page token.

Returns
Type	Description
`string`

setPageToken

A page token, received from a previous ListDeployPolicies call.

Provide this to retrieve the subsequent page. When paginating, all other provided parameters match the call that provided the page token.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getFilter

Filter deploy policies to be returned. See https://google.aip.dev/160 for more details. All fields can be used in the filter.

Returns
Type	Description
`string`

setFilter

Filter deploy policies to be returned. See https://google.aip.dev/160 for more details. All fields can be used in the filter.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getOrderBy

Field to sort by. See https://google.aip.dev/132#ordering for more details.

Returns
Type	Description
`string`

setOrderBy

Field to sort by. See https://google.aip.dev/132#ordering for more details.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

static::build

Parameter
Name	Description
`parent`	`string` Required. The parent, which owns this collection of deploy policies. Format must be `projects/{project_id}/locations/{location_name}`. Please see Google\Cloud\Deploy\V1\CloudDeployClient::locationName() for help formatting this field.

Returns
Type	Description
`Google\Cloud\Deploy\V1\ListDeployPoliciesRequest`