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 \ V1Methods
__construct
Constructor.
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")
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")
var
string
$this
getConstraint
Required. The name of the constraint to analyze organization policies for.
The response only contains analyzed organization policies for the provided constraint.
string
setConstraint
Required. The name of the constraint to analyze organization policies for.
The response only contains analyzed organization policies for the provided constraint.
var
string
$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".
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".
var
string
$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.
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.
var
int
$this
getPageToken
The pagination token to retrieve the next page.
string
setPageToken
The pagination token to retrieve the next page.
var
string
$this
static::build
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".