def __init__(self,
method: Callable[...,
asset_service.SearchAllIamPoliciesResponse],
request: asset_service.SearchAllIamPoliciesRequest,
response: asset_service.SearchAllIamPoliciesResponse,
*,
metadata: Sequence[Tuple[str, str]] = ()):
"""Instantiate the pager.
Args:
method (Callable): The method that was originally called, and
which instantiated this pager.
request (google.cloud.asset_v1.types.SearchAllIamPoliciesRequest):
The initial request object.
response (google.cloud.asset_v1.types.SearchAllIamPoliciesResponse):
The initial response object.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
"""
self._method = method
self._request = asset_service.SearchAllIamPoliciesRequest(request)
self._response = response
self._metadata = metadata
async def search_all_iam_policies(
self,
request: asset_service.SearchAllIamPoliciesRequest = None,
*,
scope: str = None,
query: str = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.SearchAllIamPoliciesAsyncPager:
r"""Searches all IAM policies within the specified scope, such as a
project, folder, or organization. The caller must be granted the
``cloudasset.assets.searchAllIamPolicies`` permission on the
desired scope, otherwise the request will be rejected.
Args:
request (:class:`~.asset_service.SearchAllIamPoliciesRequest`):
The request object. Search all IAM policies request.
scope (:class:`str`):
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`` <http://cloud.google.com/asset-inventory/docs/access-control#required_permissions>`__
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")
This corresponds to the ``scope`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
query (:class:`str`):
Optional. The query statement. See `how to construct a
query <https://cloud.google.com/asset-inventory/docs/searching-iam-policies#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 "*****@*****.**".
- ``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".
This corresponds to the ``query`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
Returns:
~.pagers.SearchAllIamPoliciesAsyncPager:
Search all IAM policies response.
Iterating over this object will yield
results and resolve additional pages
automatically.
"""
# Create or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
if request is not None and any([scope, query]):
raise ValueError("If the `request` argument is set, then none of "
"the individual field arguments should be set.")
request = asset_service.SearchAllIamPoliciesRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if scope is not None:
request.scope = scope
if query is not None:
request.query = query
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = gapic_v1.method_async.wrap_method(
self._client._transport.search_all_iam_policies,
default_retry=retries.Retry(
initial=0.1,
maximum=60.0,
multiplier=1.3,
predicate=retries.if_exception_type(
exceptions.ServiceUnavailable,
exceptions.DeadlineExceeded,
),
),
default_timeout=15.0,
client_info=DEFAULT_CLIENT_INFO,
)
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (gapic_v1.routing_header.to_grpc_metadata(
(("scope", request.scope), )), )
# Send the request.
response = await rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# This method is paged; wrap the response in a pager, which provides
# an `__aiter__` convenience method.
response = pagers.SearchAllIamPoliciesAsyncPager(
method=rpc,
request=request,
response=response,
metadata=metadata,
)
# Done; return the response.
return response
def search_all_iam_policies(
self,
request: asset_service.SearchAllIamPoliciesRequest = None,
*,
scope: str = None,
query: str = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.SearchAllIamPoliciesPager:
r"""Searches all the IAM policies within the given
accessible scope (e.g., a project, a folder or an
organization). Callers should have
cloud.assets.SearchAllIamPolicies permission upon the
requested scope, otherwise the request will be rejected.
Args:
request (:class:`~.asset_service.SearchAllIamPoliciesRequest`):
The request object. Search all IAM policies request.
scope (:class:`str`):
Required. A scope can be a project, a folder or an
organization. The search is limited to the IAM policies
within the ``scope``.
The allowed values are:
- projects/{PROJECT_ID}
- projects/{PROJECT_NUMBER}
- folders/{FOLDER_NUMBER}
- organizations/{ORGANIZATION_NUMBER}
This corresponds to the ``scope`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
query (:class:`str`):
Optional. The query statement. An empty query can be
specified to search all the IAM policies within the
given ``scope``.
Examples:
- ``policy : "*****@*****.**"`` to find Cloud IAM policy
bindings that specify user "*****@*****.**".
- ``policy : "roles/compute.admin"`` to find Cloud IAM
policy bindings that specify the Compute Admin role.
- ``policy.role.permissions : "storage.buckets.update"``
to find Cloud IAM policy bindings that specify a role
containing "storage.buckets.update" permission.
- ``resource : "organizations/123"`` to find Cloud IAM
policy bindings that are set on "organizations/123".
- ``(resource : ("organizations/123" OR "folders/1234") AND policy : "amy")``
to find Cloud IAM policy bindings that are set on
"organizations/123" or "folders/1234", and also
specify user "amy".
See `how to construct a
query <https://cloud.google.com/asset-inventory/docs/searching-iam-policies#how_to_construct_a_query>`__
for more details.
This corresponds to the ``query`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
Returns:
~.pagers.SearchAllIamPoliciesPager:
Search all IAM policies response.
Iterating over this object will yield
results and resolve additional pages
automatically.
"""
# Create or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([scope, query])
if request is not None and has_flattened_params:
raise ValueError("If the `request` argument is set, then none of "
"the individual field arguments should be set.")
# Minor optimization to avoid making a copy if the user passes
# in a asset_service.SearchAllIamPoliciesRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, asset_service.SearchAllIamPoliciesRequest):
request = asset_service.SearchAllIamPoliciesRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if scope is not None:
request.scope = scope
if query is not None:
request.query = query
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[
self._transport.search_all_iam_policies]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (gapic_v1.routing_header.to_grpc_metadata(
(("scope", request.scope), )), )
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# This method is paged; wrap the response in a pager, which provides
# an `__iter__` convenience method.
response = pagers.SearchAllIamPoliciesPager(
method=rpc,
request=request,
response=response,
metadata=metadata,
)
# Done; return the response.
return response