Class: Google::Cloud::Asset::V1::AnalyzeOrgPoliciesRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/asset/v1/asset_service.rb

Overview

A request message for AssetService.AnalyzeOrgPolicies.

Instance Attribute Summary collapse

Instance Attribute Details

#constraint::String

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



2196
2197
2198
2199
# File 'proto_docs/google/cloud/asset/v1/asset_service.rb', line 2196

class AnalyzeOrgPoliciesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#filter::String

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



2196
2197
2198
2199
# File 'proto_docs/google/cloud/asset/v1/asset_service.rb', line 2196

class AnalyzeOrgPoliciesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_size::Integer

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

Returns:



2196
2197
2198
2199
# File 'proto_docs/google/cloud/asset/v1/asset_service.rb', line 2196

class AnalyzeOrgPoliciesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_token::String

Returns The pagination token to retrieve the next page.

Returns:

  • (::String)

    The pagination token to retrieve the next page.



2196
2197
2198
2199
# File 'proto_docs/google/cloud/asset/v1/asset_service.rb', line 2196

class AnalyzeOrgPoliciesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#scope::String

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


2196
2197
2198
2199
# File 'proto_docs/google/cloud/asset/v1/asset_service.rb', line 2196

class AnalyzeOrgPoliciesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end