Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Google Cloud Service Management V1 Client - Class ListServiceRolloutsRequest (1.1.1)

Reference documentation and code samples for the Google Cloud Service Management V1 Client class ListServiceRolloutsRequest.

Request message for 'ListServiceRollouts'

Generated from protobuf message google.api.servicemanagement.v1.ListServiceRolloutsRequest

Namespace

Google \ Cloud \ ServiceManagement \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ service_name`	`string` Required. The name of the service. See the overview for naming requirements. For example: `example.googleapis.com`.
`↳ page_token`	`string` The token of the page to retrieve.
`↳ page_size`	`int` The max number of items to include in the response list. Page size is 50 if not specified. Maximum value is 100.
`↳ filter`	`string` Required. Use `filter` to return subset of rollouts. The following filters are supported: -- To limit the results to only those in status (google.api.servicemanagement.v1.RolloutStatus) 'SUCCESS', use filter='status=SUCCESS' -- To limit the results to those in status (google.api.servicemanagement.v1.RolloutStatus) 'CANCELLED' or 'FAILED', use filter='status=CANCELLED OR status=FAILED'

getServiceName

Required. The name of the service. See the overview for naming requirements. For example: example.googleapis.com.

Returns
Type	Description
`string`

setServiceName

Required. The name of the service. See the overview for naming requirements. For example: example.googleapis.com.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPageToken

The token of the page to retrieve.

Returns
Type	Description
`string`

setPageToken

The token of the page to retrieve.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPageSize

The max number of items to include in the response list. Page size is 50 if not specified. Maximum value is 100.

Returns
Type	Description
`int`

setPageSize

The max number of items to include in the response list. Page size is 50 if not specified. Maximum value is 100.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getFilter

Required. Use filter to return subset of rollouts.

The following filters are supported: -- To limit the results to only those in status (google.api.servicemanagement.v1.RolloutStatus) 'SUCCESS', use filter='status=SUCCESS' -- To limit the results to those in status (google.api.servicemanagement.v1.RolloutStatus) 'CANCELLED' or 'FAILED', use filter='status=CANCELLED OR status=FAILED'

Returns
Type	Description
`string`

setFilter

Required. Use filter to return subset of rollouts.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

static::build

Parameters
Name	Description
`serviceName`	`string` Required. The name of the service. See the overview for naming requirements. For example: `example.googleapis.com`.
`filter`	`string` Required. Use `filter` to return subset of rollouts. The following filters are supported: -- To limit the results to only those in status (google.api.servicemanagement.v1.RolloutStatus) 'SUCCESS', use filter='status=SUCCESS' -- To limit the results to those in status (google.api.servicemanagement.v1.RolloutStatus) 'CANCELLED' or 'FAILED', use filter='status=CANCELLED OR status=FAILED'

Returns
Type	Description
`Google\Cloud\ServiceManagement\V1\ListServiceRolloutsRequest`