Interface AnalyzeOrgPolicyGovernedAssetsRequestOrBuilder (3.45.0)

public interface AnalyzeOrgPolicyGovernedAssetsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getConstraint()

public abstract String getConstraint()

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

string constraint = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The constraint.

getConstraintBytes()

public abstract ByteString getConstraintBytes()

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

string constraint = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for constraint.

getFilter()

public abstract String 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".

string filter = 3;

Returns
TypeDescription
String

The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

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".

string filter = 3;

Returns
TypeDescription
ByteString

The bytes for filter.

getPageSize()

public abstract int getPageSize()

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

optional int32 page_size = 4;

Returns
TypeDescription
int

The pageSize.

getPageToken()

public abstract String getPageToken()

The pagination token to retrieve the next page.

string page_token = 5;

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

The pagination token to retrieve the next page.

string page_token = 5;

Returns
TypeDescription
ByteString

The bytes for pageToken.

getScope()

public abstract String 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")

string scope = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The scope.

getScopeBytes()

public abstract ByteString getScopeBytes()

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")

string scope = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for scope.

hasPageSize()

public abstract boolean hasPageSize()

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

optional int32 page_size = 4;

Returns
TypeDescription
boolean

Whether the pageSize field is set.