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.

Types for Google Cloud Asset v1beta1 API

class google.cloud.asset_v1beta1.types.TemporalAsset(mapping=None, **kwargs)[source]

Temporal asset. In addition to the asset, the temporal asset includes the status of the asset and valid from and to time of it.

window

The time window when the asset data and state was observed.

Type

TimeWindow

deleted

If the asset is deleted or not.

Type

bool

asset

Asset.

Type

Asset

class google.cloud.asset_v1beta1.types.TimeWindow(mapping=None, **kwargs)[source]

A time window of (start_time, end_time].

start_time

Start time of the time window (exclusive).

Type

Timestamp

end_time

End time of the time window (inclusive). Current timestamp if not specified.

Type

Timestamp

class google.cloud.asset_v1beta1.types.Asset(mapping=None, **kwargs)[source]

Cloud asset. This includes all Google Cloud Platform resources, Cloud IAM policies, and other non-GCP assets.

name

The full name of the asset. For example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1. See Resource Names for more information.

Type

str

asset_type

Type of the asset. Example: “google.compute.Disk”.

Type

str

resource

Representation of the resource.

Type

Resource

iam_policy

Representation of the actual Cloud IAM policy set on a cloud resource. For each resource, there must be at most one Cloud IAM policy set on it.

Type

Policy

class google.cloud.asset_v1beta1.types.Resource(mapping=None, **kwargs)[source]

Representation of a cloud resource.

version

The API version. Example: “v1”.

Type

str

discovery_document_uri

The URL of the discovery document containing the resource’s JSON schema. For example: "https://www.googleapis.com/discovery/v1/apis/compute/v1/rest". It will be left unspecified for resources without a discovery-based API, such as Cloud Bigtable.

Type

str

discovery_name

The JSON schema name listed in the discovery document. Example: “Project”. It will be left unspecified for resources (such as Cloud Bigtable) without a discovery-based API.

Type

str

resource_url

The REST URL for accessing the resource. An HTTP GET operation using this URL returns the resource itself. Example: https://cloudresourcemanager.googleapis.com/v1/projects/my-project-123. It will be left unspecified for resources without a REST API.

Type

str

parent

The full name of the immediate parent of this resource. See Resource Names for more information.

For GCP assets, it is the parent resource defined in the Cloud IAM policy hierarchy. For example: "//cloudresourcemanager.googleapis.com/projects/my_project_123".

For third-party assets, it is up to the users to define.

Type

str

data

The content of the resource, in which some sensitive fields are scrubbed away and may not be present.

Type

Struct

class google.cloud.asset_v1beta1.types.ExportAssetsRequest(mapping=None, **kwargs)[source]

Export asset request.

parent

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”).

Type

str

read_time

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.

Type

Timestamp

asset_types

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.

Type

Sequence[str]

content_type

Asset content type. If not specified, no content but the asset name will be returned.

Type

ContentType

output_config

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

Type

OutputConfig

class google.cloud.asset_v1beta1.types.ExportAssetsResponse(mapping=None, **kwargs)[source]

The export asset response. This message is returned by the [google.longrunning.Operations.GetOperation][google.longrunning.Operations.GetOperation] method in the returned [google.longrunning.Operation.response][google.longrunning.Operation.response] field.

read_time

Time the snapshot was taken.

Type

Timestamp

output_config

Output configuration indicating where the results were output to. All results are in JSON format.

Type

OutputConfig

class google.cloud.asset_v1beta1.types.BatchGetAssetsHistoryRequest(mapping=None, **kwargs)[source]

Batch get assets history request.

parent

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”).

Type

str

asset_names

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.

Type

Sequence[str]

content_type

Optional. The content type.

Type

ContentType

read_time_window

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.

Type

TimeWindow

class google.cloud.asset_v1beta1.types.BatchGetAssetsHistoryResponse(mapping=None, **kwargs)[source]

Batch get assets history response.

assets

A list of assets with valid time windows.

Type

Sequence[TemporalAsset]

class google.cloud.asset_v1beta1.types.OutputConfig(mapping=None, **kwargs)[source]

Output configuration for export assets destination.

gcs_destination

Destination on Cloud Storage.

Type

GcsDestination

class google.cloud.asset_v1beta1.types.GcsDestination(mapping=None, **kwargs)[source]

A Cloud Storage location.

uri

The uri of the Cloud Storage object. It’s the same uri that is used by gsutil. For example: “gs://bucket_name/object_name”. See Viewing and Editing Object Metadata for more information.

Type

str

uri_prefix

The uri prefix of all generated Cloud Storage objects. For example: “gs://bucket_name/object_name_prefix”. Each object uri is in format: “gs://bucket_name/object_name_prefix// and only contains assets for that type. starts from 0. For example: “gs://bucket_name/object_name_prefix/google.compute.disk/0” is the first shard of output objects containing all google.compute.disk assets. An INVALID_ARGUMENT error will be returned if file with the same name “gs://bucket_name/object_name_prefix” already exists.

Type

str