Client for Cloud Asset API#
-
class
google.cloud.asset_v1p2beta1.
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 withcredentials
; 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, asset_names, content_type, read_time_window=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_v1p2beta1 >>> from google.cloud.asset_v1p2beta1 import enums >>> >>> client = asset_v1p2beta1.AssetServiceClient() >>> >>> # TODO: Initialize `parent`: >>> parent = '' >>> >>> # TODO: Initialize `asset_names`: >>> asset_names = [] >>> >>> # TODO: Initialize `content_type`: >>> content_type = enums.ContentType.CONTENT_TYPE_UNSPECIFIED >>> >>> response = client.batch_get_assets_history(parent, asset_names, content_type)
- 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”).
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 and Resource Name Format 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.
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
retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will be retried using a default configuration.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
google.api_core.exceptions.GoogleAPICallError – If the request failed for any reason.
google.api_core.exceptions.RetryError – If the request failed due to a retryable error and retry attempts failed.
ValueError – If the parameters are invalid.
-
create_feed
(parent, feed_id, feed, retry=<object object>, timeout=<object object>, metadata=None)[source]# Creates a feed in a parent project/folder/organization to listen to its asset updates.
Example
>>> from google.cloud import asset_v1p2beta1 >>> >>> client = asset_v1p2beta1.AssetServiceClient() >>> >>> # TODO: Initialize `parent`: >>> parent = '' >>> >>> # TODO: Initialize `feed_id`: >>> feed_id = '' >>> >>> # TODO: Initialize `feed`: >>> feed = {} >>> >>> response = client.create_feed(parent, feed_id, feed)
- Parameters
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”).
feed_id (str) – Required. This is the client-assigned asset feed identifier and it needs to be unique under a specific parent project/folder/organization.
The feed details. The field
name
must be empty and it will be generated in the format of: projects/project_number/feeds/feed_id folders/folder_number/feeds/feed_id organizations/organization_number/feeds/feed_idIf a dict is provided, it must be of the same form as the protobuf message
Feed
retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will be retried using a default configuration.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
Feed
instance.- Raises
google.api_core.exceptions.GoogleAPICallError – If the request failed for any reason.
google.api_core.exceptions.RetryError – If the request failed due to a retryable error and retry attempts failed.
ValueError – If the parameters are invalid.
-
delete_feed
(name, retry=<object object>, timeout=<object object>, metadata=None)[source]# Deletes an asset feed.
Example
>>> from google.cloud import asset_v1p2beta1 >>> >>> client = asset_v1p2beta1.AssetServiceClient() >>> >>> name = client.feed_path('[PROJECT]', '[FEED]') >>> >>> client.delete_feed(name)
- Parameters
name (str) – 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
retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will be retried using a default configuration.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.
- Raises
google.api_core.exceptions.GoogleAPICallError – If the request failed for any reason.
google.api_core.exceptions.RetryError – If the request failed due to a retryable error and retry attempts failed.
ValueError – If the parameters are invalid.
-
enums
= <module 'google.cloud.asset_v1p2beta1.gapic.enums' from '/usr/local/lib/python3.7/site-packages/google/cloud/asset_v1p2beta1/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_v1p2beta1 >>> >>> client = asset_v1p2beta1.AssetServiceClient() >>> >>> # TODO: Initialize `parent`: >>> parent = '' >>> >>> # 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”), or a project number (such as “projects/12345”).
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: “compute.googleapis.com/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 be retried using a default configuration.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
google.api_core.exceptions.GoogleAPICallError – If the request failed for any reason.
google.api_core.exceptions.RetryError – If the request failed due to a retryable error and retry attempts failed.
ValueError – If the parameters are invalid.
-
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
-
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
-
get_feed
(name, retry=<object object>, timeout=<object object>, metadata=None)[source]# Gets details about an asset feed.
Example
>>> from google.cloud import asset_v1p2beta1 >>> >>> client = asset_v1p2beta1.AssetServiceClient() >>> >>> name = client.feed_path('[PROJECT]', '[FEED]') >>> >>> response = client.get_feed(name)
- Parameters
name (str) – 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
retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will be retried using a default configuration.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
Feed
instance.- Raises
google.api_core.exceptions.GoogleAPICallError – If the request failed for any reason.
google.api_core.exceptions.RetryError – If the request failed due to a retryable error and retry attempts failed.
ValueError – If the parameters are invalid.
-
list_feeds
(parent, retry=<object object>, timeout=<object object>, metadata=None)[source]# Lists all asset feeds in a parent project/folder/organization.
Example
>>> from google.cloud import asset_v1p2beta1 >>> >>> client = asset_v1p2beta1.AssetServiceClient() >>> >>> # TODO: Initialize `parent`: >>> parent = '' >>> >>> response = client.list_feeds(parent)
- Parameters
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”).
retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will be retried using a default configuration.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
ListFeedsResponse
instance.- Raises
google.api_core.exceptions.GoogleAPICallError – If the request failed for any reason.
google.api_core.exceptions.RetryError – If the request failed due to a retryable error and retry attempts failed.
ValueError – If the parameters are invalid.
-
update_feed
(feed, update_mask, retry=<object object>, timeout=<object object>, metadata=None)[source]# Updates an asset feed configuration.
Example
>>> from google.cloud import asset_v1p2beta1 >>> >>> client = asset_v1p2beta1.AssetServiceClient() >>> >>> # TODO: Initialize `feed`: >>> feed = {} >>> >>> # TODO: Initialize `update_mask`: >>> update_mask = {} >>> >>> response = client.update_feed(feed, update_mask)
- Parameters
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.If a dict is provided, it must be of the same form as the protobuf message
Feed
update_mask (Union[dict, FieldMask]) –
Only updates the
feed
fields indicated by this mask. The field mask must not be empty, and it must not contain fields that are immutable or only set by the server.If a dict is provided, it must be of the same form as the protobuf message
FieldMask
retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will be retried using a default configuration.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
Feed
instance.- Raises
google.api_core.exceptions.GoogleAPICallError – If the request failed for any reason.
google.api_core.exceptions.RetryError – If the request failed due to a retryable error and retry attempts failed.
ValueError – If the parameters are invalid.