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_v1p1beta1.services.asset_service.AssetServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.asset_v1p1beta1.services.asset_service.transports.base.AssetServiceTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/usr/lib/python3.10/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[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.

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.

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

get_transport_class() Type[google.cloud.asset_v1p1beta1.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.

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

Searches all the IAM policies under a given accessible CRM scope (project/folder/organization). This RPC gives callers especially admins the ability to search all the IAM policies under a scope, even if they don’t have .getIamPolicy permission of all the IAM policies. Callers should have cloud.assets.SearchAllIamPolicies permission on the requested scope, otherwise it will be rejected.

Parameters
  • request (google.cloud.asset_v1p1beta1.types.SearchAllIamPoliciesRequest) – The request object. Search all IAM policies request.

  • scope (str) –

    Required. The relative name of an asset. The search is limited to the resources within the scope. The allowed value must be:

    • Organization number (such as “organizations/123”)

    • Folder number(such as “folders/1234”)

    • Project number (such as “projects/12345”)

    • Project id (such as “projects/abc”)

    This corresponds to the scope field on the request instance; if request is provided, this should not be set.

  • query (str) –

    Optional. The query statement. Examples:

    • ”policy:myuser@mydomain.com”

    • ”policy:(myuser@mydomain.com viewer)”

    This corresponds to the query field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Search all IAM policies response. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.asset_v1p1beta1.services.asset_service.pagers.SearchAllIamPoliciesAsyncPager

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

Searches all the resources under a given accessible CRM scope (project/folder/organization). This RPC gives callers especially admins the ability to search all the resources under a scope, even if they don’t have .get permission of all the resources. Callers should have cloud.assets.SearchAllResources permission on the requested scope, otherwise it will be rejected.

Parameters
  • request (google.cloud.asset_v1p1beta1.types.SearchAllResourcesRequest) – The request object. Search all resources request.

  • scope (str) –

    Required. The relative name of an asset. The search is limited to the resources within the scope. The allowed value must be:

    • Organization number (such as “organizations/123”)

    • Folder number(such as “folders/1234”)

    • Project number (such as “projects/12345”)

    • Project id (such as “projects/abc”)

    This corresponds to the scope field on the request instance; if request is provided, this should not be set.

  • query (str) – Optional. The query statement. This corresponds to the query field on the request instance; if request is provided, this should not be set.

  • asset_types (Sequence[str]) –

    Optional. A list of asset types that this request searches for. If empty, it will search all the supported asset types.

    This corresponds to the asset_types field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Search all resources response. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.asset_v1p1beta1.services.asset_service.pagers.SearchAllResourcesAsyncPager

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

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.

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

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.

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

Searches all the IAM policies under a given accessible CRM scope (project/folder/organization). This RPC gives callers especially admins the ability to search all the IAM policies under a scope, even if they don’t have .getIamPolicy permission of all the IAM policies. Callers should have cloud.assets.SearchAllIamPolicies permission on the requested scope, otherwise it will be rejected.

Parameters
  • request (Union[google.cloud.asset_v1p1beta1.types.SearchAllIamPoliciesRequest, dict]) – The request object. Search all IAM policies request.

  • scope (str) –

    Required. The relative name of an asset. The search is limited to the resources within the scope. The allowed value must be:

    • Organization number (such as “organizations/123”)

    • Folder number(such as “folders/1234”)

    • Project number (such as “projects/12345”)

    • Project id (such as “projects/abc”)

    This corresponds to the scope field on the request instance; if request is provided, this should not be set.

  • query (str) –

    Optional. The query statement. Examples:

    • ”policy:myuser@mydomain.com”

    • ”policy:(myuser@mydomain.com viewer)”

    This corresponds to the query field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Search all IAM policies response. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.asset_v1p1beta1.services.asset_service.pagers.SearchAllIamPoliciesPager

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

Searches all the resources under a given accessible CRM scope (project/folder/organization). This RPC gives callers especially admins the ability to search all the resources under a scope, even if they don’t have .get permission of all the resources. Callers should have cloud.assets.SearchAllResources permission on the requested scope, otherwise it will be rejected.

Parameters
  • request (Union[google.cloud.asset_v1p1beta1.types.SearchAllResourcesRequest, dict]) – The request object. Search all resources request.

  • scope (str) –

    Required. The relative name of an asset. The search is limited to the resources within the scope. The allowed value must be:

    • Organization number (such as “organizations/123”)

    • Folder number(such as “folders/1234”)

    • Project number (such as “projects/12345”)

    • Project id (such as “projects/abc”)

    This corresponds to the scope field on the request instance; if request is provided, this should not be set.

  • query (str) – Optional. The query statement. This corresponds to the query field on the request instance; if request is provided, this should not be set.

  • asset_types (Sequence[str]) –

    Optional. A list of asset types that this request searches for. If empty, it will search all the supported asset types.

    This corresponds to the asset_types field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Search all resources response. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.asset_v1p1beta1.services.asset_service.pagers.SearchAllResourcesPager

property transport: google.cloud.asset_v1p1beta1.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_v1p1beta1.services.asset_service.pagers.SearchAllIamPoliciesAsyncPager(method: Callable[[...], Awaitable[google.cloud.asset_v1p1beta1.types.asset_service.SearchAllIamPoliciesResponse]], request: google.cloud.asset_v1p1beta1.types.asset_service.SearchAllIamPoliciesRequest, response: google.cloud.asset_v1p1beta1.types.asset_service.SearchAllIamPoliciesResponse, *, 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_v1p1beta1.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_v1p1beta1.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
class google.cloud.asset_v1p1beta1.services.asset_service.pagers.SearchAllIamPoliciesPager(method: Callable[[...], google.cloud.asset_v1p1beta1.types.asset_service.SearchAllIamPoliciesResponse], request: google.cloud.asset_v1p1beta1.types.asset_service.SearchAllIamPoliciesRequest, response: google.cloud.asset_v1p1beta1.types.asset_service.SearchAllIamPoliciesResponse, *, 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_v1p1beta1.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_v1p1beta1.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
class google.cloud.asset_v1p1beta1.services.asset_service.pagers.SearchAllResourcesAsyncPager(method: Callable[[...], Awaitable[google.cloud.asset_v1p1beta1.types.asset_service.SearchAllResourcesResponse]], request: google.cloud.asset_v1p1beta1.types.asset_service.SearchAllResourcesRequest, response: google.cloud.asset_v1p1beta1.types.asset_service.SearchAllResourcesResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through search_all_resources requests.

This class thinly wraps an initial google.cloud.asset_v1p1beta1.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_v1p1beta1.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
class google.cloud.asset_v1p1beta1.services.asset_service.pagers.SearchAllResourcesPager(method: Callable[[...], google.cloud.asset_v1p1beta1.types.asset_service.SearchAllResourcesResponse], request: google.cloud.asset_v1p1beta1.types.asset_service.SearchAllResourcesRequest, response: google.cloud.asset_v1p1beta1.types.asset_service.SearchAllResourcesResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through search_all_resources requests.

This class thinly wraps an initial google.cloud.asset_v1p1beta1.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_v1p1beta1.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