Interface AnalyzeOrgPolicyGovernedContainersRequestOrBuilder (3.41.0)

public interface AnalyzeOrgPolicyGovernedContainersRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getConstraint()

public abstract String getConstraint()

Required. The name of the constraint to analyze governed containers for. The analysis only contains 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 containers for. The analysis only contains 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 AnalyzeOrgPolicyGovernedContainersResponse.governed_containers. Filtering is currently available for bare literal values and the following fields:

  • parent
  • consolidated_policy.rules.enforce

    When filtering by a specific field, the only supported operator is =. For example, filtering by parent="//cloudresourcemanager.googleapis.com/folders/001" will return all the containers under "folders/001".

string filter = 3;

Returns
TypeDescription
String

The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

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

  • parent
  • consolidated_policy.rules.enforce

    When filtering by a specific field, the only supported operator is =. For example, filtering by parent="//cloudresourcemanager.googleapis.com/folders/001" will return all the containers 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, AnalyzeOrgPolicyGovernedContainersResponse.governed_containers 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 containers 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 containers 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, AnalyzeOrgPolicyGovernedContainersResponse.governed_containers will contain 100 items with a maximum of 200.

optional int32 page_size = 4;

Returns
TypeDescription
boolean

Whether the pageSize field is set.