Class: Google::Cloud::Asset::V1::SearchAllIamPoliciesRequest

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

Search all IAM policies request.

Instance Attribute Summary collapse

Instance Attribute Details

#page_size ⇒ ::Integer

Returns Optional. The page size for search result pagination. Page size is capped at 500 even if a larger value is given. If set to zero, server will pick an appropriate default. Returned results may be fewer than requested. When this happens, there could be more results as long as next_page_token is returned.

Returns:

  • (::Integer) —

    Optional. The page size for search result pagination. Page size is capped at 500 even if a larger value is given. If set to zero, server will pick an appropriate default. Returned results may be fewer than requested. When this happens, there could be more results as long as next_page_token is returned.



608
609
610
611
 
# File 'proto_docs/google/cloud/asset/v1/asset_service.rb', line 608

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

#page_token ⇒ ::String

Returns Optional. If present, retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of all other method parameters must be identical to those in the previous call.

Returns:

  • (::String) —

    Optional. If present, retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of all other method parameters must be identical to those in the previous call.



608
609
610
611
 
# File 'proto_docs/google/cloud/asset/v1/asset_service.rb', line 608

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

#query ⇒ ::String

Returns Optional. The query statement. See how to construct a query for more information. If not specified or empty, it will search all the IAM policies within the specified scope.

Examples:

  • policy:[email protected] to find IAM policy bindings that specify user "[email protected]".
  • policy:roles/compute.admin to find IAM policy bindings that specify the Compute Admin role.
  • policy.role.permissions:storage.buckets.update to find IAM policy bindings that specify a role containing "storage.buckets.update" permission. Note that if callers don't have iam.roles.get access to a role's included permissions, policy bindings that specify this role will be dropped from the search results.
  • resource:organizations/123456 to find IAM policy bindings that are set on "organizations/123456".
  • Important to find IAM policy bindings that contain "Important" as a word in any of the searchable fields (except for the included permissions).
  • *por* to find IAM policy bindings that contain "por" as a substring in any of the searchable fields (except for the included permissions).
  • resource:(instance1 OR instance2) policy:amy to find IAM policy bindings that are set on resources "instance1" or "instance2" and also specify user "amy".

Returns:

  • (::String) —

    Optional. The query statement. See how to construct a query for more information. If not specified or empty, it will search all the IAM policies within the specified scope.

    Examples:

    • policy:[email protected] to find IAM policy bindings that specify user "[email protected]".
    • policy:roles/compute.admin to find IAM policy bindings that specify the Compute Admin role.
    • policy.role.permissions:storage.buckets.update to find IAM policy bindings that specify a role containing "storage.buckets.update" permission. Note that if callers don't have iam.roles.get access to a role's included permissions, policy bindings that specify this role will be dropped from the search results.
    • resource:organizations/123456 to find IAM policy bindings that are set on "organizations/123456".
    • Important to find IAM policy bindings that contain "Important" as a word in any of the searchable fields (except for the included permissions).
    • *por* to find IAM policy bindings that contain "por" as a substring in any of the searchable fields (except for the included permissions).
    • resource:(instance1 OR instance2) policy:amy to find IAM policy bindings that are set on resources "instance1" or "instance2" and also specify user "amy".


608
609
610
611
 
# File 'proto_docs/google/cloud/asset/v1/asset_service.rb', line 608

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

#scope ⇒ ::String

Returns Required. A scope can be a project, a folder, or an organization. The search is limited to the IAM policies within the scope. The caller must be granted the cloudasset.assets.searchAllIamPolicies permission on the desired scope.

The allowed values are:

  • projects/{PROJECT_ID} (e.g., "projects/foo-bar")
  • projects/{PROJECT_NUMBER} (e.g., "projects/12345678")
  • folders/{FOLDER_NUMBER} (e.g., "folders/1234567")
  • organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456").

Returns:

  • (::String) —

    Required. A scope can be a project, a folder, or an organization. The search is limited to the IAM policies within the scope. The caller must be granted the cloudasset.assets.searchAllIamPolicies permission on the desired scope.

    The allowed values are:

    • projects/{PROJECT_ID} (e.g., "projects/foo-bar")
    • projects/{PROJECT_NUMBER} (e.g., "projects/12345678")
    • folders/{FOLDER_NUMBER} (e.g., "folders/1234567")
    • organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")


608
609
610
611
 
# File 'proto_docs/google/cloud/asset/v1/asset_service.rb', line 608

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