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
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. The only supported field is |
↳ 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.
The only supported field is consolidated_policy.attached_resource, and
the only supported operator is =.
Example:
consolidated_policy.attached_resource="//cloudresourcemanager.googleapis.com/folders/001"
will return the org policy results of"folders/001".
| Returns | |
|---|---|
| Type | Description |
string | |
setFilter
The expression to filter AnalyzeOrgPoliciesResponse.org_policy_results.
The only supported field is consolidated_policy.attached_resource, and
the only supported operator is =.
Example:
consolidated_policy.attached_resource="//cloudresourcemanager.googleapis.com/folders/001"
will return the org policy results of"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 | |