Class AssetServiceAsyncClient (2.0.0) 

AssetServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.asset_v1p1beta1.services.asset_service.transports.base.AssetServiceTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-asset/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None)

Asset service definition.

Methods

AssetServiceAsyncClient

AssetServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.asset_v1p1beta1.services.asset_service.transports.base.AssetServiceTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-asset/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None)

Instantiate the asset service client.

Parameters
Name Description
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 environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint, this is the default value for the environment variable) and "auto" (auto switch to the default mTLS endpoint if client SSL credentials is present). However, the api_endpoint property takes precedence if provided. (2) The client_cert_source property is used to provide client SSL credentials for mutual TLS transport. If not provided, the default SSL credentials will be used if present.
Exceptions
Type Description
google.auth.exceptions.MutualTlsChannelError If mutual TLS transport creation failed for any reason.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name Description
filename str

The path to the service account private key json file.
Returns
Type Description
{@api.name} The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name Description
filename str

The path to the service account private key json file.
Returns
Type Description
{@api.name} The constructed client.

get_transport_class

get_transport_class()

Return an appropriate transport class.

search_all_iam_policies

search_all_iam_policies(request: Optional[google.cloud.asset_v1p1beta1.types.asset_service.SearchAllIamPoliciesRequest] = None, *, scope: Optional[str] = None, query: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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.

Parameters
Name Description
request .asset_service.SearchAllIamPoliciesRequest

The request object. Search all IAM policies request.
scope 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 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
Type Description
.pagers.SearchAllIamPoliciesAsyncPager Search all IAM policies response. Iterating over this object will yield results and resolve additional pages automatically.

search_all_resources

search_all_resources(request: Optional[google.cloud.asset_v1p1beta1.types.asset_service.SearchAllResourcesRequest] = None, *, scope: Optional[str] = None, query: Optional[str] = None, asset_types: Optional[Sequence[str]] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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.

Parameters
Name Description
request .asset_service.SearchAllResourcesRequest

The request object. Search all resources request.
scope 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 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
Type Description
.pagers.SearchAllResourcesAsyncPager Search all resources response. Iterating over this object will yield results and resolve additional pages automatically.