Cloud Asset V1 API - Class Google::Cloud::Asset::V1::AnalyzeOrgPoliciesRequest (v0.32.0)

Reference documentation and code samples for the Cloud Asset V1 API class Google::Cloud::Asset::V1::AnalyzeOrgPoliciesRequest.

A request message for AssetService.AnalyzeOrgPolicies.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#constraint

def constraint() -> ::String
Returns
  • (::String) — Required. The name of the constraint to analyze organization policies for. The response only contains analyzed organization policies for the provided constraint.

#constraint=

def constraint=(value) -> ::String
Parameter
  • value (::String) — Required. The name of the constraint to analyze organization policies for. The response only contains analyzed organization policies for the provided constraint.
Returns
  • (::String) — Required. The name of the constraint to analyze organization policies for. The response only contains analyzed organization policies for the provided constraint.

#filter

def filter() -> ::String
Returns
  • (::String) — 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".

#filter=

def filter=(value) -> ::String
Parameter
  • value (::String) — 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".

Returns
  • (::String) — 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".

#page_size

def page_size() -> ::Integer
Returns

#page_size=

def page_size=(value) -> ::Integer
Parameter
Returns

#page_token

def page_token() -> ::String
Returns
  • (::String) — The pagination token to retrieve the next page.

#page_token=

def page_token=(value) -> ::String
Parameter
  • value (::String) — The pagination token to retrieve the next page.
Returns
  • (::String) — The pagination token to retrieve the next page.

#scope

def scope() -> ::String
Returns
  • (::String) —

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

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

#scope=

def scope=(value) -> ::String
Parameter
  • value (::String) —

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

    • organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")
Returns
  • (::String) —

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

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