Client for Cloud Asset API#

class google.cloud.asset_v1beta1.AssetServiceClient(transport=None, channel=None, credentials=None, client_config=None, client_info=None, client_options=None)[source]#

Asset service definition.

Constructor.

Parameters:
  • (Union[AssetServiceGrpcTransport, (transport) – Callable[[~.Credentials, type], ~.AssetServiceGrpcTransport]): A transport instance, responsible for actually making the API calls. The default transport uses the gRPC protocol. This argument may also be a callable which returns a transport instance. Callables will be sent the credentials as the first argument and the default transport class as the second argument.
  • channel (grpc.Channel) – DEPRECATED. A Channel instance through which to make calls. This argument is mutually exclusive with credentials; providing both will raise an exception.
  • credentials (google.auth.credentials.Credentials) – The authorization credentials to attach to requests. These credentials identify this application to the service. If none are specified, the client will attempt to ascertain the credentials from the environment. This argument is mutually exclusive with providing a transport instance to transport; doing so will raise an exception.
  • client_config (dict) – DEPRECATED. A dictionary of call options for each method. If not specified, the default configuration is 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.
  • client_options (Union[dict, google.api_core.client_options.ClientOptions]) – Client options used to set user options on the client. API Endpoint should be set through client_options.
batch_get_assets_history(parent, content_type, read_time_window, asset_names=None, retry=<object object>, timeout=<object object>, metadata=None)[source]#

Batch gets the update history of assets that overlap a time window. For RESOURCE content, this API outputs history with asset in both non-delete or deleted status. 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.

Example

>>> from google.cloud import asset_v1beta1
>>> from google.cloud.asset_v1beta1 import enums
>>>
>>> client = asset_v1beta1.AssetServiceClient()
>>>
>>> parent = client.project_path('[PROJECT]')
>>>
>>> # TODO: Initialize `content_type`:
>>> content_type = enums.ContentType.CONTENT_TYPE_UNSPECIFIED
>>>
>>> # TODO: Initialize `read_time_window`:
>>> read_time_window = {}
>>>
>>> response = client.batch_get_assets_history(parent, content_type, read_time_window)
Parameters:
  • parent (str) – Required. The relative name of the root asset. It can only be an organization number (such as “organizations/123”), a project ID (such as “projects/my-project-id”)”, or a project number (such as “projects/12345”).
  • content_type (ContentType) – Required. The content type.
  • read_time_window (Union[dict, TimeWindow]) –

    Optional. The time window for the asset history. Both start_time and end_time are optional and if set, it must be after 2018-10-02 UTC. If end_time is not set, it is default to current timestamp. If start_time is not set, the snapshot of the assets at end_time will be returned. The returned results contain all temporal assets whose time window overlap with read_time_window.

    If a dict is provided, it must be of the same form as the protobuf message TimeWindow

  • asset_names (list[str]) –

    A list of the full names of the assets. For example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1. See Resource Names for more info.

    The request becomes a no-op if the asset name list is empty, and the max size of the asset name list is 100 in one request.

  • retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If None is specified, requests will not be retried.
  • timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
  • metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
Returns:

A BatchGetAssetsHistoryResponse instance.

Raises:
enums = <module 'google.cloud.asset_v1beta1.gapic.enums' from '/var/code/gcp/asset/google/cloud/asset_v1beta1/gapic/enums.py'>#
export_assets(parent, output_config, read_time=None, asset_types=None, content_type=None, retry=<object object>, timeout=<object object>, metadata=None)[source]#

Exports assets with time and resource types to a given Cloud Storage location. The output format is newline-delimited JSON. This API implements the google.longrunning.Operation API allowing you to keep track of the export.

Example

>>> from google.cloud import asset_v1beta1
>>>
>>> client = asset_v1beta1.AssetServiceClient()
>>>
>>> parent = client.project_path('[PROJECT]')
>>>
>>> # TODO: Initialize `output_config`:
>>> output_config = {}
>>>
>>> response = client.export_assets(parent, output_config)
>>>
>>> def callback(operation_future):
...     # Handle result.
...     result = operation_future.result()
>>>
>>> response.add_done_callback(callback)
>>>
>>> # Handle metadata.
>>> metadata = response.metadata()
Parameters:
  • parent (str) – Required. The relative name of the root asset. This can only be an organization number (such as “organizations/123”), a project ID (such as “projects/my-project-id”), a project number (such as “projects/12345”), or a folder number (such as “folders/123”).
  • output_config (Union[dict, OutputConfig]) –

    Required. Output configuration indicating where the results will be output to. All results will be in newline delimited JSON format.

    If a dict is provided, it must be of the same form as the protobuf message OutputConfig

  • read_time (Union[dict, Timestamp]) –

    Timestamp to take an asset snapshot. This can only be set to a timestamp between 2018-10-02 UTC (inclusive) and the current time. If not specified, the current time will be used. Due to delays in resource data collection and indexing, there is a volatile window during which running the same query may get different results.

    If a dict is provided, it must be of the same form as the protobuf message Timestamp

  • asset_types (list[str]) – A list of asset types of which to take a snapshot for. For example: “google.compute.Disk”. If specified, only matching assets will be returned. See Introduction to Cloud Asset Inventory for all supported asset types.
  • content_type (ContentType) – Asset content type. If not specified, no content but the asset name will be returned.
  • retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If None is specified, requests will not be retried.
  • timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
  • metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
Returns:

A _OperationFuture instance.

Raises:
classmethod from_service_account_file(filename, *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_json(filename, *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 project_path(project)[source]#

Return a fully-qualified project string.