As of January 1, 2020 this library no longer supports Python 2 on the latest released version.
Library versions released prior to that date will continue to be available. For more information please
visit Python 2 support on Google Cloud.
Source code for google.cloud.asset_v1p1beta1.services.asset_service.async_client
# -*- coding: utf-8 -*-
# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
from collections import OrderedDict
import functools
import re
from typing import Dict, Sequence, Tuple, Type, Union
import pkg_resources
import google.api_core.client_options as ClientOptions # type: ignore
from google.api_core import exceptions as core_exceptions # type: ignore
from google.api_core import gapic_v1 # type: ignore
from google.api_core import retry as retries # type: ignore
from google.auth import credentials as ga_credentials # type: ignore
from google.oauth2 import service_account # type: ignore
from google.cloud.asset_v1p1beta1.services.asset_service import pagers
from google.cloud.asset_v1p1beta1.types import asset_service
from google.cloud.asset_v1p1beta1.types import assets
from .transports.base import AssetServiceTransport, DEFAULT_CLIENT_INFO
from .transports.grpc_asyncio import AssetServiceGrpcAsyncIOTransport
from .client import AssetServiceClient
[docs]class AssetServiceAsyncClient:
"""Asset service definition."""
_client: AssetServiceClient
DEFAULT_ENDPOINT = AssetServiceClient.DEFAULT_ENDPOINT
DEFAULT_MTLS_ENDPOINT = AssetServiceClient.DEFAULT_MTLS_ENDPOINT
common_billing_account_path = staticmethod(
AssetServiceClient.common_billing_account_path
)
parse_common_billing_account_path = staticmethod(
AssetServiceClient.parse_common_billing_account_path
)
common_folder_path = staticmethod(AssetServiceClient.common_folder_path)
parse_common_folder_path = staticmethod(AssetServiceClient.parse_common_folder_path)
common_organization_path = staticmethod(AssetServiceClient.common_organization_path)
parse_common_organization_path = staticmethod(
AssetServiceClient.parse_common_organization_path
)
common_project_path = staticmethod(AssetServiceClient.common_project_path)
parse_common_project_path = staticmethod(
AssetServiceClient.parse_common_project_path
)
common_location_path = staticmethod(AssetServiceClient.common_location_path)
parse_common_location_path = staticmethod(
AssetServiceClient.parse_common_location_path
)
[docs] @classmethod
def from_service_account_info(cls, info: dict, *args, **kwargs):
"""Creates an instance of this client using the provided credentials
info.
Args:
info (dict): The service account private key info.
args: Additional arguments to pass to the constructor.
kwargs: Additional arguments to pass to the constructor.
Returns:
AssetServiceAsyncClient: The constructed client.
"""
return AssetServiceClient.from_service_account_info.__func__(AssetServiceAsyncClient, info, *args, **kwargs) # type: ignore
[docs] @classmethod
def from_service_account_file(cls, filename: str, *args, **kwargs):
"""Creates an instance of this client using the provided credentials
file.
Args:
filename (str): The path to the service account private key json
file.
args: Additional arguments to pass to the constructor.
kwargs: Additional arguments to pass to the constructor.
Returns:
AssetServiceAsyncClient: The constructed client.
"""
return AssetServiceClient.from_service_account_file.__func__(AssetServiceAsyncClient, filename, *args, **kwargs) # type: ignore
from_service_account_json = from_service_account_file
@property
def transport(self) -> AssetServiceTransport:
"""Returns the transport used by the client instance.
Returns:
AssetServiceTransport: The transport used by the client instance.
"""
return self._client.transport
get_transport_class = functools.partial(
type(AssetServiceClient).get_transport_class, type(AssetServiceClient)
)
def __init__(
self,
*,
credentials: ga_credentials.Credentials = None,
transport: Union[str, AssetServiceTransport] = "grpc_asyncio",
client_options: ClientOptions = None,
client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO,
) -> None:
"""Instantiates the asset service client.
Args:
credentials (Optional[google.auth.credentials.Credentials]): The
authorization credentials to attach to requests. These
credentials identify the application to the service; if none
are specified, the client will attempt to ascertain the
credentials from the environment.
transport (Union[str, ~.AssetServiceTransport]): The
transport to use. If set to None, a transport is chosen
automatically.
client_options (ClientOptions): Custom options for the client. It
won't take effect if a ``transport`` instance is provided.
(1) The ``api_endpoint`` property can be used to override the
default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT
environment variable can also be used to override the endpoint:
"always" (always use the default mTLS endpoint), "never" (always
use the default regular endpoint) and "auto" (auto switch to the
default mTLS endpoint if client certificate is present, this is
the default value). However, the ``api_endpoint`` property takes
precedence if provided.
(2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable
is "true", then the ``client_cert_source`` property can be used
to provide client certificate for mutual TLS transport. If
not provided, the default SSL client certificate will be used if
present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not
set, no client certificate will be used.
Raises:
google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport
creation failed for any reason.
"""
self._client = AssetServiceClient(
credentials=credentials,
transport=transport,
client_options=client_options,
client_info=client_info,
)
[docs] async def search_all_resources(
self,
request: asset_service.SearchAllResourcesRequest = None,
*,
scope: str = None,
query: str = None,
asset_types: Sequence[str] = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.SearchAllResourcesAsyncPager:
r"""Searches all the resources under a given accessible
CRM scope (project/folder/organization). This RPC gives
callers especially admins the ability to search all the
resources under a scope, even if they don't have .get
permission of all the resources. Callers should have
cloud.assets.SearchAllResources permission on the
requested scope, otherwise it will be rejected.
Args:
request (:class:`google.cloud.asset_v1p1beta1.types.SearchAllResourcesRequest`):
The request object. Search all resources request.
scope (:class:`str`):
Required. The relative name of an asset. The search is
limited to the resources within the ``scope``. The
allowed value must be:
- Organization number (such as "organizations/123")
- Folder number(such as "folders/1234")
- Project number (such as "projects/12345")
- Project id (such as "projects/abc")
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.
This corresponds to the ``query`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
asset_types (:class:`Sequence[str]`):
Optional. A list of asset types that
this request searches for. If empty, it
will search all the supported asset
types.
This corresponds to the ``asset_types`` 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:
google.cloud.asset_v1p1beta1.services.asset_service.pagers.SearchAllResourcesAsyncPager:
Search all resources 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, asset_types])
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."
)
request = asset_service.SearchAllResourcesRequest(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
if asset_types:
request.asset_types.extend(asset_types)
# 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_resources,
default_retry=retries.Retry(
initial=0.1,
maximum=60.0,
multiplier=1.3,
predicate=retries.if_exception_type(
core_exceptions.DeadlineExceeded,
core_exceptions.ServiceUnavailable,
),
deadline=15.0,
),
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.SearchAllResourcesAsyncPager(
method=rpc, request=request, response=response, metadata=metadata,
)
# Done; return the response.
return response
[docs] 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 the IAM policies under a given
accessible CRM scope (project/folder/organization). This
RPC gives callers especially admins the ability to
search all the IAM policies under a scope, even if they
don't have .getIamPolicy permission of all the IAM
policies. Callers should have
cloud.assets.SearchAllIamPolicies permission on the
requested scope, otherwise it will be rejected.
Args:
request (:class:`google.cloud.asset_v1p1beta1.types.SearchAllIamPoliciesRequest`):
The request object. Search all IAM policies request.
scope (:class:`str`):
Required. The relative name of an asset. The search is
limited to the resources within the ``scope``. The
allowed value must be:
- Organization number (such as "organizations/123")
- Folder number(such as "folders/1234")
- Project number (such as "projects/12345")
- Project id (such as "projects/abc")
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. Examples:
- "policy:myuser@mydomain.com"
- "policy:(myuser@mydomain.com viewer)"
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:
google.cloud.asset_v1p1beta1.services.asset_service.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.
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."
)
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(
core_exceptions.DeadlineExceeded,
core_exceptions.ServiceUnavailable,
),
deadline=15.0,
),
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
try:
DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(
gapic_version=pkg_resources.get_distribution("google-cloud-asset",).version,
)
except pkg_resources.DistributionNotFound:
DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo()
__all__ = ("AssetServiceAsyncClient",)