Google Cloud Asset V1 Client - Class AnalyzeOrgPoliciesRequest (1.12.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
NameDescription
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 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".

↳ 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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

The pagination token to retrieve the next page.

Returns
TypeDescription
string

setPageToken

The pagination token to retrieve the next page.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
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 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
TypeDescription
Google\Cloud\Asset\V1\AnalyzeOrgPoliciesRequest