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_v1p4beta1.services.asset_service.AssetServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.asset_v1p4beta1.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 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 (Union[str, AssetServiceTransport]) – The transport to use. If set to None, a transport is chosen automatically.

  • client_options (ClientOptions) – Custom options for the client. It won’t take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

Raises

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

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

Analyzes IAM policies based on the specified request. Returns a list of [IamPolicyAnalysisResult][google.cloud.asset.v1p4beta1.IamPolicyAnalysisResult] matching the request.

from google.cloud import asset_v1p4beta1

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

    # Initialize request argument(s)
    analysis_query = asset_v1p4beta1.IamPolicyAnalysisQuery()
    analysis_query.parent = "parent_value"

    request = asset_v1p4beta1.AnalyzeIamPolicyRequest(
        analysis_query=analysis_query,
    )

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

    # Handle the response
    print(response)
Parameters
Returns

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

Return type

google.cloud.asset_v1p4beta1.types.AnalyzeIamPolicyResponse

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 export_iam_policy_analysis(request: Optional[Union[google.cloud.asset_v1p4beta1.types.asset_service.ExportIamPolicyAnalysisRequest, dict]] = None, *, retry: Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]

Exports IAM policy analysis based on the specified request. This API implements the [google.longrunning.Operation][google.longrunning.Operation] API allowing you to keep track of the export. The metadata contains the request to help callers to map responses to requests.

from google.cloud import asset_v1p4beta1

async def sample_export_iam_policy_analysis():
    # Create a client
    client = asset_v1p4beta1.AssetServiceAsyncClient()

    # Initialize request argument(s)
    analysis_query = asset_v1p4beta1.IamPolicyAnalysisQuery()
    analysis_query.parent = "parent_value"

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

    request = asset_v1p4beta1.ExportIamPolicyAnalysisRequest(
        analysis_query=analysis_query,
        output_config=output_config,
    )

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

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

    response = await operation.result()

    # Handle the response
    print(response)
Parameters
Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.asset_v1p4beta1.types.ExportIamPolicyAnalysisResponse The export IAM policy analysis response. This message is returned by the

[google.longrunning.Operations.GetOperation][] method in the returned [google.longrunning.Operation.response][] field.

Return type

google.api_core.operation_async.AsyncOperation

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

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 variabel 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_transport_class() → Type[google.cloud.asset_v1p4beta1.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 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.

property transport: google.cloud.asset_v1p4beta1.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

class google.cloud.asset_v1p4beta1.services.asset_service.AssetServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.asset_v1p4beta1.services.asset_service.transports.base.AssetServiceTransport]] = None, 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 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 (Union[str, AssetServiceTransport]) – The transport to use. If set to None, a transport is chosen automatically.

  • client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. It won’t take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

  • client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

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!

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

Analyzes IAM policies based on the specified request. Returns a list of [IamPolicyAnalysisResult][google.cloud.asset.v1p4beta1.IamPolicyAnalysisResult] matching the request.

from google.cloud import asset_v1p4beta1

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

    # Initialize request argument(s)
    analysis_query = asset_v1p4beta1.IamPolicyAnalysisQuery()
    analysis_query.parent = "parent_value"

    request = asset_v1p4beta1.AnalyzeIamPolicyRequest(
        analysis_query=analysis_query,
    )

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

    # Handle the response
    print(response)
Parameters
Returns

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

Return type

google.cloud.asset_v1p4beta1.types.AnalyzeIamPolicyResponse

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.

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

Exports IAM policy analysis based on the specified request. This API implements the [google.longrunning.Operation][google.longrunning.Operation] API allowing you to keep track of the export. The metadata contains the request to help callers to map responses to requests.

from google.cloud import asset_v1p4beta1

def sample_export_iam_policy_analysis():
    # Create a client
    client = asset_v1p4beta1.AssetServiceClient()

    # Initialize request argument(s)
    analysis_query = asset_v1p4beta1.IamPolicyAnalysisQuery()
    analysis_query.parent = "parent_value"

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

    request = asset_v1p4beta1.ExportIamPolicyAnalysisRequest(
        analysis_query=analysis_query,
        output_config=output_config,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.asset_v1p4beta1.types.ExportIamPolicyAnalysisResponse The export IAM policy analysis response. This message is returned by the

[google.longrunning.Operations.GetOperation][] method in the returned [google.longrunning.Operation.response][] field.

Return type

google.api_core.operation.Operation

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

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

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.

property transport: google.cloud.asset_v1p4beta1.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