Google Cloud Policy Simulator V1 Client - Class ListOrgPolicyViolationsRequest (1.2.0)

Reference documentation and code samples for the Google Cloud Policy Simulator V1 Client class ListOrgPolicyViolationsRequest.

ListOrgPolicyViolationsRequest is the request message for OrgPolicyViolationsPreviewService.ListOrgPolicyViolations.

Generated from protobuf message google.cloud.policysimulator.v1.ListOrgPolicyViolationsRequest

Namespace

Google \ Cloud \ PolicySimulator \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The OrgPolicyViolationsPreview to get OrgPolicyViolations from. Format: organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreview}

↳ page_size int

Optional. The maximum number of items to return. The service may return fewer than this value. If unspecified, at most 1000 items will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

↳ page_token string

Optional. A page token, received from a previous call. Provide this to retrieve the subsequent page. When paginating, all other parameters must match the call that provided the page token.

getParent

Required. The OrgPolicyViolationsPreview to get OrgPolicyViolations from.

Format: organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreview}

Returns
Type Description
string

setParent

Required. The OrgPolicyViolationsPreview to get OrgPolicyViolations from.

Format: organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreview}

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

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

The maximum value is 1000; values above 1000 will be coerced to 1000.

Returns
Type Description
int

setPageSize

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

The maximum value is 1000; values above 1000 will be coerced to 1000.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

Optional. A page token, received from a previous call. Provide this to retrieve the subsequent page.

When paginating, all other parameters must match the call that provided the page token.

Returns
Type Description
string

setPageToken

Optional. A page token, received from a previous call. Provide this to retrieve the subsequent page.

When paginating, all other parameters must match the call that provided the page token.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The OrgPolicyViolationsPreview to get OrgPolicyViolations from. Format: organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreview} Please see OrgPolicyViolationsPreviewServiceClient::orgPolicyViolationsPreviewName() for help formatting this field.

Returns
Type Description
ListOrgPolicyViolationsRequest