Interface AnalyzeOrgPoliciesRequestOrBuilder (3.57.0)

Version latest

• 3.57.0 (latest)
• 3.56.0
• 3.55.0
• 3.53.0
• 3.52.0
• 3.51.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.41.0
• 3.40.0
• 3.39.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.28.0
• 3.27.0
• 3.26.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.2-SNAPSHOT
• 3.6.0
• 3.4.1
• 3.3.1
• 3.2.17

public interface AnalyzeOrgPoliciesRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getConstraint()

public abstract String getConstraint()

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

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

Returns
Type	Description
String	The constraint.

getConstraintBytes()

public abstract ByteString getConstraintBytes()

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

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

Returns
Type	Description
ByteString	The bytes for constraint.

getFilter()

public abstract String getFilter()

The expression to filter AnalyzeOrgPoliciesResponse.org_policy_results. Filtering is currently available for bare literal values and the following fields:

• consolidated_policy.attached_resource

• consolidated_policy.rules.enforce

  When filtering by a specific field, the only supported operator is =. For example, filtering by consolidated_policy.attached_resource="//cloudresourcemanager.googleapis.com/folders/001" will return all the Organization Policy results attached to "folders/001".

string filter = 3;

Returns
Type	Description
String	The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

The expression to filter AnalyzeOrgPoliciesResponse.org_policy_results. Filtering is currently available for bare literal values and the following fields:

• consolidated_policy.attached_resource

• consolidated_policy.rules.enforce

  When filtering by a specific field, the only supported operator is =. For example, filtering by consolidated_policy.attached_resource="//cloudresourcemanager.googleapis.com/folders/001" will return all the Organization Policy results attached to "folders/001".

string filter = 3;

Returns
Type	Description
ByteString	The bytes for filter.

getPageSize()

public abstract int 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.

optional int32 page_size = 4;

Returns
Type	Description
int	The pageSize.

getPageToken()

public abstract String getPageToken()

The pagination token to retrieve the next page.

string page_token = 5;

Returns
Type	Description
String	The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

The pagination token to retrieve the next page.

string page_token = 5;

Returns
Type	Description
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.

• organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")

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

Returns
Type	Description
String	The scope.

getScopeBytes()

public abstract ByteString getScopeBytes()

Required. The organization to scope the request. Only organization policies within the scope will be analyzed.

• organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")

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

Returns
Type	Description
ByteString	The bytes for scope.

hasPageSize()

public abstract boolean hasPageSize()

The maximum number of items to return per page. If unspecified, AnalyzeOrgPoliciesResponse.org_policy_results will contain 20 items with a maximum of 200.

optional int32 page_size = 4;

Returns
Type	Description
boolean	Whether the pageSize field is set.