Google Cloud Cloud Controls Partner V1beta Client - Class ListViolationsRequest (0.2.0)

Reference documentation and code samples for the Google Cloud Cloud Controls Partner V1beta Client class ListViolationsRequest.

Message for requesting list of Violations

Generated from protobuf message google.cloud.cloudcontrolspartner.v1beta.ListViolationsRequest

Namespace

Google \ Cloud \ CloudControlsPartner \ V1beta

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ parent`	`string` Required. Parent resource Format `organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}`
`↳ page_size`	`int` Optional. The maximum number of customers row to return. The service may return fewer than this value. If unspecified, at most 10 customers will be returned.
`↳ page_token`	`string` Optional. A page token, received from a previous `ListViolations` call. Provide this to retrieve the subsequent page.
`↳ filter`	`string` Optional. Filtering results
`↳ order_by`	`string` Optional. Hint for how to order the results
`↳ interval`	`Google\Type\Interval` Optional. Specifies the interval for retrieving violations. if unspecified, all violations will be returned.

getParent

Required. Parent resource Format organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}

Returns
Type	Description
`string`

setParent

Required. Parent resource Format organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPageSize

Optional. The maximum number of customers row to return. The service may return fewer than this value. If unspecified, at most 10 customers will be returned.

Returns
Type	Description
`int`

setPageSize

Optional. The maximum number of customers row to return. The service may return fewer than this value. If unspecified, at most 10 customers will be returned.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getPageToken

Optional. A page token, received from a previous ListViolations call.

Provide this to retrieve the subsequent page.

Returns
Type	Description
`string`

setPageToken

Optional. A page token, received from a previous ListViolations call.

Provide this to retrieve the subsequent page.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getFilter

Optional. Filtering results

Returns
Type	Description
`string`

setFilter

Optional. Filtering results

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getOrderBy

Optional. Hint for how to order the results

Returns
Type	Description
`string`

setOrderBy

Optional. Hint for how to order the results

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getInterval

Optional. Specifies the interval for retrieving violations.

if unspecified, all violations will be returned.

Returns
Type	Description
`Google\Type\Interval\|null`

hasInterval

clearInterval

setInterval

Optional. Specifies the interval for retrieving violations.

if unspecified, all violations will be returned.

Parameter
Name	Description
`var`	`Google\Type\Interval`

Returns
Type	Description
`$this`

static::build

Parameter
Name	Description
`parent`	`string` Required. Parent resource Format `organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}` Please see Google\Cloud\CloudControlsPartner\V1beta\CloudControlsPartnerMonitoringClient::workloadName() for help formatting this field.

Returns
Type	Description
`Google\Cloud\CloudControlsPartner\V1beta\ListViolationsRequest`