Google Cloud Asset V1 Client - Class AnalyzeOrgPolicyGovernedAssetsRequest (2.1.0)

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

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. 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 AnalyzeOrgPolicyGovernedAssetsResponse.governed_assets. For governed resources, filtering is currently available for bare literal values and the following fields: * governed_resource.project * governed_resource.folders * consolidated_policy.rules.enforce When filtering by governed_resource.project or consolidated_policy.rules.enforce, the only supported operator is =. When filtering by governed_resource.folders, the supported operators are = and :. For example, filtering by governed_resource.project="projects/12345678" will return all the governed resources under "projects/12345678", including the project itself if applicable. For governed IAM policies, filtering is currently available for bare literal values and the following fields: * governed_iam_policy.project * governed_iam_policy.folders * consolidated_policy.rules.enforce When filtering by governed_iam_policy.project or consolidated_policy.rules.enforce, the only supported operator is =. When filtering by governed_iam_policy.folders, the supported operators are = and :. For example, filtering by governed_iam_policy.folders:"folders/12345678" will return all the governed IAM policies under "folders/001".
↳ 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
Type Description
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
Name Description
var string
Returns
Type Description
$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
Type Description
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
Name Description
var string
Returns
Type Description
$this

getFilter

The expression to filter AnalyzeOrgPolicyGovernedAssetsResponse.governed_assets.

For governed resources, filtering is currently available for bare literal values and the following fields:

  • governed_resource.project
  • governed_resource.folders
  • consolidated_policy.rules.enforce When filtering by governed_resource.project or consolidated_policy.rules.enforce, the only supported operator is =. When filtering by governed_resource.folders, the supported operators are = and :. For example, filtering by governed_resource.project="projects/12345678" will return all the governed resources under "projects/12345678", including the project itself if applicable. For governed IAM policies, filtering is currently available for bare literal values and the following fields:
  • governed_iam_policy.project
  • governed_iam_policy.folders
  • consolidated_policy.rules.enforce When filtering by governed_iam_policy.project or consolidated_policy.rules.enforce, the only supported operator is =. When filtering by governed_iam_policy.folders, the supported operators are = and :. For example, filtering by governed_iam_policy.folders:"folders/12345678" will return all the governed IAM policies under "folders/001".
Returns
Type Description
string

setFilter

The expression to filter AnalyzeOrgPolicyGovernedAssetsResponse.governed_assets.

For governed resources, filtering is currently available for bare literal values and the following fields:

  • governed_resource.project
  • governed_resource.folders
  • consolidated_policy.rules.enforce When filtering by governed_resource.project or consolidated_policy.rules.enforce, the only supported operator is =. When filtering by governed_resource.folders, the supported operators are = and :. For example, filtering by governed_resource.project="projects/12345678" will return all the governed resources under "projects/12345678", including the project itself if applicable. For governed IAM policies, filtering is currently available for bare literal values and the following fields:
  • governed_iam_policy.project
  • governed_iam_policy.folders
  • consolidated_policy.rules.enforce When filtering by governed_iam_policy.project or consolidated_policy.rules.enforce, the only supported operator is =. When filtering by governed_iam_policy.folders, the supported operators are = and :. For example, filtering by governed_iam_policy.folders:"folders/12345678" will return all the governed IAM policies under "folders/001".
Parameter
Name Description
var string
Returns
Type Description
$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
Type Description
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
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. 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 AnalyzeOrgPolicyGovernedAssetsResponse.governed_assets.

For governed resources, filtering is currently available for bare literal values and the following fields:

  • governed_resource.project
  • governed_resource.folders
  • consolidated_policy.rules.enforce When filtering by governed_resource.project or consolidated_policy.rules.enforce, the only supported operator is =. When filtering by governed_resource.folders, the supported operators are = and :. For example, filtering by governed_resource.project="projects/12345678" will return all the governed resources under "projects/12345678", including the project itself if applicable.

For governed IAM policies, filtering is currently available for bare literal values and the following fields:

  • governed_iam_policy.project
  • governed_iam_policy.folders
  • consolidated_policy.rules.enforce When filtering by governed_iam_policy.project or consolidated_policy.rules.enforce, the only supported operator is =. When filtering by governed_iam_policy.folders, the supported operators are = and :. For example, filtering by governed_iam_policy.folders:"folders/12345678" will return all the governed IAM policies under "folders/001".
Returns
Type Description
Google\Cloud\Asset\V1\AnalyzeOrgPolicyGovernedAssetsRequest