Google Cloud Asset V1 Client - Class AnalyzeOrgPoliciesRequest (2.1.1)

Version latest

• 2.1.1 (latest)
• 2.1.0
• 2.0.1
• 1.16.4
• 1.14.1
• 1.13.2
• 1.12.2
• 1.11.3
• 1.10.2
• 1.9.2

Reference documentation and code samples for the Google Cloud Asset V1 Client class AnalyzeOrgPoliciesRequest.

A request message for AssetService.AnalyzeOrgPolicies.

Generated from protobuf message google.cloud.asset.v1.AnalyzeOrgPoliciesRequest

Namespace

Google \ Cloud \ Asset \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ scope	string Required. The organization to scope the request. Only organization policies within the scope will be analyzed. * * organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")
↳ constraint	string Required. The name of the constraint to analyze organization policies for. The response only contains analyzed organization policies for the provided constraint.
↳ filter	string The expression to filter AnalyzeOrgPoliciesResponse.org_policy_results. Filtering is currently available for bare literal values and the following fields: * * consolidated_policy.attached_resource * * consolidated_policy.rules.enforce When filtering by a specific field, the only supported operator is =. For example, filtering by consolidated_policy.attached_resource="//cloudresourcemanager.googleapis.com/folders/001" will return all the Organization Policy results attached to "folders/001".
↳ page_size	int The maximum number of items to return per page. If unspecified, AnalyzeOrgPoliciesResponse.org_policy_results will contain 20 items with a maximum of 200.
↳ page_token	string The pagination token to retrieve the next page.

getScope

Required. The organization to scope the request. Only organization policies within the scope will be analyzed.

• organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")

Returns
Type	Description
string

setScope

Required. The organization to scope the request. Only organization policies within the scope will be analyzed.

• organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getConstraint

Required. The name of the constraint to analyze organization policies for.

The response only contains analyzed organization policies for the provided constraint.

Returns
Type	Description
string

setConstraint

Required. The name of the constraint to analyze organization policies for.

The response only contains analyzed organization policies for the provided constraint.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getFilter

The expression to filter AnalyzeOrgPoliciesResponse.org_policy_results.

Filtering is currently available for bare literal values and the following fields:

• consolidated_policy.attached_resource
• consolidated_policy.rules.enforce When filtering by a specific field, the only supported operator is =. For example, filtering by consolidated_policy.attached_resource="//cloudresourcemanager.googleapis.com/folders/001" will return all the Organization Policy results attached to "folders/001".

Returns
Type	Description
string

setFilter

The expression to filter AnalyzeOrgPoliciesResponse.org_policy_results.

Filtering is currently available for bare literal values and the following fields:

• consolidated_policy.attached_resource
• consolidated_policy.rules.enforce When filtering by a specific field, the only supported operator is =. For example, filtering by consolidated_policy.attached_resource="//cloudresourcemanager.googleapis.com/folders/001" will return all the Organization Policy results attached to "folders/001".

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getPageSize

The maximum number of items to return per page. If unspecified, AnalyzeOrgPoliciesResponse.org_policy_results will contain 20 items with a maximum of 200.

Returns
Type	Description
int

hasPageSize

clearPageSize

setPageSize

The maximum number of items to return per page. If unspecified, AnalyzeOrgPoliciesResponse.org_policy_results will contain 20 items with a maximum of 200.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getPageToken

The pagination token to retrieve the next page.

Returns
Type	Description
string

setPageToken

The pagination token to retrieve the next page.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

static::build

Parameters
Name	Description
scope	string Required. The organization to scope the request. Only organization policies within the scope will be analyzed. organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")
constraint	string Required. The name of the constraint to analyze organization policies for. The response only contains analyzed organization policies for the provided constraint.
filter	string The expression to filter AnalyzeOrgPoliciesResponse.org_policy_results. Filtering is currently available for bare literal values and the following fields: consolidated_policy.attached_resource consolidated_policy.rules.enforce When filtering by a specific field, the only supported operator is =. For example, filtering by consolidated_policy.attached_resource="//cloudresourcemanager.googleapis.com/folders/001" will return all the Organization Policy results attached to "folders/001".

Returns
Type	Description
AnalyzeOrgPoliciesRequest