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.

Services for Google Cloud Asset v1p1beta1 API

class google.cloud.asset_v1p1beta1.services.asset_service.AssetServiceClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.asset_v1p1beta1.services.asset_service.transports.base.AssetServiceTransport] = None, client_options: <module 'google.api_core.client_options' from '/workspace/.nox/docs/lib/python3.8/site-packages/google/api_core/client_options.py'> = None)[source]

Asset service definition.

Instantiate 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 environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint, this is the default value for the environment variable) and “auto” (auto switch to the default mTLS endpoint if client SSL credentials is present). However, the api_endpoint property takes precedence if provided. (2) The client_cert_source property is used to provide client SSL credentials for mutual TLS transport. If not provided, the default SSL credentials will be used if present.

Raises

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

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

{@api.name}

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

{@api.name}

search_all_iam_policies(request: google.cloud.asset_v1p1beta1.types.asset_service.SearchAllIamPoliciesRequest = None, *, scope: str = None, query: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: 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 (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

SearchAllIamPoliciesPager

search_all_resources(request: google.cloud.asset_v1p1beta1.types.asset_service.SearchAllResourcesRequest = None, *, scope: str = None, query: str = None, asset_types: Sequence[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: 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 (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

SearchAllResourcesPager

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 '/workspace/.nox/docs/lib/python3.8/site-packages/google/api_core/client_options.py'> = None)[source]

Asset service definition.

Instantiate 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 environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint, this is the default value for the environment variable) and “auto” (auto switch to the default mTLS endpoint if client SSL credentials is present). However, the api_endpoint property takes precedence if provided. (2) The client_cert_source property is used to provide client SSL credentials for mutual TLS transport. If not provided, the default SSL credentials will be used if present.

Raises

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

classmethod from_service_account_file(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

{@api.name}

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

{@api.name}

get_transport_class = functools.partial(<function AssetServiceClientMeta.get_transport_class>, <class 'google.cloud.asset_v1p1beta1.services.asset_service.client.AssetServiceClientMeta'>)
async search_all_iam_policies(request: google.cloud.asset_v1p1beta1.types.asset_service.SearchAllIamPoliciesRequest = None, *, scope: str = None, query: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: 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 (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

SearchAllIamPoliciesAsyncPager

async search_all_resources(request: google.cloud.asset_v1p1beta1.types.asset_service.SearchAllResourcesRequest = None, *, scope: str = None, query: str = None, asset_types: Sequence[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: 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 (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

SearchAllResourcesAsyncPager