Google Cloud Asset V1 Client - Class AnalyzeOrgPolicyGovernedAssetsRequest (1.10.2)

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

A request message for AssetService.AnalyzeOrgPolicyGovernedAssets.

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

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. The output assets will also be limited to the ones governed by those in-scope organization policies. * organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")

↳ constraint string

Required. The name of the constraint to analyze governed assets for. The analysis only contains analyzed organization policies for the provided constraint.

↳ filter string

The expression to filter the governed assets in result. The only supported fields for governed resources are governed_resource.project and governed_resource.folders. The only supported fields for governed iam policies are governed_iam_policy.project and governed_iam_policy.folders. The only supported operator is =. Example 1: governed_resource.project="projects/12345678" filter will return all governed resources under projects/12345678 including the project ifself, if applicable. Example 2: governed_iam_policy.folders="folders/12345678" filter will return all governed iam policies under folders/12345678, if applicable.

↳ page_size int

The maximum number of items to return per page. If unspecified, AnalyzeOrgPolicyGovernedAssetsResponse.governed_assets will contain 100 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. The output assets will also be limited to the ones governed by those in-scope organization policies.

  • 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. The output assets will also be limited to the ones governed by those in-scope organization policies.

  • organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")
Parameter
NameDescription
var string
Returns
TypeDescription
$this

getConstraint

Required. The name of the constraint to analyze governed assets for. The analysis only contains analyzed organization policies for the provided constraint.

Returns
TypeDescription
string

setConstraint

Required. The name of the constraint to analyze governed assets for. The analysis only contains analyzed organization policies for the provided constraint.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getFilter

The expression to filter the governed assets in result. The only supported fields for governed resources are governed_resource.project and governed_resource.folders. The only supported fields for governed iam policies are governed_iam_policy.project and governed_iam_policy.folders. The only supported operator is =.

Example 1: governed_resource.project="projects/12345678" filter will return all governed resources under projects/12345678 including the project ifself, if applicable. Example 2: governed_iam_policy.folders="folders/12345678" filter will return all governed iam policies under folders/12345678, if applicable.

Returns
TypeDescription
string

setFilter

The expression to filter the governed assets in result. The only supported fields for governed resources are governed_resource.project and governed_resource.folders. The only supported fields for governed iam policies are governed_iam_policy.project and governed_iam_policy.folders. The only supported operator is =.

Example 1: governed_resource.project="projects/12345678" filter will return all governed resources under projects/12345678 including the project ifself, if applicable. Example 2: governed_iam_policy.folders="folders/12345678" filter will return all governed iam policies under folders/12345678, if applicable.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

The maximum number of items to return per page. If unspecified, AnalyzeOrgPolicyGovernedAssetsResponse.governed_assets will contain 100 items with a maximum of 200.

Returns
TypeDescription
int

hasPageSize

clearPageSize

setPageSize

The maximum number of items to return per page. If unspecified, AnalyzeOrgPolicyGovernedAssetsResponse.governed_assets will contain 100 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