Class AssetServiceClient (3.6.1)

Version 3.6.1

• 3.27.1 (latest)
• 3.27.0
• 3.26.4
• 3.25.1
• 3.24.3
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.1
• 3.19.1
• 3.18.1
• 3.17.1
• 3.16.0
• 3.15.0
• 3.14.2
• 3.13.1
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.1
• 3.8.1
• 3.7.1
• 3.6.1
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.1
• 3.1.0
• 2.2.2
• 2.1.0
• 2.0.0
• 1.3.2
• 1.2.0
• 1.1.0
• 1.0.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.1
• 0.3.0

AssetServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.asset_v1p1beta1.services.asset_service.transports.base.AssetServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Asset service definition.

Properties

transport

Returns the transport used by the client instance.

Returns

Type	Description
AssetServiceTransport	The transport used by the client instance.

Methods

AssetServiceClient

AssetServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.asset_v1p1beta1.services.asset_service.transports.base.AssetServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates 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	google.api_core.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.
client_info	google.api_core.gapic_v1.client_info.ClientInfo The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you're developing your own client library.

Exceptions

Type	Description
google.auth.exceptions.MutualTLSChannelError	If mutual TLS transport creation failed for any reason.

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

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
AssetServiceClient	The constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

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

Parameter

Name	Description
info	dict The service account private key info.

Returns

Type	Description
AssetServiceClient	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
AssetServiceClient	The constructed client.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

search_all_iam_policies

search_all_iam_policies(request: Optional[Union[google.cloud.asset_v1p1beta1.types.asset_service.SearchAllIamPoliciesRequest, dict]] = 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	Union[google.cloud.asset_v1p1beta1.types.SearchAllIamPoliciesRequest, dict] 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:[e-mail]" - "policy:([e-mail] 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
google.cloud.asset_v1p1beta1.services.asset_service.pagers.SearchAllIamPoliciesPager	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[Union[google.cloud.asset_v1p1beta1.types.asset_service.SearchAllResourcesRequest, dict]] = 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	Union[google.cloud.asset_v1p1beta1.types.SearchAllResourcesRequest, dict] 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	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
google.cloud.asset_v1p1beta1.services.asset_service.pagers.SearchAllResourcesPager	Search all resources response. Iterating over this object will yield results and resolve additional pages automatically.