Package com.google.cloud.asset.v1

Interface AnalyzeOrgPoliciesRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    AnalyzeOrgPoliciesRequest, AnalyzeOrgPoliciesRequest.Builder
    public interface AnalyzeOrgPoliciesRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getConstraint()
      Required.
      com.google.protobuf.ByteString getConstraintBytes()
      Required.
      String getFilter()
      The expression to filter [AnalyzeOrgPoliciesResponse.org_policy_results][google.cloud.asset.v1.AnalyzeOrgPoliciesResponse.org_policy_results].
      com.google.protobuf.ByteString getFilterBytes()
      The expression to filter [AnalyzeOrgPoliciesResponse.org_policy_results][google.cloud.asset.v1.AnalyzeOrgPoliciesResponse.org_policy_results].
      int getPageSize()
      The maximum number of items to return per page.
      String getPageToken()
      The pagination token to retrieve the next page.
      com.google.protobuf.ByteString getPageTokenBytes()
      The pagination token to retrieve the next page.
      String getScope()
      Required.
      com.google.protobuf.ByteString getScopeBytes()
      Required.
      boolean hasPageSize()
      The maximum number of items to return per page.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getScope

        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:
        The scope.

      • getScopeBytes

        com.google.protobuf.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:
        The bytes for scope.

      • getConstraint

        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:
        The constraint.

      • getConstraintBytes

        com.google.protobuf.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:
        The bytes for constraint.

      • getFilter

        String getFilter()
         The expression to filter
 [AnalyzeOrgPoliciesResponse.org_policy_results][google.cloud.asset.v1.AnalyzeOrgPoliciesResponse.org_policy_results].
 The only supported field is `consolidated_policy.attached_resource`, and
 the only supported operator is `=`.

 Example:
 consolidated_policy.attached_resource="//cloudresourcemanager.googleapis.com/folders/001"
 will return the org policy results of"folders/001".
        string filter = 3;
        Returns:
        The filter.

      • getFilterBytes

        com.google.protobuf.ByteString getFilterBytes()
         The expression to filter
 [AnalyzeOrgPoliciesResponse.org_policy_results][google.cloud.asset.v1.AnalyzeOrgPoliciesResponse.org_policy_results].
 The only supported field is `consolidated_policy.attached_resource`, and
 the only supported operator is `=`.

 Example:
 consolidated_policy.attached_resource="//cloudresourcemanager.googleapis.com/folders/001"
 will return the org policy results of"folders/001".
        string filter = 3;
        Returns:
        The bytes for filter.

      • hasPageSize

        boolean hasPageSize()
         The maximum number of items to return per page. If unspecified,
 [AnalyzeOrgPoliciesResponse.org_policy_results][google.cloud.asset.v1.AnalyzeOrgPoliciesResponse.org_policy_results]
 will contain 20 items with a maximum of 200.
        optional int32 page_size = 4;
        Returns:
        Whether the pageSize field is set.

      • getPageSize

        int getPageSize()
         The maximum number of items to return per page. If unspecified,
 [AnalyzeOrgPoliciesResponse.org_policy_results][google.cloud.asset.v1.AnalyzeOrgPoliciesResponse.org_policy_results]
 will contain 20 items with a maximum of 200.
        optional int32 page_size = 4;
        Returns:
        The pageSize.

      • getPageToken

        String getPageToken()
         The pagination token to retrieve the next page.
        string page_token = 5;
        Returns:
        The pageToken.

      • getPageTokenBytes

        com.google.protobuf.ByteString getPageTokenBytes()
         The pagination token to retrieve the next page.
        string page_token = 5;
        Returns:
        The bytes for pageToken.