Google Cloud Assured Workloads V1 Client - Class ListViolationsRequest (1.0.1)

Reference documentation and code samples for the Google Cloud Assured Workloads V1 Client class ListViolationsRequest.

Request for fetching violations in an organization.

Generated from protobuf message google.cloud.assuredworkloads.v1.ListViolationsRequest

Namespace

Google \ Cloud \ AssuredWorkloads \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The Workload name. Format organizations/{org_id}/locations/{location}/workloads/{workload}.

↳ interval TimeWindow

Optional. Specifies the time window for retrieving active Violations. When specified, retrieves Violations that were active between start_time and end_time.

↳ page_size int

Optional. Page size.

↳ page_token string

Optional. Page token returned from previous request.

↳ filter string

Optional. A custom filter for filtering by the Violations properties.

getParent

Required. The Workload name.

Format organizations/{org_id}/locations/{location}/workloads/{workload}.

Returns
Type Description
string

setParent

Required. The Workload name.

Format organizations/{org_id}/locations/{location}/workloads/{workload}.

Parameter
Name Description
var string
Returns
Type Description
$this

getInterval

Optional. Specifies the time window for retrieving active Violations.

When specified, retrieves Violations that were active between start_time and end_time.

Returns
Type Description
TimeWindow|null

hasInterval

clearInterval

setInterval

Optional. Specifies the time window for retrieving active Violations.

When specified, retrieves Violations that were active between start_time and end_time.

Parameter
Name Description
var TimeWindow
Returns
Type Description
$this

getPageSize

Optional. Page size.

Returns
Type Description
int

setPageSize

Optional. Page size.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

Optional. Page token returned from previous request.

Returns
Type Description
string

setPageToken

Optional. Page token returned from previous request.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

Optional. A custom filter for filtering by the Violations properties.

Returns
Type Description
string

setFilter

Optional. A custom filter for filtering by the Violations properties.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The Workload name. Format organizations/{org_id}/locations/{location}/workloads/{workload}. Please see AssuredWorkloadsServiceClient::workloadName() for help formatting this field.

Returns
Type Description
ListViolationsRequest