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

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

ListOrgPolicyViolationsPreviewsRequest is the request message for OrgPolicyViolationsPreviewService.ListOrgPolicyViolationsPreviews.

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

Namespace

Google \ Cloud \ PolicySimulator \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The parent the violations are scoped to. Format: organizations/{organization}/locations/{location} Example: organizations/my-example-org/locations/global

↳ page_size int

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

↳ 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 parent the violations are scoped to.

Format: organizations/{organization}/locations/{location} Example: organizations/my-example-org/locations/global

Returns
Type Description
string

setParent

Required. The parent the violations are scoped to.

Format: organizations/{organization}/locations/{location} Example: organizations/my-example-org/locations/global

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 5 items will be returned.

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

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 5 items will be returned.

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

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 parent the violations are scoped to. Format: organizations/{organization}/locations/{location}

Example: organizations/my-example-org/locations/global Please see OrgPolicyViolationsPreviewServiceClient::organizationLocationName() for help formatting this field.

Returns
Type Description
ListOrgPolicyViolationsPreviewsRequest