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.

AssetService¶

class google.cloud.asset_v1.services.asset_service.AssetServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.asset_v1.services.asset_service.transports.base.AssetServiceTransport, typing.Callable[[...], google.cloud.asset_v1.services.asset_service.transports.base.AssetServiceTransport]]] = 'grpc_asyncio', client_options: typing.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>)[source]¶

Asset service definition.

Instantiates the asset service async client.

Parameters

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 (Optional[Union[str,AssetServiceTransport,Callable[..., AssetServiceTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport to use. If a Callable is given, it will be called with the same set of initialization arguments as used in the AssetServiceTransport constructor. If set to None, a transport is chosen automatically.
client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –
Custom options for the client.

1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “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).

2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS 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.

3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
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.

Raises

google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.

static access_level_path(access_policy: str, access_level: str) → str¶: Returns a fully-qualified access_level string.

static access_policy_path(access_policy: str) → str¶: Returns a fully-qualified access_policy string.

async analyze_iam_policy(request: Optional[Union[google.cloud.asset_v1.types.asset_service.AnalyzeIamPolicyRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.asset_v1.types.asset_service.AnalyzeIamPolicyResponse[source]¶

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import asset_v1

async def sample_analyze_iam_policy():
    # Create a client
    client = asset_v1.AssetServiceAsyncClient()

    # Initialize request argument(s)
    analysis_query = asset_v1.IamPolicyAnalysisQuery()
    analysis_query.scope = "scope_value"

    request = asset_v1.AnalyzeIamPolicyRequest(
        analysis_query=analysis_query,
    )

    # Make the request
    response = await client.analyze_iam_policy(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.asset_v1.types.AnalyzeIamPolicyRequest, dict]]) – The request object. A request message for [AssetService.AnalyzeIamPolicy][google.cloud.asset.v1.AssetService.AnalyzeIamPolicy].
retry (google.api_core.retry_async.AsyncRetry) – 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

A response message for: [AssetService.AnalyzeIamPolicy][google.cloud.asset.v1.AssetService.AnalyzeIamPolicy].

Return type

google.cloud.asset_v1.types.AnalyzeIamPolicyResponse

async analyze_iam_policy_longrunning(request: Optional[Union[google.cloud.asset_v1.types.asset_service.AnalyzeIamPolicyLongrunningRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

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 [AnalyzeIamPolicyResponse][google.cloud.asset.v1.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 metadata for the long-running operation.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import asset_v1

async def sample_analyze_iam_policy_longrunning():
    # Create a client
    client = asset_v1.AssetServiceAsyncClient()

    # Initialize request argument(s)
    analysis_query = asset_v1.IamPolicyAnalysisQuery()
    analysis_query.scope = "scope_value"

    output_config = asset_v1.IamPolicyAnalysisOutputConfig()
    output_config.gcs_destination.uri = "uri_value"

    request = asset_v1.AnalyzeIamPolicyLongrunningRequest(
        analysis_query=analysis_query,
        output_config=output_config,
    )

    # Make the request
    operation = client.analyze_iam_policy_longrunning(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.asset_v1.types.AnalyzeIamPolicyLongrunningRequest, dict]]) – The request object. A request message for [AssetService.AnalyzeIamPolicyLongrunning][google.cloud.asset.v1.AssetService.AnalyzeIamPolicyLongrunning].
retry (google.api_core.retry_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.asset_v1.types.AnalyzeIamPolicyLongrunningResponse A response message for: [AssetService.AnalyzeIamPolicyLongrunning][google.cloud.asset.v1.AssetService.AnalyzeIamPolicyLongrunning].

Return type

google.api_core.operation_async.AsyncOperation

async analyze_move(request: Optional[Union[google.cloud.asset_v1.types.asset_service.AnalyzeMoveRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.asset_v1.types.asset_service.AnalyzeMoveResponse[source]¶

Analyze moving a resource to a specified destination without kicking off the actual move. The analysis is best effort depending on the user’s permissions of viewing different hierarchical policies and configurations. The policies and configuration are subject to change before the actual resource migration takes place.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import asset_v1

async def sample_analyze_move():
    # Create a client
    client = asset_v1.AssetServiceAsyncClient()

    # Initialize request argument(s)
    request = asset_v1.AnalyzeMoveRequest(
        resource="resource_value",
        destination_parent="destination_parent_value",
    )

    # Make the request
    response = await client.analyze_move(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.asset_v1.types.AnalyzeMoveRequest, dict]]) – The request object. The request message for performing resource move analysis.
retry (google.api_core.retry_async.AsyncRetry) – 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

The response message for resource move analysis.

Return type

google.cloud.asset_v1.types.AnalyzeMoveResponse

async analyze_org_policies(request: Optional[Union[google.cloud.asset_v1.types.asset_service.AnalyzeOrgPoliciesRequest, dict]] = None, *, scope: Optional[str] = None, constraint: Optional[str] = None, filter: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.asset_v1.services.asset_service.pagers.AnalyzeOrgPoliciesAsyncPager[source]¶

Analyzes organization policies under a scope.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import asset_v1

async def sample_analyze_org_policies():
    # Create a client
    client = asset_v1.AssetServiceAsyncClient()

    # Initialize request argument(s)
    request = asset_v1.AnalyzeOrgPoliciesRequest(
        scope="scope_value",
        constraint="constraint_value",
    )

    # Make the request
    page_result = client.analyze_org_policies(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

request (Optional[Union[google.cloud.asset_v1.types.AnalyzeOrgPoliciesRequest, dict]]) – The request object. A request message for [AssetService.AnalyzeOrgPolicies][google.cloud.asset.v1.AssetService.AnalyzeOrgPolicies].
scope (str) –
Required. The organization to scope the request. Only organization policies within the scope will be analyzed.
- 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.
constraint (str) –
Required. The name of the constraint to analyze organization policies for. The response only contains analyzed organization policies for the provided constraint.

This corresponds to the constraint field on the request instance; if request is provided, this should not be set.
filter (str) –
The expression to filter [AnalyzeOrgPoliciesResponse.org_policy_results][google.cloud.asset.v1.AnalyzeOrgPoliciesResponse.org_policy_results]. Filtering is currently available for bare literal values and the following fields:
- consolidated_policy.attached_resource
- consolidated_policy.rules.enforce
When filtering by a specific field, the only supported operator is =. For example, filtering by consolidated_policy.attached_resource=”//cloudresourcemanager.googleapis.com/folders/001” will return all the Organization Policy results attached to “folders/001”.

This corresponds to the filter field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

The response message for: [AssetService.AnalyzeOrgPolicies][google.cloud.asset.v1.AssetService.AnalyzeOrgPolicies].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.asset_v1.services.asset_service.pagers.AnalyzeOrgPoliciesAsyncPager

async analyze_org_policy_governed_assets(request: Optional[Union[google.cloud.asset_v1.types.asset_service.AnalyzeOrgPolicyGovernedAssetsRequest, dict]] = None, *, scope: Optional[str] = None, constraint: Optional[str] = None, filter: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.asset_v1.services.asset_service.pagers.AnalyzeOrgPolicyGovernedAssetsAsyncPager[source]¶

Analyzes organization policies governed assets (Google Cloud resources or policies) under a scope. This RPC supports custom constraints and the following canned constraints:

constraints/ainotebooks.accessMode
constraints/ainotebooks.disableFileDownloads
constraints/ainotebooks.disableRootAccess
constraints/ainotebooks.disableTerminal
constraints/ainotebooks.environmentOptions
constraints/ainotebooks.requireAutoUpgradeSchedule
constraints/ainotebooks.restrictVpcNetworks
constraints/compute.disableGuestAttributesAccess
constraints/compute.disableInstanceDataAccessApis
constraints/compute.disableNestedVirtualization
constraints/compute.disableSerialPortAccess
constraints/compute.disableSerialPortLogging
constraints/compute.disableVpcExternalIpv6
constraints/compute.requireOsLogin
constraints/compute.requireShieldedVm
constraints/compute.restrictLoadBalancerCreationForTypes
constraints/compute.restrictProtocolForwardingCreationForTypes
constraints/compute.restrictXpnProjectLienRemoval
constraints/compute.setNewProjectDefaultToZonalDNSOnly
constraints/compute.skipDefaultNetworkCreation
constraints/compute.trustedImageProjects
constraints/compute.vmCanIpForward
constraints/compute.vmExternalIpAccess
constraints/gcp.detailedAuditLoggingMode
constraints/gcp.resourceLocations
constraints/iam.allowedPolicyMemberDomains
constraints/iam.automaticIamGrantsForDefaultServiceAccounts
constraints/iam.disableServiceAccountCreation
constraints/iam.disableServiceAccountKeyCreation
constraints/iam.disableServiceAccountKeyUpload
constraints/iam.restrictCrossProjectServiceAccountLienRemoval
constraints/iam.serviceAccountKeyExpiryHours
constraints/resourcemanager.accessBoundaries
constraints/resourcemanager.allowedExportDestinations
constraints/sql.restrictAuthorizedNetworks
constraints/sql.restrictNoncompliantDiagnosticDataAccess
constraints/sql.restrictNoncompliantResourceCreation
constraints/sql.restrictPublicIp
constraints/storage.publicAccessPrevention
constraints/storage.restrictAuthTypes
constraints/storage.uniformBucketLevelAccess

This RPC only returns either resources of types supported by search APIs or IAM policies.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import asset_v1

async def sample_analyze_org_policy_governed_assets():
    # Create a client
    client = asset_v1.AssetServiceAsyncClient()

    # Initialize request argument(s)
    request = asset_v1.AnalyzeOrgPolicyGovernedAssetsRequest(
        scope="scope_value",
        constraint="constraint_value",
    )

    # Make the request
    page_result = client.analyze_org_policy_governed_assets(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

request (Optional[Union[google.cloud.asset_v1.types.AnalyzeOrgPolicyGovernedAssetsRequest, dict]]) – The request object. A request message for [AssetService.AnalyzeOrgPolicyGovernedAssets][google.cloud.asset.v1.AssetService.AnalyzeOrgPolicyGovernedAssets].
scope (str) –
Required. The organization to scope the request. Only organization policies within the scope will be analyzed. The output assets will also be limited to the ones governed by those in-scope organization policies.
- 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.
constraint (str) –
Required. The name of the constraint to analyze governed assets for. The analysis only contains analyzed organization policies for the provided constraint.

This corresponds to the constraint field on the request instance; if request is provided, this should not be set.
filter (str) –
The expression to filter [AnalyzeOrgPolicyGovernedAssetsResponse.governed_assets][google.cloud.asset.v1.AnalyzeOrgPolicyGovernedAssetsResponse.governed_assets].

For governed resources, filtering is currently available for bare literal values and the following fields:
- governed_resource.project
- governed_resource.folders
- consolidated_policy.rules.enforce When filtering by governed_resource.project or consolidated_policy.rules.enforce, the only supported operator is =. When filtering by governed_resource.folders, the supported operators are = and :. For example, filtering by governed_resource.project="projects/12345678" will return all the governed resources under “projects/12345678”, including the project itself if applicable.
For governed IAM policies, filtering is currently available for bare literal values and the following fields:
- governed_iam_policy.project
- governed_iam_policy.folders
- consolidated_policy.rules.enforce When filtering by governed_iam_policy.project or consolidated_policy.rules.enforce, the only supported operator is =. When filtering by governed_iam_policy.folders, the supported operators are = and :. For example, filtering by governed_iam_policy.folders:"folders/12345678" will return all the governed IAM policies under “folders/001”.
This corresponds to the filter field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

The response message for: [AssetService.AnalyzeOrgPolicyGovernedAssets][google.cloud.asset.v1.AssetService.AnalyzeOrgPolicyGovernedAssets].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.asset_v1.services.asset_service.pagers.AnalyzeOrgPolicyGovernedAssetsAsyncPager

async analyze_org_policy_governed_containers(request: Optional[Union[google.cloud.asset_v1.types.asset_service.AnalyzeOrgPolicyGovernedContainersRequest, dict]] = None, *, scope: Optional[str] = None, constraint: Optional[str] = None, filter: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.asset_v1.services.asset_service.pagers.AnalyzeOrgPolicyGovernedContainersAsyncPager[source]¶

Analyzes organization policies governed containers (projects, folders or organization) under a scope.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import asset_v1

async def sample_analyze_org_policy_governed_containers():
    # Create a client
    client = asset_v1.AssetServiceAsyncClient()

    # Initialize request argument(s)
    request = asset_v1.AnalyzeOrgPolicyGovernedContainersRequest(
        scope="scope_value",
        constraint="constraint_value",
    )

    # Make the request
    page_result = client.analyze_org_policy_governed_containers(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

request (Optional[Union[google.cloud.asset_v1.types.AnalyzeOrgPolicyGovernedContainersRequest, dict]]) – The request object. A request message for [AssetService.AnalyzeOrgPolicyGovernedContainers][google.cloud.asset.v1.AssetService.AnalyzeOrgPolicyGovernedContainers].
scope (str) –
Required. The organization to scope the request. Only organization policies within the scope will be analyzed. The output containers will also be limited to the ones governed by those in-scope organization policies.
- 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.
constraint (str) –
Required. The name of the constraint to analyze governed containers for. The analysis only contains organization policies for the provided constraint.

This corresponds to the constraint field on the request instance; if request is provided, this should not be set.
filter (str) –
The expression to filter [AnalyzeOrgPolicyGovernedContainersResponse.governed_containers][google.cloud.asset.v1.AnalyzeOrgPolicyGovernedContainersResponse.governed_containers]. Filtering is currently available for bare literal values and the following fields:
- parent
- consolidated_policy.rules.enforce
When filtering by a specific field, the only supported operator is =. For example, filtering by parent=”//cloudresourcemanager.googleapis.com/folders/001” will return all the containers under “folders/001”.

This corresponds to the filter field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

The response message for: [AssetService.AnalyzeOrgPolicyGovernedContainers][google.cloud.asset.v1.AssetService.AnalyzeOrgPolicyGovernedContainers].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.asset_v1.services.asset_service.pagers.AnalyzeOrgPolicyGovernedContainersAsyncPager

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

static asset_path() → str¶: Returns a fully-qualified asset string.

async batch_get_assets_history(request: Optional[Union[google.cloud.asset_v1.types.asset_service.BatchGetAssetsHistoryRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.asset_v1.types.asset_service.BatchGetAssetsHistoryResponse[source]¶

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import asset_v1

async def sample_batch_get_assets_history():
    # Create a client
    client = asset_v1.AssetServiceAsyncClient()

    # Initialize request argument(s)
    request = asset_v1.BatchGetAssetsHistoryRequest(
        parent="parent_value",
    )

    # Make the request
    response = await client.batch_get_assets_history(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.asset_v1.types.BatchGetAssetsHistoryRequest, dict]]) – The request object. Batch get assets history request.
retry (google.api_core.retry_async.AsyncRetry) – 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

Batch get assets history response.

Return type

google.cloud.asset_v1.types.BatchGetAssetsHistoryResponse

async batch_get_effective_iam_policies(request: Optional[Union[google.cloud.asset_v1.types.asset_service.BatchGetEffectiveIamPoliciesRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.asset_v1.types.asset_service.BatchGetEffectiveIamPoliciesResponse[source]¶

Gets effective IAM policies for a batch of resources.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import asset_v1

async def sample_batch_get_effective_iam_policies():
    # Create a client
    client = asset_v1.AssetServiceAsyncClient()

    # Initialize request argument(s)
    request = asset_v1.BatchGetEffectiveIamPoliciesRequest(
        scope="scope_value",
        names=['names_value1', 'names_value2'],
    )

    # Make the request
    response = await client.batch_get_effective_iam_policies(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.asset_v1.types.BatchGetEffectiveIamPoliciesRequest, dict]]) – The request object. A request message for [AssetService.BatchGetEffectiveIamPolicies][google.cloud.asset.v1.AssetService.BatchGetEffectiveIamPolicies].
retry (google.api_core.retry_async.AsyncRetry) – 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

A response message for: [AssetService.BatchGetEffectiveIamPolicies][google.cloud.asset.v1.AssetService.BatchGetEffectiveIamPolicies].

Return type

google.cloud.asset_v1.types.BatchGetEffectiveIamPoliciesResponse

static common_billing_account_path(billing_account: str) → str¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str¶: Returns a fully-qualified project string.

async create_feed(request: Optional[Union[google.cloud.asset_v1.types.asset_service.CreateFeedRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.asset_v1.types.asset_service.Feed[source]¶

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import asset_v1

async def sample_create_feed():
    # Create a client
    client = asset_v1.AssetServiceAsyncClient()

    # Initialize request argument(s)
    feed = asset_v1.Feed()
    feed.name = "name_value"

    request = asset_v1.CreateFeedRequest(
        parent="parent_value",
        feed_id="feed_id_value",
        feed=feed,
    )

    # Make the request
    response = await client.create_feed(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.asset_v1.types.CreateFeedRequest, dict]]) – 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_async.AsyncRetry) – 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

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.

Return type

google.cloud.asset_v1.types.Feed

async create_saved_query(request: Optional[Union[google.cloud.asset_v1.types.asset_service.CreateSavedQueryRequest, dict]] = None, *, parent: Optional[str] = None, saved_query: Optional[google.cloud.asset_v1.types.asset_service.SavedQuery] = None, saved_query_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.asset_v1.types.asset_service.SavedQuery[source]¶

Creates a saved query in a parent project/folder/organization.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import asset_v1

async def sample_create_saved_query():
    # Create a client
    client = asset_v1.AssetServiceAsyncClient()

    # Initialize request argument(s)
    request = asset_v1.CreateSavedQueryRequest(
        parent="parent_value",
        saved_query_id="saved_query_id_value",
    )

    # Make the request
    response = await client.create_saved_query(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.asset_v1.types.CreateSavedQueryRequest, dict]]) – The request object. Request to create a saved query.
parent (str) –
Required. The name of the project/folder/organization where this saved_query 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.
saved_query (google.cloud.asset_v1.types.SavedQuery) –
Required. The saved_query details. The name field must be empty as it will be generated based on the parent and saved_query_id.

This corresponds to the saved_query field on the request instance; if request is provided, this should not be set.
saved_query_id (str) –
Required. The ID to use for the saved query, which must be unique in the specified parent. It will become the final component of the saved query’s resource name.

This value should be 4-63 characters, and valid characters are [a-z][0-9]-.

Notice that this field is required in the saved query creation, and the name field of the saved_query will be ignored.

This corresponds to the saved_query_id field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

A saved query which can be shared with others or used later.

Return type

google.cloud.asset_v1.types.SavedQuery

async delete_feed(request: Optional[Union[google.cloud.asset_v1.types.asset_service.DeleteFeedRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

Deletes an asset feed.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import asset_v1

async def sample_delete_feed():
    # Create a client
    client = asset_v1.AssetServiceAsyncClient()

    # Initialize request argument(s)
    request = asset_v1.DeleteFeedRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_feed(request=request)

Parameters

request (Optional[Union[google.cloud.asset_v1.types.DeleteFeedRequest, dict]]) – 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_async.AsyncRetry) – 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.

async delete_saved_query(request: Optional[Union[google.cloud.asset_v1.types.asset_service.DeleteSavedQueryRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

Deletes a saved query.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import asset_v1

async def sample_delete_saved_query():
    # Create a client
    client = asset_v1.AssetServiceAsyncClient()

    # Initialize request argument(s)
    request = asset_v1.DeleteSavedQueryRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_saved_query(request=request)

Parameters

request (Optional[Union[google.cloud.asset_v1.types.DeleteSavedQueryRequest, dict]]) – The request object. Request to delete a saved query.
name (str) –
Required. The name of the saved query to delete. It must be in the format of:
- projects/project_number/savedQueries/saved_query_id
- folders/folder_number/savedQueries/saved_query_id
- organizations/organization_number/savedQueries/saved_query_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_async.AsyncRetry) – 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.

async export_assets(request: Optional[Union[google.cloud.asset_v1.types.asset_service.ExportAssetsRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

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 [google.cloud.asset.v1.Asset][google.cloud.asset.v1.Asset] in the JSON format; for BigQuery table destinations, the output table stores the fields in asset Protobuf 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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import asset_v1

async def sample_export_assets():
    # Create a client
    client = asset_v1.AssetServiceAsyncClient()

    # Initialize request argument(s)
    output_config = asset_v1.OutputConfig()
    output_config.gcs_destination.uri = "uri_value"

    request = asset_v1.ExportAssetsRequest(
        parent="parent_value",
        output_config=output_config,
    )

    # Make the request
    operation = client.export_assets(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.asset_v1.types.ExportAssetsRequest, dict]]) – The request object. Export asset request.
retry (google.api_core.retry_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.asset_v1.types.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.

Return type

google.api_core.operation_async.AsyncOperation

static feed_path(project: str, feed: str) → str¶: Returns a fully-qualified feed string.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

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

Parameters

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

The constructed client.

Return type

AssetServiceAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

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

Parameters

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

The constructed client.

Return type

AssetServiceAsyncClient

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

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

Parameters

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

The constructed client.

Return type

AssetServiceAsyncClient

async get_feed(request: Optional[Union[google.cloud.asset_v1.types.asset_service.GetFeedRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.asset_v1.types.asset_service.Feed[source]¶

Gets details about an asset feed.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import asset_v1

async def sample_get_feed():
    # Create a client
    client = asset_v1.AssetServiceAsyncClient()

    # Initialize request argument(s)
    request = asset_v1.GetFeedRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_feed(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.asset_v1.types.GetFeedRequest, dict]]) – 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_async.AsyncRetry) – 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

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.

Return type

google.cloud.asset_v1.types.Feed

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not “true”, the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “always”, use the default mTLS endpoint; if the environment variable is “never”, use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

async get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.Operation[source]¶

Gets the latest state of a long-running operation.

Parameters

request (GetOperationRequest) – The request object. Request message for GetOperation method.
retry (google.api_core.retry_async.AsyncRetry) – 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

An Operation object.

Return type

Operation

async get_saved_query(request: Optional[Union[google.cloud.asset_v1.types.asset_service.GetSavedQueryRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.asset_v1.types.asset_service.SavedQuery[source]¶

Gets details about a saved query.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import asset_v1

async def sample_get_saved_query():
    # Create a client
    client = asset_v1.AssetServiceAsyncClient()

    # Initialize request argument(s)
    request = asset_v1.GetSavedQueryRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_saved_query(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.asset_v1.types.GetSavedQueryRequest, dict]]) – The request object. Request to get a saved query.
name (str) –
Required. The name of the saved query and it must be in the format of:
- projects/project_number/savedQueries/saved_query_id
- folders/folder_number/savedQueries/saved_query_id
- organizations/organization_number/savedQueries/saved_query_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_async.AsyncRetry) – 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

A saved query which can be shared with others or used later.

Return type

google.cloud.asset_v1.types.SavedQuery

classmethod get_transport_class(label: Optional[str] = None) → Type[google.cloud.asset_v1.services.asset_service.transports.base.AssetServiceTransport]¶

Returns an appropriate transport class.

Parameters: label – The name of the desired transport. If none is provided, then the first transport in the registry is used.
Returns: The transport class to use.

static inventory_path(project: str, location: str, instance: str) → str¶: Returns a fully-qualified inventory string.

async list_assets(request: Optional[Union[google.cloud.asset_v1.types.asset_service.ListAssetsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.asset_v1.services.asset_service.pagers.ListAssetsAsyncPager[source]¶

Lists assets with time and resource types and returns paged results in response.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import asset_v1

async def sample_list_assets():
    # Create a client
    client = asset_v1.AssetServiceAsyncClient()

    # Initialize request argument(s)
    request = asset_v1.ListAssetsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_assets(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

request (Optional[Union[google.cloud.asset_v1.types.ListAssetsRequest, dict]]) – The request object. ListAssets request.
parent (str) –
Required. Name of the organization, folder, or project the assets belong to. Format: “organizations/[organization-number]” (such as “organizations/123”), “projects/[project-id]” (such as “projects/my-project-id”), “projects/[project-number]” (such as “projects/12345”), or “folders/[folder-number]” (such as “folders/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_async.AsyncRetry) – 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

ListAssets response.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.asset_v1.services.asset_service.pagers.ListAssetsAsyncPager

async list_feeds(request: Optional[Union[google.cloud.asset_v1.types.asset_service.ListFeedsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.asset_v1.types.asset_service.ListFeedsResponse[source]¶

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import asset_v1

async def sample_list_feeds():
    # Create a client
    client = asset_v1.AssetServiceAsyncClient()

    # Initialize request argument(s)
    request = asset_v1.ListFeedsRequest(
        parent="parent_value",
    )

    # Make the request
    response = await client.list_feeds(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.asset_v1.types.ListFeedsRequest, dict]]) – 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_async.AsyncRetry) – 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.

Return type

google.cloud.asset_v1.types.ListFeedsResponse

async list_saved_queries(request: Optional[Union[google.cloud.asset_v1.types.asset_service.ListSavedQueriesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.asset_v1.services.asset_service.pagers.ListSavedQueriesAsyncPager[source]¶

Lists all saved queries in a parent project/folder/organization.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import asset_v1

async def sample_list_saved_queries():
    # Create a client
    client = asset_v1.AssetServiceAsyncClient()

    # Initialize request argument(s)
    request = asset_v1.ListSavedQueriesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_saved_queries(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

request (Optional[Union[google.cloud.asset_v1.types.ListSavedQueriesRequest, dict]]) – The request object. Request to list saved queries.
parent (str) –
Required. The parent project/folder/organization whose savedQueries 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_async.AsyncRetry) – 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

Response of listing saved queries.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.asset_v1.services.asset_service.pagers.ListSavedQueriesAsyncPager

static parse_access_level_path(path: str) → Dict[str, str]¶: Parses a access_level path into its component segments.

static parse_access_policy_path(path: str) → Dict[str, str]¶: Parses a access_policy path into its component segments.

static parse_asset_path(path: str) → Dict[str, str]¶: Parses a asset path into its component segments.

static parse_common_billing_account_path(path: str) → Dict[str, str]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str]¶: Parse a project path into its component segments.

static parse_feed_path(path: str) → Dict[str, str]¶: Parses a feed path into its component segments.

static parse_inventory_path(path: str) → Dict[str, str]¶: Parses a inventory path into its component segments.

static parse_saved_query_path(path: str) → Dict[str, str]¶: Parses a saved_query path into its component segments.

static parse_service_perimeter_path(path: str) → Dict[str, str]¶: Parses a service_perimeter path into its component segments.

async query_assets(request: Optional[Union[google.cloud.asset_v1.types.asset_service.QueryAssetsRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.asset_v1.types.asset_service.QueryAssetsResponse[source]¶

Issue a job that queries assets using a SQL statement compatible with BigQuery SQL.

If the query execution finishes within timeout and there’s no pagination, the full query results will be returned in the QueryAssetsResponse.

Otherwise, full query results can be obtained by issuing extra requests with the job_reference from the a previous QueryAssets call.

Note, the query result has approximately 10 GB limitation enforced by BigQuery. Queries return larger results will result in errors.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import asset_v1

async def sample_query_assets():
    # Create a client
    client = asset_v1.AssetServiceAsyncClient()

    # Initialize request argument(s)
    request = asset_v1.QueryAssetsRequest(
        statement="statement_value",
        parent="parent_value",
    )

    # Make the request
    response = await client.query_assets(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.asset_v1.types.QueryAssetsRequest, dict]]) – The request object. QueryAssets request.
retry (google.api_core.retry_async.AsyncRetry) – 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

QueryAssets response.

Return type

google.cloud.asset_v1.types.QueryAssetsResponse

static saved_query_path(project: str, saved_query: str) → str¶: Returns a fully-qualified saved_query string.

async search_all_iam_policies(request: Optional[Union[google.cloud.asset_v1.types.asset_service.SearchAllIamPoliciesRequest, dict]] = None, *, scope: Optional[str] = None, query: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.asset_v1.services.asset_service.pagers.SearchAllIamPoliciesAsyncPager[source]¶

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import asset_v1

async def sample_search_all_iam_policies():
    # Create a client
    client = asset_v1.AssetServiceAsyncClient()

    # Initialize request argument(s)
    request = asset_v1.SearchAllIamPoliciesRequest(
        scope="scope_value",
    )

    # Make the request
    page_result = client.search_all_iam_policies(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

request (Optional[Union[google.cloud.asset_v1.types.SearchAllIamPoliciesRequest, dict]]) – 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 <https://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 for more information. If not specified or empty, it will search all the IAM policies within the specified scope. Note that the query string is compared against each IAM policy binding, including its principals, roles, and IAM conditions. The returned IAM policies will only contain the bindings that match your query. To learn more about the IAM policy structure, see the IAM policy documentation.

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:comp* to find IAM policy bindings that contain “comp” as a prefix of any word in the binding.
- 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.
- policy.role.permissions:upd* to find IAM policy bindings that specify a role containing “upd” as a prefix of any word in the role 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”.
- resource=//cloudresourcemanager.googleapis.com/projects/myproject to find IAM policy bindings that are set on the project named “myproject”.
- Important to find IAM policy bindings that contain “Important” as a word 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”.
- roles:roles/compute.admin to find IAM policy bindings that specify the Compute Admin role.
- memberTypes:user to find IAM policy bindings that contain the principal type “user”.
This corresponds to the query field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

Search all IAM policies response.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.asset_v1.services.asset_service.pagers.SearchAllIamPoliciesAsyncPager

async search_all_resources(request: Optional[Union[google.cloud.asset_v1.types.asset_service.SearchAllResourcesRequest, dict]] = None, *, scope: Optional[str] = None, query: Optional[str] = None, asset_types: Optional[MutableSequence[str]] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.asset_v1.services.asset_service.pagers.SearchAllResourcesAsyncPager[source]¶

Searches all Google 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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import asset_v1

async def sample_search_all_resources():
    # Create a client
    client = asset_v1.AssetServiceAsyncClient()

    # Initialize request argument(s)
    request = asset_v1.SearchAllResourcesRequest(
        scope="scope_value",
    )

    # Make the request
    page_result = client.search_all_resources(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

request (Optional[Union[google.cloud.asset_v1.types.SearchAllResourcesRequest, dict]]) – 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 <https://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 for more information. If not specified or empty, it will search all the resources within the specified scope.

Examples:
- name:Important to find Google Cloud resources whose name contains Important as a word.
- name=Important to find the Google Cloud resource whose name is exactly Important.
- displayName:Impor* to find Google Cloud resources whose display name contains Impor as a prefix of any word in the field.
- location:us-west* to find Google Cloud resources whose location contains both us and west as prefixes.
- labels:prod to find Google Cloud resources whose labels contain prod as a key or value.
- labels.env:prod to find Google Cloud resources that have a label env and its value is prod.
- labels.env:* to find Google Cloud resources that have a label env.
- tagKeys:env to find Google Cloud resources that have directly attached tags where the `TagKey.namespacedName <https://cloud.google.com/resource-manager/reference/rest/v3/tagKeys#resource:-tagkey>`__ contains env.
- tagValues:prod* to find Google Cloud resources that have directly attached tags where the `TagValue.namespacedName <https://cloud.google.com/resource-manager/reference/rest/v3/tagValues#resource:-tagvalue>`__ contains a word prefixed by prod.
- tagValueIds=tagValues/123 to find Google Cloud resources that have directly attached tags where the `TagValue.name <https://cloud.google.com/resource-manager/reference/rest/v3/tagValues#resource:-tagvalue>`__ is exactly tagValues/123.
- effectiveTagKeys:env to find Google Cloud resources that have directly attached or inherited tags where the `TagKey.namespacedName <https://cloud.google.com/resource-manager/reference/rest/v3/tagKeys#resource:-tagkey>`__ contains env.
- effectiveTagValues:prod* to find Google Cloud resources that have directly attached or inherited tags where the `TagValue.namespacedName <https://cloud.google.com/resource-manager/reference/rest/v3/tagValues#resource:-tagvalue>`__ contains a word prefixed by prod.
- effectiveTagValueIds=tagValues/123 to find Google Cloud resources that have directly attached or inherited tags where the `TagValue.name <https://cloud.google.com/resource-manager/reference/rest/v3/tagValues#resource:-tagvalue>`__ is exactly tagValues/123.
- kmsKey:key to find Google Cloud resources encrypted with a customer-managed encryption key whose name contains key as a word. This field is deprecated. Use the kmsKeys field to retrieve Cloud KMS key information.
- kmsKeys:key to find Google Cloud resources encrypted with customer-managed encryption keys whose name contains the word key.
- relationships:instance-group-1 to find Google Cloud resources that have relationships with instance-group-1 in the related resource name.
- relationships:INSTANCE_TO_INSTANCEGROUP to find Compute Engine instances that have relationships of type INSTANCE_TO_INSTANCEGROUP.
- relationships.INSTANCE_TO_INSTANCEGROUP:instance-group-1 to find Compute Engine instances that have relationships with instance-group-1 in the Compute Engine instance group resource name, for relationship type INSTANCE_TO_INSTANCEGROUP.
- sccSecurityMarks.key=value to find Cloud resources that are attached with security marks whose key is key and value is value.
- sccSecurityMarks.key:* to find Cloud resources that are attached with security marks whose key is key.
- state:ACTIVE to find Google Cloud resources whose state contains ACTIVE as a word.
- NOT state:ACTIVE to find Google Cloud resources whose state doesn’t contain ACTIVE as a word.
- createTime<1609459200 to find Google Cloud resources that were created before 2021-01-01 00:00:00 UTC. 1609459200 is the epoch timestamp of 2021-01-01 00:00:00 UTC in seconds.
- updateTime>1609459200 to find Google Cloud resources that were updated after 2021-01-01 00:00:00 UTC. 1609459200 is the epoch timestamp of 2021-01-01 00:00:00 UTC in seconds.
- Important to find Google Cloud resources that contain Important as a word in any of the searchable fields.
- Impor* to find Google Cloud resources that contain Impor as a prefix of any word in any of the searchable fields.
- Important location:(us-west1 OR global) to find Google 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 (MutableSequence[str]) –
Optional. A list of asset types that this request searches for. If empty, it will search all the asset types supported by search APIs.

Regular expressions are also supported. For example:
- ”compute.googleapis.com.*” snapshots resources whose asset type starts with “compute.googleapis.com”.
- ”.*Instance” snapshots resources whose asset type ends with “Instance”.
- ”.*Instance.*” snapshots resources whose asset type contains “Instance”.
See RE2 for all supported regular expression syntax. If the regular expression does not match any supported asset type, an INVALID_ARGUMENT error will be returned.

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_async.AsyncRetry) – 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

Search all resources response.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.asset_v1.services.asset_service.pagers.SearchAllResourcesAsyncPager

static service_perimeter_path(access_policy: str, service_perimeter: str) → str¶: Returns a fully-qualified service_perimeter string.

property transport: google.cloud.asset_v1.services.asset_service.transports.base.AssetServiceTransport¶

Returns the transport used by the client instance.

Returns: The transport used by the client instance.
Return type: AssetServiceTransport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns

The universe domain used: by the client instance.

Return type

str

async update_feed(request: Optional[Union[google.cloud.asset_v1.types.asset_service.UpdateFeedRequest, dict]] = None, *, feed: Optional[google.cloud.asset_v1.types.asset_service.Feed] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.asset_v1.types.asset_service.Feed[source]¶

Updates an asset feed configuration.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import asset_v1

async def sample_update_feed():
    # Create a client
    client = asset_v1.AssetServiceAsyncClient()

    # Initialize request argument(s)
    feed = asset_v1.Feed()
    feed.name = "name_value"

    request = asset_v1.UpdateFeedRequest(
        feed=feed,
    )

    # Make the request
    response = await client.update_feed(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.asset_v1.types.UpdateFeedRequest, dict]]) – The request object. Update asset feed request.
feed (google.cloud.asset_v1.types.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_async.AsyncRetry) – 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

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.

Return type

google.cloud.asset_v1.types.Feed

async update_saved_query(request: Optional[Union[google.cloud.asset_v1.types.asset_service.UpdateSavedQueryRequest, dict]] = None, *, saved_query: Optional[google.cloud.asset_v1.types.asset_service.SavedQuery] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.asset_v1.types.asset_service.SavedQuery[source]¶

Updates a saved query.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import asset_v1

async def sample_update_saved_query():
    # Create a client
    client = asset_v1.AssetServiceAsyncClient()

    # Initialize request argument(s)
    request = asset_v1.UpdateSavedQueryRequest(
    )

    # Make the request
    response = await client.update_saved_query(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.asset_v1.types.UpdateSavedQueryRequest, dict]]) – The request object. Request to update a saved query.
saved_query (google.cloud.asset_v1.types.SavedQuery) –
Required. The saved query to update.

The saved query’s name field is used to identify the one to update, which has format as below:
- projects/project_number/savedQueries/saved_query_id
- folders/folder_number/savedQueries/saved_query_id
- organizations/organization_number/savedQueries/saved_query_id
This corresponds to the saved_query field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Required. The list of fields to update.

This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

A saved query which can be shared with others or used later.

Return type

google.cloud.asset_v1.types.SavedQuery

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

Asset service definition.

Instantiates the asset service client.

Parameters

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 (Optional[Union[str,AssetServiceTransport,Callable[..., AssetServiceTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the AssetServiceTransport constructor. If set to None, a transport is chosen automatically.
client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –
Custom options for the client.

1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “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).

2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS 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.

3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
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.

Raises

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

__exit__(type, value, traceback)[source]¶: Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

static access_level_path(access_policy: str, access_level: str) → str[source]¶: Returns a fully-qualified access_level string.

static access_policy_path(access_policy: str) → str[source]¶: Returns a fully-qualified access_policy string.

analyze_iam_policy(request: Optional[Union[google.cloud.asset_v1.types.asset_service.AnalyzeIamPolicyRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.asset_v1.types.asset_service.AnalyzeIamPolicyResponse[source]¶

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import asset_v1

def sample_analyze_iam_policy():
    # Create a client
    client = asset_v1.AssetServiceClient()

    # Initialize request argument(s)
    analysis_query = asset_v1.IamPolicyAnalysisQuery()
    analysis_query.scope = "scope_value"

    request = asset_v1.AnalyzeIamPolicyRequest(
        analysis_query=analysis_query,
    )

    # Make the request
    response = client.analyze_iam_policy(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.asset_v1.types.AnalyzeIamPolicyRequest, dict]) – The request object. A request message for [AssetService.AnalyzeIamPolicy][google.cloud.asset.v1.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

A response message for: [AssetService.AnalyzeIamPolicy][google.cloud.asset.v1.AssetService.AnalyzeIamPolicy].

Return type

google.cloud.asset_v1.types.AnalyzeIamPolicyResponse

analyze_iam_policy_longrunning(request: Optional[Union[google.cloud.asset_v1.types.asset_service.AnalyzeIamPolicyLongrunningRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

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 [AnalyzeIamPolicyResponse][google.cloud.asset.v1.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 metadata for the long-running operation.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import asset_v1

def sample_analyze_iam_policy_longrunning():
    # Create a client
    client = asset_v1.AssetServiceClient()

    # Initialize request argument(s)
    analysis_query = asset_v1.IamPolicyAnalysisQuery()
    analysis_query.scope = "scope_value"

    output_config = asset_v1.IamPolicyAnalysisOutputConfig()
    output_config.gcs_destination.uri = "uri_value"

    request = asset_v1.AnalyzeIamPolicyLongrunningRequest(
        analysis_query=analysis_query,
        output_config=output_config,
    )

    # Make the request
    operation = client.analyze_iam_policy_longrunning(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.asset_v1.types.AnalyzeIamPolicyLongrunningRequest, dict]) – The request object. A request message for [AssetService.AnalyzeIamPolicyLongrunning][google.cloud.asset.v1.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

An object representing a long-running operation.

The result type for the operation will be google.cloud.asset_v1.types.AnalyzeIamPolicyLongrunningResponse A response message for: [AssetService.AnalyzeIamPolicyLongrunning][google.cloud.asset.v1.AssetService.AnalyzeIamPolicyLongrunning].

Return type

google.api_core.operation.Operation

analyze_move(request: Optional[Union[google.cloud.asset_v1.types.asset_service.AnalyzeMoveRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.asset_v1.types.asset_service.AnalyzeMoveResponse[source]¶

Analyze moving a resource to a specified destination without kicking off the actual move. The analysis is best effort depending on the user’s permissions of viewing different hierarchical policies and configurations. The policies and configuration are subject to change before the actual resource migration takes place.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import asset_v1

def sample_analyze_move():
    # Create a client
    client = asset_v1.AssetServiceClient()

    # Initialize request argument(s)
    request = asset_v1.AnalyzeMoveRequest(
        resource="resource_value",
        destination_parent="destination_parent_value",
    )

    # Make the request
    response = client.analyze_move(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.asset_v1.types.AnalyzeMoveRequest, dict]) – The request object. The request message for performing resource move analysis.
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

The response message for resource move analysis.

Return type

google.cloud.asset_v1.types.AnalyzeMoveResponse

analyze_org_policies(request: Optional[Union[google.cloud.asset_v1.types.asset_service.AnalyzeOrgPoliciesRequest, dict]] = None, *, scope: Optional[str] = None, constraint: Optional[str] = None, filter: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.asset_v1.services.asset_service.pagers.AnalyzeOrgPoliciesPager[source]¶

Analyzes organization policies under a scope.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import asset_v1

def sample_analyze_org_policies():
    # Create a client
    client = asset_v1.AssetServiceClient()

    # Initialize request argument(s)
    request = asset_v1.AnalyzeOrgPoliciesRequest(
        scope="scope_value",
        constraint="constraint_value",
    )

    # Make the request
    page_result = client.analyze_org_policies(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.asset_v1.types.AnalyzeOrgPoliciesRequest, dict]) – The request object. A request message for [AssetService.AnalyzeOrgPolicies][google.cloud.asset.v1.AssetService.AnalyzeOrgPolicies].
scope (str) –
Required. The organization to scope the request. Only organization policies within the scope will be analyzed.
- 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.
constraint (str) –
Required. The name of the constraint to analyze organization policies for. The response only contains analyzed organization policies for the provided constraint.

This corresponds to the constraint field on the request instance; if request is provided, this should not be set.
filter (str) –
The expression to filter [AnalyzeOrgPoliciesResponse.org_policy_results][google.cloud.asset.v1.AnalyzeOrgPoliciesResponse.org_policy_results]. Filtering is currently available for bare literal values and the following fields:
- consolidated_policy.attached_resource
- consolidated_policy.rules.enforce
When filtering by a specific field, the only supported operator is =. For example, filtering by consolidated_policy.attached_resource=”//cloudresourcemanager.googleapis.com/folders/001” will return all the Organization Policy results attached to “folders/001”.

This corresponds to the filter 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

The response message for: [AssetService.AnalyzeOrgPolicies][google.cloud.asset.v1.AssetService.AnalyzeOrgPolicies].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.asset_v1.services.asset_service.pagers.AnalyzeOrgPoliciesPager

analyze_org_policy_governed_assets(request: Optional[Union[google.cloud.asset_v1.types.asset_service.AnalyzeOrgPolicyGovernedAssetsRequest, dict]] = None, *, scope: Optional[str] = None, constraint: Optional[str] = None, filter: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.asset_v1.services.asset_service.pagers.AnalyzeOrgPolicyGovernedAssetsPager[source]¶

Analyzes organization policies governed assets (Google Cloud resources or policies) under a scope. This RPC supports custom constraints and the following canned constraints:

constraints/ainotebooks.accessMode
constraints/ainotebooks.disableFileDownloads
constraints/ainotebooks.disableRootAccess
constraints/ainotebooks.disableTerminal
constraints/ainotebooks.environmentOptions
constraints/ainotebooks.requireAutoUpgradeSchedule
constraints/ainotebooks.restrictVpcNetworks
constraints/compute.disableGuestAttributesAccess
constraints/compute.disableInstanceDataAccessApis
constraints/compute.disableNestedVirtualization
constraints/compute.disableSerialPortAccess
constraints/compute.disableSerialPortLogging
constraints/compute.disableVpcExternalIpv6
constraints/compute.requireOsLogin
constraints/compute.requireShieldedVm
constraints/compute.restrictLoadBalancerCreationForTypes
constraints/compute.restrictProtocolForwardingCreationForTypes
constraints/compute.restrictXpnProjectLienRemoval
constraints/compute.setNewProjectDefaultToZonalDNSOnly
constraints/compute.skipDefaultNetworkCreation
constraints/compute.trustedImageProjects
constraints/compute.vmCanIpForward
constraints/compute.vmExternalIpAccess
constraints/gcp.detailedAuditLoggingMode
constraints/gcp.resourceLocations
constraints/iam.allowedPolicyMemberDomains
constraints/iam.automaticIamGrantsForDefaultServiceAccounts
constraints/iam.disableServiceAccountCreation
constraints/iam.disableServiceAccountKeyCreation
constraints/iam.disableServiceAccountKeyUpload
constraints/iam.restrictCrossProjectServiceAccountLienRemoval
constraints/iam.serviceAccountKeyExpiryHours
constraints/resourcemanager.accessBoundaries
constraints/resourcemanager.allowedExportDestinations
constraints/sql.restrictAuthorizedNetworks
constraints/sql.restrictNoncompliantDiagnosticDataAccess
constraints/sql.restrictNoncompliantResourceCreation
constraints/sql.restrictPublicIp
constraints/storage.publicAccessPrevention
constraints/storage.restrictAuthTypes
constraints/storage.uniformBucketLevelAccess

This RPC only returns either resources of types supported by search APIs or IAM policies.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import asset_v1

def sample_analyze_org_policy_governed_assets():
    # Create a client
    client = asset_v1.AssetServiceClient()

    # Initialize request argument(s)
    request = asset_v1.AnalyzeOrgPolicyGovernedAssetsRequest(
        scope="scope_value",
        constraint="constraint_value",
    )

    # Make the request
    page_result = client.analyze_org_policy_governed_assets(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.asset_v1.types.AnalyzeOrgPolicyGovernedAssetsRequest, dict]) – The request object. A request message for [AssetService.AnalyzeOrgPolicyGovernedAssets][google.cloud.asset.v1.AssetService.AnalyzeOrgPolicyGovernedAssets].
scope (str) –
Required. The organization to scope the request. Only organization policies within the scope will be analyzed. The output assets will also be limited to the ones governed by those in-scope organization policies.
- 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.
constraint (str) –
Required. The name of the constraint to analyze governed assets for. The analysis only contains analyzed organization policies for the provided constraint.

This corresponds to the constraint field on the request instance; if request is provided, this should not be set.
filter (str) –
The expression to filter [AnalyzeOrgPolicyGovernedAssetsResponse.governed_assets][google.cloud.asset.v1.AnalyzeOrgPolicyGovernedAssetsResponse.governed_assets].

For governed resources, filtering is currently available for bare literal values and the following fields:
- governed_resource.project
- governed_resource.folders
- consolidated_policy.rules.enforce When filtering by governed_resource.project or consolidated_policy.rules.enforce, the only supported operator is =. When filtering by governed_resource.folders, the supported operators are = and :. For example, filtering by governed_resource.project="projects/12345678" will return all the governed resources under “projects/12345678”, including the project itself if applicable.
For governed IAM policies, filtering is currently available for bare literal values and the following fields:
- governed_iam_policy.project
- governed_iam_policy.folders
- consolidated_policy.rules.enforce When filtering by governed_iam_policy.project or consolidated_policy.rules.enforce, the only supported operator is =. When filtering by governed_iam_policy.folders, the supported operators are = and :. For example, filtering by governed_iam_policy.folders:"folders/12345678" will return all the governed IAM policies under “folders/001”.
This corresponds to the filter 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

The response message for: [AssetService.AnalyzeOrgPolicyGovernedAssets][google.cloud.asset.v1.AssetService.AnalyzeOrgPolicyGovernedAssets].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.asset_v1.services.asset_service.pagers.AnalyzeOrgPolicyGovernedAssetsPager

analyze_org_policy_governed_containers(request: Optional[Union[google.cloud.asset_v1.types.asset_service.AnalyzeOrgPolicyGovernedContainersRequest, dict]] = None, *, scope: Optional[str] = None, constraint: Optional[str] = None, filter: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.asset_v1.services.asset_service.pagers.AnalyzeOrgPolicyGovernedContainersPager[source]¶

Analyzes organization policies governed containers (projects, folders or organization) under a scope.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import asset_v1

def sample_analyze_org_policy_governed_containers():
    # Create a client
    client = asset_v1.AssetServiceClient()

    # Initialize request argument(s)
    request = asset_v1.AnalyzeOrgPolicyGovernedContainersRequest(
        scope="scope_value",
        constraint="constraint_value",
    )

    # Make the request
    page_result = client.analyze_org_policy_governed_containers(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.asset_v1.types.AnalyzeOrgPolicyGovernedContainersRequest, dict]) – The request object. A request message for [AssetService.AnalyzeOrgPolicyGovernedContainers][google.cloud.asset.v1.AssetService.AnalyzeOrgPolicyGovernedContainers].
scope (str) –
Required. The organization to scope the request. Only organization policies within the scope will be analyzed. The output containers will also be limited to the ones governed by those in-scope organization policies.
- 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.
constraint (str) –
Required. The name of the constraint to analyze governed containers for. The analysis only contains organization policies for the provided constraint.

This corresponds to the constraint field on the request instance; if request is provided, this should not be set.
filter (str) –
The expression to filter [AnalyzeOrgPolicyGovernedContainersResponse.governed_containers][google.cloud.asset.v1.AnalyzeOrgPolicyGovernedContainersResponse.governed_containers]. Filtering is currently available for bare literal values and the following fields:
- parent
- consolidated_policy.rules.enforce
When filtering by a specific field, the only supported operator is =. For example, filtering by parent=”//cloudresourcemanager.googleapis.com/folders/001” will return all the containers under “folders/001”.

This corresponds to the filter 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

The response message for: [AssetService.AnalyzeOrgPolicyGovernedContainers][google.cloud.asset.v1.AssetService.AnalyzeOrgPolicyGovernedContainers].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.asset_v1.services.asset_service.pagers.AnalyzeOrgPolicyGovernedContainersPager

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

static asset_path() → str[source]¶: Returns a fully-qualified asset string.

batch_get_assets_history(request: Optional[Union[google.cloud.asset_v1.types.asset_service.BatchGetAssetsHistoryRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.asset_v1.types.asset_service.BatchGetAssetsHistoryResponse[source]¶

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import asset_v1

def sample_batch_get_assets_history():
    # Create a client
    client = asset_v1.AssetServiceClient()

    # Initialize request argument(s)
    request = asset_v1.BatchGetAssetsHistoryRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.batch_get_assets_history(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.asset_v1.types.BatchGetAssetsHistoryRequest, dict]) – 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

Batch get assets history response.

Return type

google.cloud.asset_v1.types.BatchGetAssetsHistoryResponse

batch_get_effective_iam_policies(request: Optional[Union[google.cloud.asset_v1.types.asset_service.BatchGetEffectiveIamPoliciesRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.asset_v1.types.asset_service.BatchGetEffectiveIamPoliciesResponse[source]¶

Gets effective IAM policies for a batch of resources.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import asset_v1

def sample_batch_get_effective_iam_policies():
    # Create a client
    client = asset_v1.AssetServiceClient()

    # Initialize request argument(s)
    request = asset_v1.BatchGetEffectiveIamPoliciesRequest(
        scope="scope_value",
        names=['names_value1', 'names_value2'],
    )

    # Make the request
    response = client.batch_get_effective_iam_policies(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.asset_v1.types.BatchGetEffectiveIamPoliciesRequest, dict]) – The request object. A request message for [AssetService.BatchGetEffectiveIamPolicies][google.cloud.asset.v1.AssetService.BatchGetEffectiveIamPolicies].
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

A response message for: [AssetService.BatchGetEffectiveIamPolicies][google.cloud.asset.v1.AssetService.BatchGetEffectiveIamPolicies].

Return type

google.cloud.asset_v1.types.BatchGetEffectiveIamPoliciesResponse

static common_billing_account_path(billing_account: str) → str[source]¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str[source]¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str[source]¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str[source]¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str[source]¶: Returns a fully-qualified project string.

create_feed(request: Optional[Union[google.cloud.asset_v1.types.asset_service.CreateFeedRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.asset_v1.types.asset_service.Feed[source]¶

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import asset_v1

def sample_create_feed():
    # Create a client
    client = asset_v1.AssetServiceClient()

    # Initialize request argument(s)
    feed = asset_v1.Feed()
    feed.name = "name_value"

    request = asset_v1.CreateFeedRequest(
        parent="parent_value",
        feed_id="feed_id_value",
        feed=feed,
    )

    # Make the request
    response = client.create_feed(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.asset_v1.types.CreateFeedRequest, dict]) – 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

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.

Return type

google.cloud.asset_v1.types.Feed

create_saved_query(request: Optional[Union[google.cloud.asset_v1.types.asset_service.CreateSavedQueryRequest, dict]] = None, *, parent: Optional[str] = None, saved_query: Optional[google.cloud.asset_v1.types.asset_service.SavedQuery] = None, saved_query_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.asset_v1.types.asset_service.SavedQuery[source]¶

Creates a saved query in a parent project/folder/organization.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import asset_v1

def sample_create_saved_query():
    # Create a client
    client = asset_v1.AssetServiceClient()

    # Initialize request argument(s)
    request = asset_v1.CreateSavedQueryRequest(
        parent="parent_value",
        saved_query_id="saved_query_id_value",
    )

    # Make the request
    response = client.create_saved_query(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.asset_v1.types.CreateSavedQueryRequest, dict]) – The request object. Request to create a saved query.
parent (str) –
Required. The name of the project/folder/organization where this saved_query 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.
saved_query (google.cloud.asset_v1.types.SavedQuery) –
Required. The saved_query details. The name field must be empty as it will be generated based on the parent and saved_query_id.

This corresponds to the saved_query field on the request instance; if request is provided, this should not be set.
saved_query_id (str) –
Required. The ID to use for the saved query, which must be unique in the specified parent. It will become the final component of the saved query’s resource name.

This value should be 4-63 characters, and valid characters are [a-z][0-9]-.

Notice that this field is required in the saved query creation, and the name field of the saved_query will be ignored.

This corresponds to the saved_query_id 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

A saved query which can be shared with others or used later.

Return type

google.cloud.asset_v1.types.SavedQuery

delete_feed(request: Optional[Union[google.cloud.asset_v1.types.asset_service.DeleteFeedRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

Deletes an asset feed.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import asset_v1

def sample_delete_feed():
    # Create a client
    client = asset_v1.AssetServiceClient()

    # Initialize request argument(s)
    request = asset_v1.DeleteFeedRequest(
        name="name_value",
    )

    # Make the request
    client.delete_feed(request=request)

Parameters

request (Union[google.cloud.asset_v1.types.DeleteFeedRequest, dict]) – 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.

delete_saved_query(request: Optional[Union[google.cloud.asset_v1.types.asset_service.DeleteSavedQueryRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

Deletes a saved query.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import asset_v1

def sample_delete_saved_query():
    # Create a client
    client = asset_v1.AssetServiceClient()

    # Initialize request argument(s)
    request = asset_v1.DeleteSavedQueryRequest(
        name="name_value",
    )

    # Make the request
    client.delete_saved_query(request=request)

Parameters

request (Union[google.cloud.asset_v1.types.DeleteSavedQueryRequest, dict]) – The request object. Request to delete a saved query.
name (str) –
Required. The name of the saved query to delete. It must be in the format of:
- projects/project_number/savedQueries/saved_query_id
- folders/folder_number/savedQueries/saved_query_id
- organizations/organization_number/savedQueries/saved_query_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(request: Optional[Union[google.cloud.asset_v1.types.asset_service.ExportAssetsRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

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 [google.cloud.asset.v1.Asset][google.cloud.asset.v1.Asset] in the JSON format; for BigQuery table destinations, the output table stores the fields in asset Protobuf 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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import asset_v1

def sample_export_assets():
    # Create a client
    client = asset_v1.AssetServiceClient()

    # Initialize request argument(s)
    output_config = asset_v1.OutputConfig()
    output_config.gcs_destination.uri = "uri_value"

    request = asset_v1.ExportAssetsRequest(
        parent="parent_value",
        output_config=output_config,
    )

    # Make the request
    operation = client.export_assets(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.asset_v1.types.ExportAssetsRequest, dict]) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.asset_v1.types.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.

Return type

google.api_core.operation.Operation

static feed_path(project: str, feed: str) → str[source]¶: Returns a fully-qualified feed string.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

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

Parameters

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

The constructed client.

Return type

AssetServiceClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

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

Parameters

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

The constructed client.

Return type

AssetServiceClient

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

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

Parameters

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

The constructed client.

Return type

AssetServiceClient

get_feed(request: Optional[Union[google.cloud.asset_v1.types.asset_service.GetFeedRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.asset_v1.types.asset_service.Feed[source]¶

Gets details about an asset feed.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import asset_v1

def sample_get_feed():
    # Create a client
    client = asset_v1.AssetServiceClient()

    # Initialize request argument(s)
    request = asset_v1.GetFeedRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_feed(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.asset_v1.types.GetFeedRequest, dict]) – 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

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.

Return type

google.cloud.asset_v1.types.Feed

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

Deprecated. Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not “true”, the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “always”, use the default mTLS endpoint; if the environment variable is “never”, use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.Operation[source]¶

Gets the latest state of a long-running operation.

Parameters

request (GetOperationRequest) – The request object. Request message for GetOperation method.
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

An Operation object.

Return type

Operation

get_saved_query(request: Optional[Union[google.cloud.asset_v1.types.asset_service.GetSavedQueryRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.asset_v1.types.asset_service.SavedQuery[source]¶

Gets details about a saved query.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import asset_v1

def sample_get_saved_query():
    # Create a client
    client = asset_v1.AssetServiceClient()

    # Initialize request argument(s)
    request = asset_v1.GetSavedQueryRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_saved_query(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.asset_v1.types.GetSavedQueryRequest, dict]) – The request object. Request to get a saved query.
name (str) –
Required. The name of the saved query and it must be in the format of:
- projects/project_number/savedQueries/saved_query_id
- folders/folder_number/savedQueries/saved_query_id
- organizations/organization_number/savedQueries/saved_query_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

A saved query which can be shared with others or used later.

Return type

google.cloud.asset_v1.types.SavedQuery

static inventory_path(project: str, location: str, instance: str) → str[source]¶: Returns a fully-qualified inventory string.

list_assets(request: Optional[Union[google.cloud.asset_v1.types.asset_service.ListAssetsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.asset_v1.services.asset_service.pagers.ListAssetsPager[source]¶

Lists assets with time and resource types and returns paged results in response.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import asset_v1

def sample_list_assets():
    # Create a client
    client = asset_v1.AssetServiceClient()

    # Initialize request argument(s)
    request = asset_v1.ListAssetsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_assets(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.asset_v1.types.ListAssetsRequest, dict]) – The request object. ListAssets request.
parent (str) –
Required. Name of the organization, folder, or project the assets belong to. Format: “organizations/[organization-number]” (such as “organizations/123”), “projects/[project-id]” (such as “projects/my-project-id”), “projects/[project-number]” (such as “projects/12345”), or “folders/[folder-number]” (such as “folders/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

ListAssets response.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.asset_v1.services.asset_service.pagers.ListAssetsPager

list_feeds(request: Optional[Union[google.cloud.asset_v1.types.asset_service.ListFeedsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.asset_v1.types.asset_service.ListFeedsResponse[source]¶

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import asset_v1

def sample_list_feeds():
    # Create a client
    client = asset_v1.AssetServiceClient()

    # Initialize request argument(s)
    request = asset_v1.ListFeedsRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.list_feeds(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.asset_v1.types.ListFeedsRequest, dict]) – 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.

Return type

google.cloud.asset_v1.types.ListFeedsResponse

list_saved_queries(request: Optional[Union[google.cloud.asset_v1.types.asset_service.ListSavedQueriesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.asset_v1.services.asset_service.pagers.ListSavedQueriesPager[source]¶

Lists all saved queries in a parent project/folder/organization.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import asset_v1

def sample_list_saved_queries():
    # Create a client
    client = asset_v1.AssetServiceClient()

    # Initialize request argument(s)
    request = asset_v1.ListSavedQueriesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_saved_queries(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.asset_v1.types.ListSavedQueriesRequest, dict]) – The request object. Request to list saved queries.
parent (str) –
Required. The parent project/folder/organization whose savedQueries 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.

Returns

Response of listing saved queries.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.asset_v1.services.asset_service.pagers.ListSavedQueriesPager

static parse_access_level_path(path: str) → Dict[str, str][source]¶: Parses a access_level path into its component segments.

static parse_access_policy_path(path: str) → Dict[str, str][source]¶: Parses a access_policy path into its component segments.

static parse_asset_path(path: str) → Dict[str, str][source]¶: Parses a asset path into its component segments.

static parse_common_billing_account_path(path: str) → Dict[str, str][source]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str][source]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str][source]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str][source]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str][source]¶: Parse a project path into its component segments.

static parse_feed_path(path: str) → Dict[str, str][source]¶: Parses a feed path into its component segments.

static parse_inventory_path(path: str) → Dict[str, str][source]¶: Parses a inventory path into its component segments.

static parse_saved_query_path(path: str) → Dict[str, str][source]¶: Parses a saved_query path into its component segments.

static parse_service_perimeter_path(path: str) → Dict[str, str][source]¶: Parses a service_perimeter path into its component segments.

query_assets(request: Optional[Union[google.cloud.asset_v1.types.asset_service.QueryAssetsRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.asset_v1.types.asset_service.QueryAssetsResponse[source]¶

Issue a job that queries assets using a SQL statement compatible with BigQuery SQL.

If the query execution finishes within timeout and there’s no pagination, the full query results will be returned in the QueryAssetsResponse.

Otherwise, full query results can be obtained by issuing extra requests with the job_reference from the a previous QueryAssets call.

Note, the query result has approximately 10 GB limitation enforced by BigQuery. Queries return larger results will result in errors.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import asset_v1

def sample_query_assets():
    # Create a client
    client = asset_v1.AssetServiceClient()

    # Initialize request argument(s)
    request = asset_v1.QueryAssetsRequest(
        statement="statement_value",
        parent="parent_value",
    )

    # Make the request
    response = client.query_assets(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.asset_v1.types.QueryAssetsRequest, dict]) – The request object. QueryAssets 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

QueryAssets response.

Return type

google.cloud.asset_v1.types.QueryAssetsResponse

static saved_query_path(project: str, saved_query: str) → str[source]¶: Returns a fully-qualified saved_query string.

search_all_iam_policies(request: Optional[Union[google.cloud.asset_v1.types.asset_service.SearchAllIamPoliciesRequest, dict]] = None, *, scope: Optional[str] = None, query: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.asset_v1.services.asset_service.pagers.SearchAllIamPoliciesPager[source]¶

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import asset_v1

def sample_search_all_iam_policies():
    # Create a client
    client = asset_v1.AssetServiceClient()

    # Initialize request argument(s)
    request = asset_v1.SearchAllIamPoliciesRequest(
        scope="scope_value",
    )

    # Make the request
    page_result = client.search_all_iam_policies(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.asset_v1.types.SearchAllIamPoliciesRequest, dict]) – 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 <https://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 for more information. If not specified or empty, it will search all the IAM policies within the specified scope. Note that the query string is compared against each IAM policy binding, including its principals, roles, and IAM conditions. The returned IAM policies will only contain the bindings that match your query. To learn more about the IAM policy structure, see the IAM policy documentation.

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:comp* to find IAM policy bindings that contain “comp” as a prefix of any word in the binding.
- 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.
- policy.role.permissions:upd* to find IAM policy bindings that specify a role containing “upd” as a prefix of any word in the role 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”.
- resource=//cloudresourcemanager.googleapis.com/projects/myproject to find IAM policy bindings that are set on the project named “myproject”.
- Important to find IAM policy bindings that contain “Important” as a word 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”.
- roles:roles/compute.admin to find IAM policy bindings that specify the Compute Admin role.
- memberTypes:user to find IAM policy bindings that contain the principal type “user”.
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

Search all IAM policies response.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.asset_v1.services.asset_service.pagers.SearchAllIamPoliciesPager

search_all_resources(request: Optional[Union[google.cloud.asset_v1.types.asset_service.SearchAllResourcesRequest, dict]] = None, *, scope: Optional[str] = None, query: Optional[str] = None, asset_types: Optional[MutableSequence[str]] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.asset_v1.services.asset_service.pagers.SearchAllResourcesPager[source]¶

Searches all Google 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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import asset_v1

def sample_search_all_resources():
    # Create a client
    client = asset_v1.AssetServiceClient()

    # Initialize request argument(s)
    request = asset_v1.SearchAllResourcesRequest(
        scope="scope_value",
    )

    # Make the request
    page_result = client.search_all_resources(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.asset_v1.types.SearchAllResourcesRequest, dict]) – 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 <https://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 for more information. If not specified or empty, it will search all the resources within the specified scope.

Examples:
- name:Important to find Google Cloud resources whose name contains Important as a word.
- name=Important to find the Google Cloud resource whose name is exactly Important.
- displayName:Impor* to find Google Cloud resources whose display name contains Impor as a prefix of any word in the field.
- location:us-west* to find Google Cloud resources whose location contains both us and west as prefixes.
- labels:prod to find Google Cloud resources whose labels contain prod as a key or value.
- labels.env:prod to find Google Cloud resources that have a label env and its value is prod.
- labels.env:* to find Google Cloud resources that have a label env.
- tagKeys:env to find Google Cloud resources that have directly attached tags where the `TagKey.namespacedName <https://cloud.google.com/resource-manager/reference/rest/v3/tagKeys#resource:-tagkey>`__ contains env.
- tagValues:prod* to find Google Cloud resources that have directly attached tags where the `TagValue.namespacedName <https://cloud.google.com/resource-manager/reference/rest/v3/tagValues#resource:-tagvalue>`__ contains a word prefixed by prod.
- tagValueIds=tagValues/123 to find Google Cloud resources that have directly attached tags where the `TagValue.name <https://cloud.google.com/resource-manager/reference/rest/v3/tagValues#resource:-tagvalue>`__ is exactly tagValues/123.
- effectiveTagKeys:env to find Google Cloud resources that have directly attached or inherited tags where the `TagKey.namespacedName <https://cloud.google.com/resource-manager/reference/rest/v3/tagKeys#resource:-tagkey>`__ contains env.
- effectiveTagValues:prod* to find Google Cloud resources that have directly attached or inherited tags where the `TagValue.namespacedName <https://cloud.google.com/resource-manager/reference/rest/v3/tagValues#resource:-tagvalue>`__ contains a word prefixed by prod.
- effectiveTagValueIds=tagValues/123 to find Google Cloud resources that have directly attached or inherited tags where the `TagValue.name <https://cloud.google.com/resource-manager/reference/rest/v3/tagValues#resource:-tagvalue>`__ is exactly tagValues/123.
- kmsKey:key to find Google Cloud resources encrypted with a customer-managed encryption key whose name contains key as a word. This field is deprecated. Use the kmsKeys field to retrieve Cloud KMS key information.
- kmsKeys:key to find Google Cloud resources encrypted with customer-managed encryption keys whose name contains the word key.
- relationships:instance-group-1 to find Google Cloud resources that have relationships with instance-group-1 in the related resource name.
- relationships:INSTANCE_TO_INSTANCEGROUP to find Compute Engine instances that have relationships of type INSTANCE_TO_INSTANCEGROUP.
- relationships.INSTANCE_TO_INSTANCEGROUP:instance-group-1 to find Compute Engine instances that have relationships with instance-group-1 in the Compute Engine instance group resource name, for relationship type INSTANCE_TO_INSTANCEGROUP.
- sccSecurityMarks.key=value to find Cloud resources that are attached with security marks whose key is key and value is value.
- sccSecurityMarks.key:* to find Cloud resources that are attached with security marks whose key is key.
- state:ACTIVE to find Google Cloud resources whose state contains ACTIVE as a word.
- NOT state:ACTIVE to find Google Cloud resources whose state doesn’t contain ACTIVE as a word.
- createTime<1609459200 to find Google Cloud resources that were created before 2021-01-01 00:00:00 UTC. 1609459200 is the epoch timestamp of 2021-01-01 00:00:00 UTC in seconds.
- updateTime>1609459200 to find Google Cloud resources that were updated after 2021-01-01 00:00:00 UTC. 1609459200 is the epoch timestamp of 2021-01-01 00:00:00 UTC in seconds.
- Important to find Google Cloud resources that contain Important as a word in any of the searchable fields.
- Impor* to find Google Cloud resources that contain Impor as a prefix of any word in any of the searchable fields.
- Important location:(us-west1 OR global) to find Google 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 (MutableSequence[str]) –
Optional. A list of asset types that this request searches for. If empty, it will search all the asset types supported by search APIs.

Regular expressions are also supported. For example:
- ”compute.googleapis.com.*” snapshots resources whose asset type starts with “compute.googleapis.com”.
- ”.*Instance” snapshots resources whose asset type ends with “Instance”.
- ”.*Instance.*” snapshots resources whose asset type contains “Instance”.
See RE2 for all supported regular expression syntax. If the regular expression does not match any supported asset type, an INVALID_ARGUMENT error will be returned.

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

Search all resources response.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.asset_v1.services.asset_service.pagers.SearchAllResourcesPager

static service_perimeter_path(access_policy: str, service_perimeter: str) → str[source]¶: Returns a fully-qualified service_perimeter string.

property transport: google.cloud.asset_v1.services.asset_service.transports.base.AssetServiceTransport¶

Returns the transport used by the client instance.

Returns

The transport used by the client: instance.

Return type

AssetServiceTransport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns: The universe domain used by the client instance.
Return type: str

update_feed(request: Optional[Union[google.cloud.asset_v1.types.asset_service.UpdateFeedRequest, dict]] = None, *, feed: Optional[google.cloud.asset_v1.types.asset_service.Feed] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.asset_v1.types.asset_service.Feed[source]¶

Updates an asset feed configuration.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import asset_v1

def sample_update_feed():
    # Create a client
    client = asset_v1.AssetServiceClient()

    # Initialize request argument(s)
    feed = asset_v1.Feed()
    feed.name = "name_value"

    request = asset_v1.UpdateFeedRequest(
        feed=feed,
    )

    # Make the request
    response = client.update_feed(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.asset_v1.types.UpdateFeedRequest, dict]) – The request object. Update asset feed request.
feed (google.cloud.asset_v1.types.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

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.

Return type

google.cloud.asset_v1.types.Feed

update_saved_query(request: Optional[Union[google.cloud.asset_v1.types.asset_service.UpdateSavedQueryRequest, dict]] = None, *, saved_query: Optional[google.cloud.asset_v1.types.asset_service.SavedQuery] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.asset_v1.types.asset_service.SavedQuery[source]¶

Updates a saved query.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import asset_v1

def sample_update_saved_query():
    # Create a client
    client = asset_v1.AssetServiceClient()

    # Initialize request argument(s)
    request = asset_v1.UpdateSavedQueryRequest(
    )

    # Make the request
    response = client.update_saved_query(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.asset_v1.types.UpdateSavedQueryRequest, dict]) – The request object. Request to update a saved query.
saved_query (google.cloud.asset_v1.types.SavedQuery) –
Required. The saved query to update.

The saved query’s name field is used to identify the one to update, which has format as below:
- projects/project_number/savedQueries/saved_query_id
- folders/folder_number/savedQueries/saved_query_id
- organizations/organization_number/savedQueries/saved_query_id
This corresponds to the saved_query field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Required. The list of fields to update.

This corresponds to the update_mask 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

A saved query which can be shared with others or used later.

Return type

google.cloud.asset_v1.types.SavedQuery

class google.cloud.asset_v1.services.asset_service.pagers.AnalyzeOrgPoliciesAsyncPager(method: Callable[[...], Awaitable[google.cloud.asset_v1.types.asset_service.AnalyzeOrgPoliciesResponse]], request: google.cloud.asset_v1.types.asset_service.AnalyzeOrgPoliciesRequest, response: google.cloud.asset_v1.types.asset_service.AnalyzeOrgPoliciesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through analyze_org_policies requests.

This class thinly wraps an initial google.cloud.asset_v1.types.AnalyzeOrgPoliciesResponse object, and provides an __aiter__ method to iterate through its org_policy_results field.

If there are more pages, the __aiter__ method will make additional AnalyzeOrgPolicies requests and continue to iterate through the org_policy_results field on the corresponding responses.

All the usual google.cloud.asset_v1.types.AnalyzeOrgPoliciesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.asset_v1.types.AnalyzeOrgPoliciesRequest) – The initial request object.
response (google.cloud.asset_v1.types.AnalyzeOrgPoliciesResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.asset_v1.services.asset_service.pagers.AnalyzeOrgPoliciesPager(method: Callable[[...], google.cloud.asset_v1.types.asset_service.AnalyzeOrgPoliciesResponse], request: google.cloud.asset_v1.types.asset_service.AnalyzeOrgPoliciesRequest, response: google.cloud.asset_v1.types.asset_service.AnalyzeOrgPoliciesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through analyze_org_policies requests.

This class thinly wraps an initial google.cloud.asset_v1.types.AnalyzeOrgPoliciesResponse object, and provides an __iter__ method to iterate through its org_policy_results field.

If there are more pages, the __iter__ method will make additional AnalyzeOrgPolicies requests and continue to iterate through the org_policy_results field on the corresponding responses.

All the usual google.cloud.asset_v1.types.AnalyzeOrgPoliciesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.asset_v1.types.AnalyzeOrgPoliciesRequest) – The initial request object.
response (google.cloud.asset_v1.types.AnalyzeOrgPoliciesResponse) – The initial response object.
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.

class google.cloud.asset_v1.services.asset_service.pagers.AnalyzeOrgPolicyGovernedAssetsAsyncPager(method: Callable[[...], Awaitable[google.cloud.asset_v1.types.asset_service.AnalyzeOrgPolicyGovernedAssetsResponse]], request: google.cloud.asset_v1.types.asset_service.AnalyzeOrgPolicyGovernedAssetsRequest, response: google.cloud.asset_v1.types.asset_service.AnalyzeOrgPolicyGovernedAssetsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through analyze_org_policy_governed_assets requests.

This class thinly wraps an initial google.cloud.asset_v1.types.AnalyzeOrgPolicyGovernedAssetsResponse object, and provides an __aiter__ method to iterate through its governed_assets field.

If there are more pages, the __aiter__ method will make additional AnalyzeOrgPolicyGovernedAssets requests and continue to iterate through the governed_assets field on the corresponding responses.

All the usual google.cloud.asset_v1.types.AnalyzeOrgPolicyGovernedAssetsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.asset_v1.types.AnalyzeOrgPolicyGovernedAssetsRequest) – The initial request object.
response (google.cloud.asset_v1.types.AnalyzeOrgPolicyGovernedAssetsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.asset_v1.services.asset_service.pagers.AnalyzeOrgPolicyGovernedAssetsPager(method: Callable[[...], google.cloud.asset_v1.types.asset_service.AnalyzeOrgPolicyGovernedAssetsResponse], request: google.cloud.asset_v1.types.asset_service.AnalyzeOrgPolicyGovernedAssetsRequest, response: google.cloud.asset_v1.types.asset_service.AnalyzeOrgPolicyGovernedAssetsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through analyze_org_policy_governed_assets requests.

This class thinly wraps an initial google.cloud.asset_v1.types.AnalyzeOrgPolicyGovernedAssetsResponse object, and provides an __iter__ method to iterate through its governed_assets field.

If there are more pages, the __iter__ method will make additional AnalyzeOrgPolicyGovernedAssets requests and continue to iterate through the governed_assets field on the corresponding responses.

All the usual google.cloud.asset_v1.types.AnalyzeOrgPolicyGovernedAssetsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.asset_v1.types.AnalyzeOrgPolicyGovernedAssetsRequest) – The initial request object.
response (google.cloud.asset_v1.types.AnalyzeOrgPolicyGovernedAssetsResponse) – The initial response object.
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.

class google.cloud.asset_v1.services.asset_service.pagers.AnalyzeOrgPolicyGovernedContainersAsyncPager(method: Callable[[...], Awaitable[google.cloud.asset_v1.types.asset_service.AnalyzeOrgPolicyGovernedContainersResponse]], request: google.cloud.asset_v1.types.asset_service.AnalyzeOrgPolicyGovernedContainersRequest, response: google.cloud.asset_v1.types.asset_service.AnalyzeOrgPolicyGovernedContainersResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through analyze_org_policy_governed_containers requests.

This class thinly wraps an initial google.cloud.asset_v1.types.AnalyzeOrgPolicyGovernedContainersResponse object, and provides an __aiter__ method to iterate through its governed_containers field.

If there are more pages, the __aiter__ method will make additional AnalyzeOrgPolicyGovernedContainers requests and continue to iterate through the governed_containers field on the corresponding responses.

All the usual google.cloud.asset_v1.types.AnalyzeOrgPolicyGovernedContainersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.asset_v1.types.AnalyzeOrgPolicyGovernedContainersRequest) – The initial request object.
response (google.cloud.asset_v1.types.AnalyzeOrgPolicyGovernedContainersResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.asset_v1.services.asset_service.pagers.AnalyzeOrgPolicyGovernedContainersPager(method: Callable[[...], google.cloud.asset_v1.types.asset_service.AnalyzeOrgPolicyGovernedContainersResponse], request: google.cloud.asset_v1.types.asset_service.AnalyzeOrgPolicyGovernedContainersRequest, response: google.cloud.asset_v1.types.asset_service.AnalyzeOrgPolicyGovernedContainersResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through analyze_org_policy_governed_containers requests.

This class thinly wraps an initial google.cloud.asset_v1.types.AnalyzeOrgPolicyGovernedContainersResponse object, and provides an __iter__ method to iterate through its governed_containers field.

If there are more pages, the __iter__ method will make additional AnalyzeOrgPolicyGovernedContainers requests and continue to iterate through the governed_containers field on the corresponding responses.

All the usual google.cloud.asset_v1.types.AnalyzeOrgPolicyGovernedContainersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.asset_v1.types.AnalyzeOrgPolicyGovernedContainersRequest) – The initial request object.
response (google.cloud.asset_v1.types.AnalyzeOrgPolicyGovernedContainersResponse) – The initial response object.
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.

class google.cloud.asset_v1.services.asset_service.pagers.ListAssetsAsyncPager(method: Callable[[...], Awaitable[google.cloud.asset_v1.types.asset_service.ListAssetsResponse]], request: google.cloud.asset_v1.types.asset_service.ListAssetsRequest, response: google.cloud.asset_v1.types.asset_service.ListAssetsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_assets requests.

This class thinly wraps an initial google.cloud.asset_v1.types.ListAssetsResponse object, and provides an __aiter__ method to iterate through its assets field.

If there are more pages, the __aiter__ method will make additional ListAssets requests and continue to iterate through the assets field on the corresponding responses.

All the usual google.cloud.asset_v1.types.ListAssetsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.asset_v1.types.ListAssetsRequest) – The initial request object.
response (google.cloud.asset_v1.types.ListAssetsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.asset_v1.services.asset_service.pagers.ListAssetsPager(method: Callable[[...], google.cloud.asset_v1.types.asset_service.ListAssetsResponse], request: google.cloud.asset_v1.types.asset_service.ListAssetsRequest, response: google.cloud.asset_v1.types.asset_service.ListAssetsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_assets requests.

This class thinly wraps an initial google.cloud.asset_v1.types.ListAssetsResponse object, and provides an __iter__ method to iterate through its assets field.

If there are more pages, the __iter__ method will make additional ListAssets requests and continue to iterate through the assets field on the corresponding responses.

All the usual google.cloud.asset_v1.types.ListAssetsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.asset_v1.types.ListAssetsRequest) – The initial request object.
response (google.cloud.asset_v1.types.ListAssetsResponse) – The initial response object.
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.

class google.cloud.asset_v1.services.asset_service.pagers.ListSavedQueriesAsyncPager(method: Callable[[...], Awaitable[google.cloud.asset_v1.types.asset_service.ListSavedQueriesResponse]], request: google.cloud.asset_v1.types.asset_service.ListSavedQueriesRequest, response: google.cloud.asset_v1.types.asset_service.ListSavedQueriesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_saved_queries requests.

This class thinly wraps an initial google.cloud.asset_v1.types.ListSavedQueriesResponse object, and provides an __aiter__ method to iterate through its saved_queries field.

If there are more pages, the __aiter__ method will make additional ListSavedQueries requests and continue to iterate through the saved_queries field on the corresponding responses.

All the usual google.cloud.asset_v1.types.ListSavedQueriesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.asset_v1.types.ListSavedQueriesRequest) – The initial request object.
response (google.cloud.asset_v1.types.ListSavedQueriesResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.asset_v1.services.asset_service.pagers.ListSavedQueriesPager(method: Callable[[...], google.cloud.asset_v1.types.asset_service.ListSavedQueriesResponse], request: google.cloud.asset_v1.types.asset_service.ListSavedQueriesRequest, response: google.cloud.asset_v1.types.asset_service.ListSavedQueriesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_saved_queries requests.

This class thinly wraps an initial google.cloud.asset_v1.types.ListSavedQueriesResponse object, and provides an __iter__ method to iterate through its saved_queries field.

If there are more pages, the __iter__ method will make additional ListSavedQueries requests and continue to iterate through the saved_queries field on the corresponding responses.

All the usual google.cloud.asset_v1.types.ListSavedQueriesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.asset_v1.types.ListSavedQueriesRequest) – The initial request object.
response (google.cloud.asset_v1.types.ListSavedQueriesResponse) – The initial response object.
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.

class google.cloud.asset_v1.services.asset_service.pagers.SearchAllIamPoliciesAsyncPager(method: Callable[[...], Awaitable[google.cloud.asset_v1.types.asset_service.SearchAllIamPoliciesResponse]], request: google.cloud.asset_v1.types.asset_service.SearchAllIamPoliciesRequest, response: google.cloud.asset_v1.types.asset_service.SearchAllIamPoliciesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through search_all_iam_policies requests.

This class thinly wraps an initial google.cloud.asset_v1.types.SearchAllIamPoliciesResponse object, and provides an __aiter__ method to iterate through its results field.

If there are more pages, the __aiter__ method will make additional SearchAllIamPolicies requests and continue to iterate through the results field on the corresponding responses.

All the usual google.cloud.asset_v1.types.SearchAllIamPoliciesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

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.
retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.asset_v1.services.asset_service.pagers.SearchAllIamPoliciesPager(method: Callable[[...], google.cloud.asset_v1.types.asset_service.SearchAllIamPoliciesResponse], request: google.cloud.asset_v1.types.asset_service.SearchAllIamPoliciesRequest, response: google.cloud.asset_v1.types.asset_service.SearchAllIamPoliciesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through search_all_iam_policies requests.

This class thinly wraps an initial google.cloud.asset_v1.types.SearchAllIamPoliciesResponse object, and provides an __iter__ method to iterate through its results field.

If there are more pages, the __iter__ method will make additional SearchAllIamPolicies requests and continue to iterate through the results field on the corresponding responses.

All the usual google.cloud.asset_v1.types.SearchAllIamPoliciesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

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

class google.cloud.asset_v1.services.asset_service.pagers.SearchAllResourcesAsyncPager(method: Callable[[...], Awaitable[google.cloud.asset_v1.types.asset_service.SearchAllResourcesResponse]], request: google.cloud.asset_v1.types.asset_service.SearchAllResourcesRequest, response: google.cloud.asset_v1.types.asset_service.SearchAllResourcesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through search_all_resources requests.

This class thinly wraps an initial google.cloud.asset_v1.types.SearchAllResourcesResponse object, and provides an __aiter__ method to iterate through its results field.

If there are more pages, the __aiter__ method will make additional SearchAllResources requests and continue to iterate through the results field on the corresponding responses.

All the usual google.cloud.asset_v1.types.SearchAllResourcesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.asset_v1.types.SearchAllResourcesRequest) – The initial request object.
response (google.cloud.asset_v1.types.SearchAllResourcesResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.asset_v1.services.asset_service.pagers.SearchAllResourcesPager(method: Callable[[...], google.cloud.asset_v1.types.asset_service.SearchAllResourcesResponse], request: google.cloud.asset_v1.types.asset_service.SearchAllResourcesRequest, response: google.cloud.asset_v1.types.asset_service.SearchAllResourcesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through search_all_resources requests.

This class thinly wraps an initial google.cloud.asset_v1.types.SearchAllResourcesResponse object, and provides an __iter__ method to iterate through its results field.

If there are more pages, the __iter__ method will make additional SearchAllResources requests and continue to iterate through the results field on the corresponding responses.

All the usual google.cloud.asset_v1.types.SearchAllResourcesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.asset_v1.types.SearchAllResourcesRequest) – The initial request object.
response (google.cloud.asset_v1.types.SearchAllResourcesResponse) – The initial response object.
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.

AssetService¶

google-cloud-asset

Navigation

Related Topics