Class AssetServiceAsyncClient (2.2.2)

AssetServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.asset_v1.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, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Asset service definition.

Properties

transport

Return the transport used by the client instance.

Returns

Type	Description
`AssetServiceTransport`	The transport used by the client instance.

Methods

AssetServiceAsyncClient

AssetServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.asset_v1.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, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

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_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.

Exceptions

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

analyze_iam_policy

analyze_iam_policy(request: Optional[google.cloud.asset_v1.types.asset_service.AnalyzeIamPolicyRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Analyzes IAM policies to answer which identities have what accesses on which resources.

Parameters

Name	Description
`request`	`.asset_service.AnalyzeIamPolicyRequest` The request object. A request message for AssetService.AnalyzeIamPolicy.
`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
`.asset_service.AnalyzeIamPolicyResponse`	A response message for AssetService.AnalyzeIamPolicy.

analyze_iam_policy_longrunning

analyze_iam_policy_longrunning(request: Optional[google.cloud.asset_v1.types.asset_service.AnalyzeIamPolicyLongrunningRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Analyzes IAM policies asynchronously to answer which identities have what accesses on which resources, and writes the analysis results to a Google Cloud Storage or a BigQuery destination. For Cloud Storage destination, the output format is the JSON format that represents a xref_AnalyzeIamPolicyResponse. This method implements the google.longrunning.Operation][google.longrunning.Operation], which allows you to track the operation status. We recommend intervals of at least 2 seconds with exponential backoff retry to poll the operation result. The metadata contains the request to help callers to map responses to requests.

Parameters

Name	Description
`request`	`.asset_service.AnalyzeIamPolicyLongrunningRequest` The request object. A request message for AssetService.AnalyzeIamPolicyLongrunning.
`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
`.operation_async.AsyncOperation`	An object representing a long-running operation. The result type for the operation will be .asset_service.AnalyzeIamPolicyLongrunningResponse : A response message for AssetService.AnalyzeIamPolicyLongrunning.

asset_path

asset_path()

Return a fully-qualified asset string.

batch_get_assets_history

batch_get_assets_history(request: Optional[google.cloud.asset_v1.types.asset_service.BatchGetAssetsHistoryRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Batch gets the update history of assets that overlap a time window. For IAM_POLICY content, this API outputs history when the asset and its attached IAM POLICY both exist. This can create gaps in the output history. Otherwise, this API outputs history with asset in both non-delete or deleted status. If a specified asset does not exist, this API returns an INVALID_ARGUMENT error.

Parameters

Name	Description
`request`	`.asset_service.BatchGetAssetsHistoryRequest` The request object. Batch get assets history request.
`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
`.asset_service.BatchGetAssetsHistoryResponse`	Batch get assets history response.

common_billing_account_path

common_billing_account_path(billing_account: str)

Return a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Return a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Return a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Return a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Return a fully-qualified project string.

create_feed

create_feed(request: Optional[google.cloud.asset_v1.types.asset_service.CreateFeedRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a feed in a parent project/folder/organization to listen to its asset updates.

Parameters

Name	Description
`request`	`.asset_service.CreateFeedRequest` The request object. Create asset feed request.
`parent`	`str` Required. The name of the project/folder/organization where this feed should be created in. It can only be an organization number (such as "organizations/123"), a folder number (such as "folders/123"), a project ID (such as "projects/my-project-id")", or a project number (such as "projects/12345"). This corresponds to the `parent` 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
`.asset_service.Feed`	An asset feed used to export asset updates to a destinations. An asset feed filter controls what updates are exported. The asset feed must be created within a project, organization, or folder. Supported destinations are: Pub/Sub topics.

delete_feed

delete_feed(request: Optional[google.cloud.asset_v1.types.asset_service.DeleteFeedRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes an asset feed.

Parameters

Name	Description
`request`	`.asset_service.DeleteFeedRequest` The request object.
`name`	`str` Required. The name of the feed and it must be in the format of: projects/project_number/feeds/feed_id folders/folder_number/feeds/feed_id organizations/organization_number/feeds/feed_id This corresponds to the `name` 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.

export_assets

export_assets(request: Optional[google.cloud.asset_v1.types.asset_service.ExportAssetsRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Exports assets with time and resource types to a given Cloud Storage location/BigQuery table. For Cloud Storage location destinations, the output format is newline-delimited JSON. Each line represents a xref_google.cloud.asset.v1.Asset in the JSON format; for BigQuery table destinations, the output table stores the fields in asset proto as columns. This API implements the google.longrunning.Operation][google.longrunning.Operation] API , which allows you to keep track of the export. We recommend intervals of at least 2 seconds with exponential retry to poll the export operation result. For regular-size resource parent, the export operation usually finishes within 5 minutes.

Parameters

Name	Description
`request`	`.asset_service.ExportAssetsRequest` The request object. Export asset request.
`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
`.operation_async.AsyncOperation`	An object representing a long-running operation. The result type for the operation will be .asset_service.ExportAssetsResponse : The export asset response. This message is returned by the `google.longrunning.Operations.GetOperation][google.longrunning.Operations.GetOperation]` method in the returned `google.longrunning.Operation.response][google.longrunning.Operation.response]` field.

feed_path

feed_path(project: str, feed: str)

Return a fully-qualified feed 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
`{@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_feed

get_feed(request: Optional[google.cloud.asset_v1.types.asset_service.GetFeedRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets details about an asset feed.

Parameters

Name	Description
`request`	`.asset_service.GetFeedRequest` The request object. Get asset feed request.
`name`	`str` Required. The name of the Feed and it must be in the format of: projects/project_number/feeds/feed_id folders/folder_number/feeds/feed_id organizations/organization_number/feeds/feed_id This corresponds to the `name` 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
`.asset_service.Feed`	An asset feed used to export asset updates to a destinations. An asset feed filter controls what updates are exported. The asset feed must be created within a project, organization, or folder. Supported destinations are: Pub/Sub topics.

get_transport_class

get_transport_class()

Return an appropriate transport class.

list_feeds

list_feeds(request: Optional[google.cloud.asset_v1.types.asset_service.ListFeedsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists all asset feeds in a parent project/folder/organization.

Parameters

Name	Description
`request`	`.asset_service.ListFeedsRequest` The request object. List asset feeds request.
`parent`	`str` Required. The parent project/folder/organization whose feeds are to be listed. It can only be using project/folder/organization number (such as "folders/12345")", or a project ID (such as "projects/my-project-id"). This corresponds to the `parent` 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.

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.

parse_feed_path

parse_feed_path(path: str)

Parse a feed path into its component segments.

search_all_iam_policies

search_all_iam_policies(request: Optional[google.cloud.asset_v1.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 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.

Parameters

Name	Description
`request`	`.asset_service.SearchAllIamPoliciesRequest` The request object. Search all IAM policies request.
`scope`	`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`	`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:amy@gmail.com` to find IAM policy bindings that specify user "amy@gmail.com". - `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

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_v1.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 Cloud resources within the specified scope, such as a project, folder, or organization. The caller must be granted the cloudasset.assets.searchAllResources permission on the desired scope, otherwise the request will be rejected.

Parameters

Name	Description
`request`	`.asset_service.SearchAllResourcesRequest` The request object. Search all resources request.
`scope`	`str` Required. A scope can be a project, a folder, or an organization. The search is limited to the resources within the `scope`. The caller must be granted the ```cloudasset.assets.searchAllResources` `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`	`str` Optional. The query statement. See `how to construct a query http://cloud.google.com/asset-inventory/docs/searching-resources#how_to_construct_a_query` for more information. If not specified or empty, it will search all the resources within the specified `scope`. Note that the query string is compared against each Cloud IAM policy binding, including its members, roles, and Cloud IAM conditions. The returned Cloud IAM policies will only contain the bindings that match your query. To learn more about the IAM policy structure, see `IAM policy doc https://cloud.google.com/iam/docs/policies#structure`. Examples: - `name:Important` to find Cloud resources whose name contains "Important" as a word. - `displayName:Impor` to find Cloud resources whose display name contains "Impor" as a prefix. - `description:por` to find Cloud resources whose description contains "por" as a substring. - `location:us-west` to find Cloud resources whose location is prefixed with "us-west". - `labels:prod` to find Cloud resources whose labels contain "prod" as a key or value. - `labels.env:prod` to find Cloud resources that have a label "env" and its value is "prod". - `labels.env:` to find Cloud resources that have a label "env". - `Important` to find Cloud resources that contain "Important" as a word in any of the searchable fields. - `Impor` to find Cloud resources that contain "Impor" as a prefix in any of the searchable fields. - `por` to find Cloud resources that contain "por" as a substring in any of the searchable fields. - `Important location:(us-west1 OR global)` to find Cloud resources that contain "Important" as a word in any of the searchable fields and are also located in the "us-west1" region or the "global" location. 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 `searchable asset types https://cloud.google.com/asset-inventory/docs/supported-asset-types#searchable_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.

update_feed

update_feed(request: Optional[google.cloud.asset_v1.types.asset_service.UpdateFeedRequest] = None, *, feed: Optional[google.cloud.asset_v1.types.asset_service.Feed] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates an asset feed configuration.

Parameters

Name	Description
`request`	`.asset_service.UpdateFeedRequest` The request object. Update asset feed request.
`feed`	`.asset_service.Feed` Required. The new values of feed details. It must match an existing feed and the field `name` must be in the format of: projects/project_number/feeds/feed_id or folders/folder_number/feeds/feed_id or organizations/organization_number/feeds/feed_id. This corresponds to the `feed` 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
`.asset_service.Feed`	An asset feed used to export asset updates to a destinations. An asset feed filter controls what updates are exported. The asset feed must be created within a project, organization, or folder. Supported destinations are: Pub/Sub topics.