Google Cloud Deploy V1 Client - Class ListRolloutsRequest (1.5.0)

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

ListRolloutsRequest is the request object used by ListRollouts.

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

Namespace

Google \ Cloud \ Deploy \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ parent`	`string` Required. The `Release` which owns this collection of `Rollout` objects.
`↳ page_size`	`int` Optional. The maximum number of `Rollout` objects to return. The service may return fewer than this value. If unspecified, at most 50 `Rollout` objects will be returned. The maximum value is 1000; values above 1000 will be set to 1000.
`↳ page_token`	`string` Optional. A page token, received from a previous `ListRollouts` call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters match the call that provided the page token.
`↳ filter`	`string` Optional. Filter rollouts to be returned. See https://google.aip.dev/160 for more details.
`↳ order_by`	`string` Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.

getParent

Required. The Release which owns this collection of Rollout objects.

Returns
Type	Description
`string`

setParent

Required. The Release which owns this collection of Rollout objects.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPageSize

Optional. The maximum number of Rollout objects to return. The service may return fewer than this value. If unspecified, at most 50 Rollout objects 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

Optional. A page token, received from a previous ListRollouts 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

Optional. A page token, received from a previous ListRollouts 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

Optional. Filter rollouts to be returned. See https://google.aip.dev/160 for more details.

Returns
Type	Description
`string`

setFilter

Optional. Filter rollouts to be returned. See https://google.aip.dev/160 for more details.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getOrderBy

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

Returns
Type	Description
`string`

setOrderBy

Optional. 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 `Release` which owns this collection of `Rollout` objects. Please see CloudDeployClient::releaseName() for help formatting this field.

Returns
Type	Description
`ListRolloutsRequest`