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 v1 API

class google.cloud.asset_v1.types.AnalyzeIamPolicyLongrunningMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents the metadata of the longrunning operation for the AnalyzeIamPolicyLongrunning rpc.

create_time

Output only. The time the operation was created.

Type

google.protobuf.timestamp_pb2.Timestamp

class google.cloud.asset_v1.types.AnalyzeIamPolicyLongrunningRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A request message for [AssetService.AnalyzeIamPolicyLongrunning][google.cloud.asset.v1.AssetService.AnalyzeIamPolicyLongrunning].

analysis_query

Required. The request query.

Type

google.cloud.asset_v1.types.IamPolicyAnalysisQuery

output_config

Required. Output configuration indicating where the results will be output to.

Type

google.cloud.asset_v1.types.IamPolicyAnalysisOutputConfig

class google.cloud.asset_v1.types.AnalyzeIamPolicyLongrunningResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A response message for [AssetService.AnalyzeIamPolicyLongrunning][google.cloud.asset.v1.AssetService.AnalyzeIamPolicyLongrunning].

class google.cloud.asset_v1.types.AnalyzeIamPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A request message for [AssetService.AnalyzeIamPolicy][google.cloud.asset.v1.AssetService.AnalyzeIamPolicy].

analysis_query

Required. The request query.

Type

google.cloud.asset_v1.types.IamPolicyAnalysisQuery

execution_timeout

Optional. Amount of time executable has to complete. See JSON representation of Duration.

If this field is set with a value less than the RPC deadline, and the execution of your query hasn’t finished in the specified execution timeout, you will get a response with partial result. Otherwise, your query’s execution will continue until the RPC deadline. If it’s not finished until then, you will get a DEADLINE_EXCEEDED error.

Default is empty.

Type

google.protobuf.duration_pb2.Duration

class google.cloud.asset_v1.types.AnalyzeIamPolicyResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A response message for [AssetService.AnalyzeIamPolicy][google.cloud.asset.v1.AssetService.AnalyzeIamPolicy].

main_analysis

The main analysis that matches the original request.

Type

google.cloud.asset_v1.types.AnalyzeIamPolicyResponse.IamPolicyAnalysis

service_account_impersonation_analysis

The service account impersonation analysis if [AnalyzeIamPolicyRequest.analyze_service_account_impersonation][] is enabled.

Type

Sequence[google.cloud.asset_v1.types.AnalyzeIamPolicyResponse.IamPolicyAnalysis]

fully_explored

Represents whether all entries in the [main_analysis][google.cloud.asset.v1.AnalyzeIamPolicyResponse.main_analysis] and [service_account_impersonation_analysis][google.cloud.asset.v1.AnalyzeIamPolicyResponse.service_account_impersonation_analysis] have been fully explored to answer the query in the request.

Type

bool

class IamPolicyAnalysis(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

An analysis message to group the query and results. .. attribute:: analysis_query

The analysis query.

type

google.cloud.asset_v1.types.IamPolicyAnalysisQuery

analysis_results

A list of [IamPolicyAnalysisResult][google.cloud.asset.v1.IamPolicyAnalysisResult] that matches the analysis query, or empty if no result is found.

Type

Sequence[google.cloud.asset_v1.types.IamPolicyAnalysisResult]

fully_explored

Represents whether all entries in the [analysis_results][google.cloud.asset.v1.AnalyzeIamPolicyResponse.IamPolicyAnalysis.analysis_results] have been fully explored to answer the query.

Type

bool

non_critical_errors

A list of non-critical errors happened during the query handling.

Type

Sequence[google.cloud.asset_v1.types.IamPolicyAnalysisState]

class google.cloud.asset_v1.types.AnalyzeMoveRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for performing resource move analysis. .. attribute:: resource

Required. Name of the resource to perform the analysis against. Only GCP Project are supported as of today. Hence, this can only be Project ID (such as “projects/my-project-id”) or a Project Number (such as “projects/12345”).

type

str

destination_parent

Required. Name of the GCP Folder or Organization to reparent the target resource. The analysis will be performed against hypothetically moving the resource to this specified desitination parent. This can only be a Folder number (such as “folders/123”) or an Organization number (such as “organizations/123”).

Type

str

view

Analysis view indicating what information should be included in the analysis response. If unspecified, the default view is FULL.

Type

google.cloud.asset_v1.types.AnalyzeMoveRequest.AnalysisView

class AnalysisView(value)[source]

Bases: proto.enums.Enum

View enum for supporting partial analysis responses.

ANALYSIS_VIEW_UNSPECIFIED = 0
BASIC = 2
FULL = 1
class google.cloud.asset_v1.types.AnalyzeMoveResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The response message for resource move analysis. .. attribute:: move_analysis

The list of analyses returned from performing the intended resource move analysis. The analysis is grouped by different Cloud services.

type

Sequence[google.cloud.asset_v1.types.MoveAnalysis]

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

Bases: proto.message.Message

An asset in Google Cloud. An asset can be any resource in the Google Cloud resource hierarchy, a resource outside the Google Cloud resource hierarchy (such as Google Kubernetes Engine clusters and objects), or a policy (e.g. Cloud IAM policy), or a relationship (e.g. an INSTANCE_TO_INSTANCEGROUP relationship). See Supported asset types for more information.

update_time

The last update timestamp of an asset. update_time is updated when create/update/delete operation is performed.

Type

google.protobuf.timestamp_pb2.Timestamp

name

The full name of the asset. Example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1

See Resource names for more information.

Type

str

asset_type

The type of the asset. Example: compute.googleapis.com/Disk

See Supported asset types for more information.

Type

str

resource

A representation of the resource.

Type

google.cloud.asset_v1.types.Resource

iam_policy

A representation of the Cloud IAM policy set on a Google Cloud resource. There can be a maximum of one Cloud IAM policy set on any given resource. In addition, Cloud IAM policies inherit their granted access scope from any policies set on parent resources in the resource hierarchy. Therefore, the effectively policy is the union of both the policy set on this resource and each policy set on all of the resource’s ancestry resource levels in the hierarchy. See this topic for more information.

Type

google.iam.v1.policy_pb2.Policy

org_policy

A representation of an organization policy. There can be more than one organization policy with different constraints set on a given resource.

Type

Sequence[google.cloud.orgpolicy.v1.orgpolicy_pb2.Policy]

access_policy

Please also refer to the access policy user guide.

Type

google.identity.accesscontextmanager.v1.access_policy_pb2.AccessPolicy

access_level

Please also refer to the access level user guide.

Type

google.identity.accesscontextmanager.v1.access_level_pb2.AccessLevel

service_perimeter

Please also refer to the service perimeter user guide.

Type

google.identity.accesscontextmanager.v1.service_perimeter_pb2.ServicePerimeter

os_inventory

A representation of runtime OS Inventory information. See this topic for more information.

Type

google.cloud.osconfig_v1.Inventory

related_assets

The related assets of the asset of one relationship type. One asset only represents one type of relationship.

Type

google.cloud.asset_v1.types.RelatedAssets

ancestors

The ancestry path of an asset in Google Cloud resource hierarchy, represented as a list of relative resource names. An ancestry path starts with the closest ancestor in the hierarchy and ends at root. If the asset is a project, folder, or organization, the ancestry path starts from the asset itself.

Example: ["projects/123456789", "folders/5432", "organizations/1234"]

Type

Sequence[str]

class google.cloud.asset_v1.types.AttachedResource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Attached resource representation, which is defined by the corresponding service provider. It represents an attached resource’s payload.

asset_type

The type of this attached resource.

Example: osconfig.googleapis.com/Inventory

You can find the supported attached asset types of each resource in this table: https://cloud.google.com/asset-inventory/docs/supported-asset-types#searchable_asset_types

Type

str

versioned_resources

Versioned resource representations of this attached resource. This is repeated because there could be multiple versions of the attached resource representations during version migration.

Type

Sequence[google.cloud.asset_v1.types.VersionedResource]

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

Bases: proto.message.Message

Batch get assets history request. .. attribute:: 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. See: https://cloud.google.com/asset-inventory/docs/resource-name-format Example:

//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1.

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

google.cloud.asset_v1.types.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 the current time minus 35 days. 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

google.cloud.asset_v1.types.TimeWindow

relationship_types

Optional. A list of relationship types to output, for example: INSTANCE_TO_INSTANCEGROUP. This field should only be specified if content_type=RELATIONSHIP.

  • If specified: it outputs specified relationships’ history on the [asset_names]. It returns an error if any of the [relationship_types] doesn’t belong to the supported relationship types of the [asset_names] or if any of the [asset_names]’s types doesn’t belong to the source types of the [relationship_types].

  • Otherwise: it outputs the supported relationships’ history on the [asset_names] or returns an error if any of the [asset_names]’s types has no relationship support. See Introduction to Cloud Asset Inventory for all supported asset types and relationship types.

Type

Sequence[str]

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

Bases: proto.message.Message

Batch get assets history response. .. attribute:: assets

A list of assets with valid time windows.

type

Sequence[google.cloud.asset_v1.types.TemporalAsset]

class google.cloud.asset_v1.types.BigQueryDestination(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A BigQuery destination for exporting assets to. .. attribute:: dataset

Required. The BigQuery dataset in format “projects/projectId/datasets/datasetId”, to which the snapshot result should be exported. If this dataset does not exist, the export call returns an INVALID_ARGUMENT error.

type

str

table

Required. The BigQuery table to which the snapshot result should be written. If this table does not exist, a new table with the given name will be created.

Type

str

force

If the destination table already exists and this flag is TRUE, the table will be overwritten by the contents of assets snapshot. If the flag is FALSE or unset and the destination table already exists, the export call returns an INVALID_ARGUMEMT error.

Type

bool

partition_spec

[partition_spec] determines whether to export to partitioned table(s) and how to partition the data.

If [partition_spec] is unset or [partition_spec.partition_key] is unset or PARTITION_KEY_UNSPECIFIED, the snapshot results will be exported to non-partitioned table(s). [force] will decide whether to overwrite existing table(s).

If [partition_spec] is specified. First, the snapshot results will be written to partitioned table(s) with two additional timestamp columns, readTime and requestTime, one of which will be the partition key. Secondly, in the case when any destination table already exists, it will first try to update existing table’s schema as necessary by appending additional columns. Then, if [force] is TRUE, the corresponding partition will be overwritten by the snapshot results (data in different partitions will remain intact); if [force] is unset or FALSE, it will append the data. An error will be returned if the schema update or data appension fails.

Type

google.cloud.asset_v1.types.PartitionSpec

separate_tables_per_asset_type

If this flag is TRUE, the snapshot results will be written to one or multiple tables, each of which contains results of one asset type. The [force] and [partition_spec] fields will apply to each of them.

Field [table] will be concatenated with “*” and the asset type names (see https://cloud.google.com/asset-inventory/docs/supported-asset-types for supported asset types) to construct per-asset-type table names, in which all non-alphanumeric characters like “.” and “/” will be substituted by “*”. Example: if field [table] is “mytable” and snapshot results contain “storage.googleapis.com/Bucket” assets, the corresponding table name will be “mytable_storage_googleapis_com_Bucket”. If any of these tables does not exist, a new table with the concatenated name will be created.

When [content_type] in the ExportAssetsRequest is RESOURCE, the schema of each table will include RECORD-type columns mapped to the nested fields in the Asset.resource.data field of that asset type (up to the 15 nested level BigQuery supports (https://cloud.google.com/bigquery/docs/nested-repeated#limitations)). The fields in >15 nested levels will be stored in JSON format string as a child column of its parent RECORD column.

If error occurs when exporting to any table, the whole export call will return an error but the export results that already succeed will persist. Example: if exporting to table_type_A succeeds when exporting to table_type_B fails during one export call, the results in table_type_A will persist and there will not be partial results persisting in a table.

Type

bool

class google.cloud.asset_v1.types.ConditionEvaluation(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The Condition evaluation. .. attribute:: evaluation_value

The evaluation result.

type

google.cloud.asset_v1.types.ConditionEvaluation.EvaluationValue

class EvaluationValue(value)[source]

Bases: proto.enums.Enum

Value of this expression.

CONDITIONAL = 3
EVALUATION_VALUE_UNSPECIFIED = 0
FALSE = 2
TRUE = 1
class google.cloud.asset_v1.types.ContentType(value)[source]

Bases: proto.enums.Enum

Asset content type.

ACCESS_POLICY = 5
CONTENT_TYPE_UNSPECIFIED = 0
IAM_POLICY = 2
ORG_POLICY = 4
OS_INVENTORY = 6
RELATIONSHIP = 7
RESOURCE = 1
class google.cloud.asset_v1.types.CreateFeedRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Create asset feed request. .. attribute:: parent

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

type

str

feed_id

Required. This is the client-assigned asset feed identifier and it needs to be unique under a specific parent project/folder/organization.

Type

str

feed

Required. 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_id

Type

google.cloud.asset_v1.types.Feed

class google.cloud.asset_v1.types.DeleteFeedRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

name

Required. 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

Type

str

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

Bases: proto.message.Message

Export asset request. .. attribute:: 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”), or 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 the current time and the current time minus 35 days (inclusive). 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

google.protobuf.timestamp_pb2.Timestamp

asset_types

A list of asset types to take a snapshot for. For example: “compute.googleapis.com/Disk”.

Regular expressions are also supported. For example:

  • “compute.googleapis.com.*” snapshots resources whose asset type starts with “compute.googleapis.com”.

  • “.*Instance” snapshots resources whose asset type ends with “Instance”.

  • “.*Instance.*” snapshots resources whose asset type contains “Instance”.

See RE2 for all supported regular expression syntax. If the regular expression does not match any supported asset type, an INVALID_ARGUMENT error will be returned.

If specified, only matching assets will be returned, otherwise, it will snapshot all asset types. 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

google.cloud.asset_v1.types.ContentType

output_config

Required. Output configuration indicating where the results will be output to.

Type

google.cloud.asset_v1.types.OutputConfig

relationship_types

A list of relationship types to export, for example: INSTANCE_TO_INSTANCEGROUP. This field should only be specified if content_type=RELATIONSHIP.

  • If specified: it snapshots specified relationships. It returns an error if any of the [relationship_types] doesn’t belong to the supported relationship types of the [asset_types] or if any of the [asset_types] doesn’t belong to the source types of the [relationship_types].

  • Otherwise: it snapshots the supported relationships for all [asset_types] or returns an error if any of the [asset_types] has no relationship support. An unspecified asset types field means all supported asset_types. See Introduction to Cloud Asset Inventory for all supported asset types and relationship types.

Type

Sequence[str]

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

Bases: proto.message.Message

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

google.protobuf.timestamp_pb2.Timestamp

output_config

Output configuration indicating where the results were output to.

Type

google.cloud.asset_v1.types.OutputConfig

output_result

Output result indicating where the assets were exported to. For example, a set of actual Google Cloud Storage object uris where the assets are exported to. The uris can be different from what [output_config] has specified, as the service will split the output object into multiple ones once it exceeds a single Google Cloud Storage object limit.

Type

google.cloud.asset_v1.types.OutputResult

class google.cloud.asset_v1.types.Feed(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

An asset feed used to export asset updates to a destinations. An asset feed filter controls what updates are exported. The asset feed must be created within a project, organization, or folder. Supported destinations are: Pub/Sub topics.

name

Required. The format will be projects/{project_number}/feeds/{client-assigned_feed_identifier} or folders/{folder_number}/feeds/{client-assigned_feed_identifier} or organizations/{organization_number}/feeds/{client-assigned_feed_identifier}

The client-assigned feed identifier must be unique within the parent project/folder/organization.

Type

str

asset_names

A list of the full names of the assets to receive updates. You must specify either or both of asset_names and asset_types. Only asset updates matching specified asset_names or asset_types are exported to the feed. Example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1. See Resource Names for more info.

Type

Sequence[str]

asset_types

A list of types of the assets to receive updates. You must specify either or both of asset_names and asset_types. Only asset updates matching specified asset_names or asset_types are exported to the feed. Example: "compute.googleapis.com/Disk"

See this topic for a list of all supported asset types.

Type

Sequence[str]

content_type

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

Type

google.cloud.asset_v1.types.ContentType

feed_output_config

Required. Feed output configuration defining where the asset updates are published to.

Type

google.cloud.asset_v1.types.FeedOutputConfig

condition

A condition which determines whether an asset update should be published. If specified, an asset will be returned only when the expression evaluates to true. When set, expression field in the Expr must be a valid [CEL expression] (https://github.com/google/cel-spec) on a TemporalAsset with name temporal_asset. Example: a Feed with expression (“temporal_asset.deleted == true”) will only publish Asset deletions. Other fields of Expr are optional.

See our user guide for detailed instructions.

Type

google.type.expr_pb2.Expr

relationship_types

A list of relationship types to output, for example: INSTANCE_TO_INSTANCEGROUP. This field should only be specified if content_type=RELATIONSHIP.

  • If specified: it outputs specified relationship updates on the [asset_names] or the [asset_types]. It returns an error if any of the [relationship_types] doesn’t belong to the supported relationship types of the [asset_names] or [asset_types], or any of the [asset_names] or the [asset_types] doesn’t belong to the source types of the [relationship_types].

  • Otherwise: it outputs the supported relationships of the types of [asset_names] and [asset_types] or returns an error if any of the [asset_names] or the [asset_types] has no replationship support. See Introduction to Cloud Asset Inventory for all supported asset types and relationship types.

Type

Sequence[str]

class google.cloud.asset_v1.types.FeedOutputConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Output configuration for asset feed destination. .. attribute:: pubsub_destination

Destination on Pub/Sub.

type

google.cloud.asset_v1.types.PubsubDestination

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

Bases: proto.message.Message

A Cloud Storage location. .. attribute:: uri

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

If the specified Cloud Storage object already exists and there is no hold, it will be overwritten with the exported result.

type

str

uri_prefix

The uri prefix of all generated Cloud Storage objects. 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. Example: “gs://bucket_name/object_name_prefix/compute.googleapis.com/Disk/0” is the first shard of output objects containing all compute.googleapis.com/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

class google.cloud.asset_v1.types.GcsOutputResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A Cloud Storage output result. .. attribute:: uris

List of uris of the Cloud Storage objects. Example: “gs://bucket_name/object_name”.

type

Sequence[str]

class google.cloud.asset_v1.types.GetFeedRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Get asset feed request. .. attribute:: name

Required. 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

type

str

class google.cloud.asset_v1.types.IamPolicyAnalysisOutputConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Output configuration for export IAM policy analysis destination.

gcs_destination

Destination on Cloud Storage.

Type

google.cloud.asset_v1.types.IamPolicyAnalysisOutputConfig.GcsDestination

bigquery_destination

Destination on BigQuery.

Type

google.cloud.asset_v1.types.IamPolicyAnalysisOutputConfig.BigQueryDestination

class BigQueryDestination(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A BigQuery destination. .. attribute:: dataset

Required. The BigQuery dataset in format “projects/projectId/datasets/datasetId”, to which the analysis results should be exported. If this dataset does not exist, the export call will return an INVALID_ARGUMENT error.

type

str

table_prefix

Required. The prefix of the BigQuery tables to which the analysis results will be written. Tables will be created based on this table_prefix if not exist:

  • <table_prefix>_analysis table will contain export operation’s metadata.

  • <table_prefix>_analysis_result will contain all the [IamPolicyAnalysisResult][google.cloud.asset.v1.IamPolicyAnalysisResult]. When [partition_key] is specified, both tables will be partitioned based on the [partition_key].

Type

str

partition_key

The partition key for BigQuery partitioned table.

Type

google.cloud.asset_v1.types.IamPolicyAnalysisOutputConfig.BigQueryDestination.PartitionKey

write_disposition

Optional. Specifies the action that occurs if the destination table or partition already exists. The following values are supported:

  • WRITE_TRUNCATE: If the table or partition already exists, BigQuery overwrites the entire table or all the partitions data.

  • WRITE_APPEND: If the table or partition already exists, BigQuery appends the data to the table or the latest partition.

  • WRITE_EMPTY: If the table already exists and contains data, an error is returned.

The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Details are at https://cloud.google.com/bigquery/docs/loading-data-local#appending_to_or_overwriting_a_table_using_a_local_file.

Type

str

class PartitionKey(value)[source]

Bases: proto.enums.Enum

This enum determines the partition key column for the bigquery tables. Partitioning can improve query performance and reduce query cost by filtering partitions. Refer to https://cloud.google.com/bigquery/docs/partitioned-tables for details.

PARTITION_KEY_UNSPECIFIED = 0
REQUEST_TIME = 1
class GcsDestination(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A Cloud Storage location. .. attribute:: uri

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

If the specified Cloud Storage object already exists and there is no hold, it will be overwritten with the analysis result.

type

str

class google.cloud.asset_v1.types.IamPolicyAnalysisQuery(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

## IAM policy analysis query message. .. attribute:: scope

Required. The relative name of the root asset. Only resources and IAM policies within the scope will be analyzed.

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

To know how to get organization id, visit here.

To know how to get folder or project id, visit here.

type

str

resource_selector

Optional. Specifies a resource for analysis.

Type

google.cloud.asset_v1.types.IamPolicyAnalysisQuery.ResourceSelector

identity_selector

Optional. Specifies an identity for analysis.

Type

google.cloud.asset_v1.types.IamPolicyAnalysisQuery.IdentitySelector

access_selector

Optional. Specifies roles or permissions for analysis. This is optional.

Type

google.cloud.asset_v1.types.IamPolicyAnalysisQuery.AccessSelector

options

Optional. The query options.

Type

google.cloud.asset_v1.types.IamPolicyAnalysisQuery.Options

condition_context

Optional. The hypothetical context for IAM conditions evaluation.

Type

google.cloud.asset_v1.types.IamPolicyAnalysisQuery.ConditionContext

class AccessSelector(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Specifies roles and/or permissions to analyze, to determine both the identities possessing them and the resources they control. If multiple values are specified, results will include roles or permissions matching any of them. The total number of roles and permissions should be equal or less than 10.

roles

Optional. The roles to appear in result.

Type

Sequence[str]

permissions

Optional. The permissions to appear in result.

Type

Sequence[str]

class ConditionContext(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The IAM conditions context. .. attribute:: access_time

The hypothetical access timestamp to evaluate IAM conditions. Note that this value must not be earlier than the current time; otherwise, an INVALID_ARGUMENT error will be returned.

type

google.protobuf.timestamp_pb2.Timestamp

class IdentitySelector(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Specifies an identity for which to determine resource access, based on roles assigned either directly to them or to the groups they belong to, directly or indirectly.

identity

Required. The identity appear in the form of members in IAM policy binding.

The examples of supported forms are: “user:mike@example.com”, “group:admins@example.com”, “domain:google.com”, “serviceAccount:my-project-id@appspot.gserviceaccount.com”.

Notice that wildcard characters (such as * and ?) are not supported. You must give a specific identity.

Type

str

class Options(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Contains query options. .. attribute:: expand_groups

Optional. If true, the identities section of the result will expand any Google groups appearing in an IAM policy binding.

If [IamPolicyAnalysisQuery.identity_selector][google.cloud.asset.v1.IamPolicyAnalysisQuery.identity_selector] is specified, the identity in the result will be determined by the selector, and this flag is not allowed to set.

Default is false.

type

bool

expand_roles

Optional. If true, the access section of result will expand any roles appearing in IAM policy bindings to include their permissions.

If [IamPolicyAnalysisQuery.access_selector][google.cloud.asset.v1.IamPolicyAnalysisQuery.access_selector] is specified, the access section of the result will be determined by the selector, and this flag is not allowed to set.

Default is false.

Type

bool

expand_resources

Optional. If true and [IamPolicyAnalysisQuery.resource_selector][google.cloud.asset.v1.IamPolicyAnalysisQuery.resource_selector] is not specified, the resource section of the result will expand any resource attached to an IAM policy to include resources lower in the resource hierarchy.

For example, if the request analyzes for which resources user A has permission P, and the results include an IAM policy with P on a GCP folder, the results will also include resources in that folder with permission P.

If true and [IamPolicyAnalysisQuery.resource_selector][google.cloud.asset.v1.IamPolicyAnalysisQuery.resource_selector] is specified, the resource section of the result will expand the specified resource to include resources lower in the resource hierarchy. Only project or lower resources are supported. Folder and organization resource cannot be used together with this option.

For example, if the request analyzes for which users have permission P on a GCP project with this option enabled, the results will include all users who have permission P on that project or any lower resource.

Default is false.

Type

bool

output_resource_edges

Optional. If true, the result will output resource edges, starting from the policy attached resource, to any expanded resources. Default is false.

Type

bool

output_group_edges

Optional. If true, the result will output group identity edges, starting from the binding’s group members, to any expanded identities. Default is false.

Type

bool

analyze_service_account_impersonation

Optional. If true, the response will include access analysis from identities to resources via service account impersonation. This is a very expensive operation, because many derived queries will be executed. We highly recommend you use [AssetService.AnalyzeIamPolicyLongrunning][google.cloud.asset.v1.AssetService.AnalyzeIamPolicyLongrunning] rpc instead.

For example, if the request analyzes for which resources user A has permission P, and there’s an IAM policy states user A has iam.serviceAccounts.getAccessToken permission to a service account SA, and there’s another IAM policy states service account SA has permission P to a GCP folder F, then user A potentially has access to the GCP folder F. And those advanced analysis results will be included in [AnalyzeIamPolicyResponse.service_account_impersonation_analysis][google.cloud.asset.v1.AnalyzeIamPolicyResponse.service_account_impersonation_analysis].

Another example, if the request analyzes for who has permission P to a GCP folder F, and there’s an IAM policy states user A has iam.serviceAccounts.actAs permission to a service account SA, and there’s another IAM policy states service account SA has permission P to the GCP folder F, then user A potentially has access to the GCP folder F. And those advanced analysis results will be included in [AnalyzeIamPolicyResponse.service_account_impersonation_analysis][google.cloud.asset.v1.AnalyzeIamPolicyResponse.service_account_impersonation_analysis].

Default is false.

Type

bool

class ResourceSelector(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Specifies the resource to analyze for access policies, which may be set directly on the resource, or on ancestors such as organizations, folders or projects.

full_resource_name

Required. The [full resource name] (https://cloud.google.com/asset-inventory/docs/resource-name-format) of a resource of supported resource types.

Type

str

class google.cloud.asset_v1.types.IamPolicyAnalysisResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

IAM Policy analysis result, consisting of one IAM policy binding and derived access control lists.

attached_resource_full_name

The full resource name of the resource to which the [iam_binding][google.cloud.asset.v1.IamPolicyAnalysisResult.iam_binding] policy attaches.

Type

str

iam_binding

The Cloud IAM policy binding under analysis.

Type

google.iam.v1.policy_pb2.Binding

access_control_lists

The access control lists derived from the [iam_binding][google.cloud.asset.v1.IamPolicyAnalysisResult.iam_binding] that match or potentially match resource and access selectors specified in the request.

Type

Sequence[google.cloud.asset_v1.types.IamPolicyAnalysisResult.AccessControlList]

identity_list

The identity list derived from members of the [iam_binding][google.cloud.asset.v1.IamPolicyAnalysisResult.iam_binding] that match or potentially match identity selector specified in the request.

Type

google.cloud.asset_v1.types.IamPolicyAnalysisResult.IdentityList

fully_explored

Represents whether all analyses on the [iam_binding][google.cloud.asset.v1.IamPolicyAnalysisResult.iam_binding] have successfully finished.

Type

bool

class Access(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

An IAM role or permission under analysis. .. attribute:: role

The role.

type

str

permission

The permission.

Type

str

analysis_state

The analysis state of this access.

Type

google.cloud.asset_v1.types.IamPolicyAnalysisState

class AccessControlList(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

An access control list, derived from the above IAM policy binding, which contains a set of resources and accesses. May include one item from each set to compose an access control entry.

NOTICE that there could be multiple access control lists for one IAM policy binding. The access control lists are created based on resource and access combinations.

For example, assume we have the following cases in one IAM policy binding:

  • Permission P1 and P2 apply to resource R1 and R2;

  • Permission P3 applies to resource R2 and R3;

This will result in the following access control lists:

  • AccessControlList 1: [R1, R2], [P1, P2]

  • AccessControlList 2: [R2, R3], [P3]

resources

The resources that match one of the following conditions:

  • The resource_selector, if it is specified in request;

  • Otherwise, resources reachable from the policy attached resource.

Type

Sequence[google.cloud.asset_v1.types.IamPolicyAnalysisResult.Resource]

accesses

The accesses that match one of the following conditions:

  • The access_selector, if it is specified in request;

  • Otherwise, access specifiers reachable from the policy binding’s role.

Type

Sequence[google.cloud.asset_v1.types.IamPolicyAnalysisResult.Access]

resource_edges

Resource edges of the graph starting from the policy attached resource to any descendant resources. The [Edge.source_node][google.cloud.asset.v1.IamPolicyAnalysisResult.Edge.source_node] contains the full resource name of a parent resource and [Edge.target_node][google.cloud.asset.v1.IamPolicyAnalysisResult.Edge.target_node] contains the full resource name of a child resource. This field is present only if the output_resource_edges option is enabled in request.

Type

Sequence[google.cloud.asset_v1.types.IamPolicyAnalysisResult.Edge]

condition_evaluation

Condition evaluation for this AccessControlList, if there is a condition defined in the above IAM policy binding.

Type

google.cloud.asset_v1.types.ConditionEvaluation

class Edge(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A directional edge. .. attribute:: source_node

The source node of the edge. For example, it could be a full resource name for a resource node or an email of an identity.

type

str

target_node

The target node of the edge. For example, it could be a full resource name for a resource node or an email of an identity.

Type

str

class Identity(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

An identity under analysis. .. attribute:: name

The identity name in any form of members appear in IAM policy binding, such as:

  • user:foo@google.com

  • group:group1@google.com

  • serviceAccount:s1@prj1.iam.gserviceaccount.com

  • projectOwner:some_project_id

  • domain:google.com

  • allUsers

  • etc.

type

str

analysis_state

The analysis state of this identity.

Type

google.cloud.asset_v1.types.IamPolicyAnalysisState

class IdentityList(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The identities and group edges. .. attribute:: identities

Only the identities that match one of the following conditions will be presented:

  • The identity_selector, if it is specified in request;

  • Otherwise, identities reachable from the policy binding’s members.

type

Sequence[google.cloud.asset_v1.types.IamPolicyAnalysisResult.Identity]

group_edges

Group identity edges of the graph starting from the binding’s group members to any node of the [identities][google.cloud.asset.v1.IamPolicyAnalysisResult.IdentityList.identities]. The [Edge.source_node][google.cloud.asset.v1.IamPolicyAnalysisResult.Edge.source_node] contains a group, such as group:parent@google.com. The [Edge.target_node][google.cloud.asset.v1.IamPolicyAnalysisResult.Edge.target_node] contains a member of the group, such as group:child@google.com or user:foo@google.com. This field is present only if the output_group_edges option is enabled in request.

Type

Sequence[google.cloud.asset_v1.types.IamPolicyAnalysisResult.Edge]

class Resource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A Google Cloud resource under analysis. .. attribute:: full_resource_name

The full resource name

type

str

analysis_state

The analysis state of this resource.

Type

google.cloud.asset_v1.types.IamPolicyAnalysisState

class google.cloud.asset_v1.types.IamPolicyAnalysisState(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents the detailed state of an entity under analysis, such as a resource, an identity or an access.

code

The Google standard error code that best describes the state. For example:

  • OK means the analysis on this entity has been successfully finished;

  • PERMISSION_DENIED means an access denied error is encountered;

  • DEADLINE_EXCEEDED means the analysis on this entity hasn’t been started in time;

Type

google.rpc.code_pb2.Code

cause

The human-readable description of the cause of failure.

Type

str

class google.cloud.asset_v1.types.IamPolicySearchResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A result of IAM Policy search, containing information of an IAM policy.

resource

The full resource name of the resource associated with this IAM policy. Example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1. See Cloud Asset Inventory Resource Name Format for more information.

To search against the resource:

  • use a field query. Example: resource:organizations/123

Type

str

asset_type

The type of the resource associated with this IAM policy. Example: compute.googleapis.com/Disk.

To search against the asset_type:

  • specify the asset_types field in your search request.

Type

str

project

The project that the associated GCP resource belongs to, in the form of projects/{PROJECT_NUMBER}. If an IAM policy is set on a resource (like VM instance, Cloud Storage bucket), the project field will indicate the project that contains the resource. If an IAM policy is set on a folder or orgnization, this field will be empty.

To search against the project:

  • specify the scope field as this project in your search request.

Type

str

folders

The folder(s) that the IAM policy belongs to, in the form of folders/{FOLDER_NUMBER}. This field is available when the IAM policy belongs to one or more folders.

To search against folders:

  • use a field query. Example: folders:(123 OR 456)

  • use a free text query. Example: 123

  • specify the scope field as this folder in your search request.

Type

Sequence[str]

organization

The organization that the IAM policy belongs to, in the form of organizations/{ORGANIZATION_NUMBER}. This field is available when the IAM policy belongs to an organization.

To search against organization:

  • use a field query. Example: organization:123

  • use a free text query. Example: 123

  • specify the scope field as this organization in your search request.

Type

str

policy

The IAM policy directly set on the given resource. Note that the original IAM policy can contain multiple bindings. This only contains the bindings that match the given query. For queries that don’t contain a constrain on policies (e.g., an empty query), this contains all the bindings.

To search against the policy bindings:

  • use a field query:

    • query by the policy contained members. Example: policy:amy@gmail.com

    • query by the policy contained roles. Example: policy:roles/compute.admin

    • query by the policy contained roles’ included permissions. Example: policy.role.permissions:compute.instances.create

Type

google.iam.v1.policy_pb2.Policy

explanation

Explanation about the IAM policy search result. It contains additional information to explain why the search result matches the query.

Type

google.cloud.asset_v1.types.IamPolicySearchResult.Explanation

class Explanation(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Explanation about the IAM policy search result. .. attribute:: matched_permissions

The map from roles to their included permissions that match the permission query (i.e., a query containing policy.role.permissions:). Example: if query policy.role.permissions:compute.disk.get matches a policy binding that contains owner role, the matched_permissions will be {"roles/owner": ["compute.disk.get"]}. The roles can also be found in the returned policy bindings. Note that the map is populated only for requests with permission queries.

type

Sequence[google.cloud.asset_v1.types.IamPolicySearchResult.Explanation.MatchedPermissionsEntry]

class MatchedPermissionsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class Permissions(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

IAM permissions .. attribute:: permissions

A list of permissions. A sample permission string: compute.disk.get.

type

Sequence[str]

class google.cloud.asset_v1.types.ListAssetsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

ListAssets request. .. attribute:: parent

Required. Name of the organization or project the assets belong to. Format: “organizations/[organization-number]” (such as “organizations/123”), “projects/[project-id]” (such as “projects/my-project-id”), or “projects/[project-number]” (such as “projects/12345”).

type

str

read_time

Timestamp to take an asset snapshot. This can only be set to a timestamp between the current time and the current time minus 35 days (inclusive). 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

google.protobuf.timestamp_pb2.Timestamp

asset_types

A list of asset types to take a snapshot for. For example: “compute.googleapis.com/Disk”.

Regular expression is also supported. For example:

  • “compute.googleapis.com.*” snapshots resources whose asset type starts with “compute.googleapis.com”.

  • “.*Instance” snapshots resources whose asset type ends with “Instance”.

  • “.*Instance.*” snapshots resources whose asset type contains “Instance”.

See RE2 for all supported regular expression syntax. If the regular expression does not match any supported asset type, an INVALID_ARGUMENT error will be returned.

If specified, only matching assets will be returned, otherwise, it will snapshot all asset types. 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

google.cloud.asset_v1.types.ContentType

page_size

The maximum number of assets to be returned in a single response. Default is 100, minimum is 1, and maximum is 1000.

Type

int

page_token

The next_page_token returned from the previous ListAssetsResponse, or unspecified for the first ListAssetsRequest. It is a continuation of a prior ListAssets call, and the API should return the next page of assets.

Type

str

relationship_types

A list of relationship types to output, for example: INSTANCE_TO_INSTANCEGROUP. This field should only be specified if content_type=RELATIONSHIP.

  • If specified: it snapshots specified relationships. It returns an error if any of the [relationship_types] doesn’t belong to the supported relationship types of the [asset_types] or if any of the [asset_types] doesn’t belong to the source types of the [relationship_types].

  • Otherwise: it snapshots the supported relationships for all [asset_types] or returns an error if any of the [asset_types] has no relationship support. An unspecified asset types field means all supported asset_types. See Introduction to Cloud Asset Inventory for all supported asset types and relationship types.

Type

Sequence[str]

class google.cloud.asset_v1.types.ListAssetsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

ListAssets response. .. attribute:: read_time

Time the snapshot was taken.

type

google.protobuf.timestamp_pb2.Timestamp

assets

Assets.

Type

Sequence[google.cloud.asset_v1.types.Asset]

next_page_token

Token to retrieve the next page of results. It expires 72 hours after the page token for the first page is generated. Set to empty if there are no remaining results.

Type

str

property raw_page
class google.cloud.asset_v1.types.ListFeedsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

List asset feeds request. .. attribute:: parent

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

type

str

class google.cloud.asset_v1.types.ListFeedsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

feeds

A list of feeds.

Type

Sequence[google.cloud.asset_v1.types.Feed]

class google.cloud.asset_v1.types.MoveAnalysis(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A message to group the analysis information. .. attribute:: display_name

The user friendly display name of the analysis. E.g. IAM, Organization Policy etc.

type

str

analysis

Analysis result of moving the target resource.

Type

google.cloud.asset_v1.types.MoveAnalysisResult

error

Description of error encountered when performing the analysis.

Type

google.rpc.status_pb2.Status

class google.cloud.asset_v1.types.MoveAnalysisResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

An analysis result including blockers and warnings. .. attribute:: blockers

Blocking information that would prevent the target resource from moving to the specified destination at runtime.

type

Sequence[google.cloud.asset_v1.types.MoveImpact]

warnings

Warning information indicating that moving the target resource to the specified destination might be unsafe. This can include important policy information and configuration changes, but will not block moves at runtime.

Type

Sequence[google.cloud.asset_v1.types.MoveImpact]

class google.cloud.asset_v1.types.MoveImpact(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A message to group impacts of moving the target resource. .. attribute:: detail

User friendly impact detail in a free form message.

type

str

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

Bases: proto.message.Message

Output configuration for export assets destination. .. attribute:: gcs_destination

Destination on Cloud Storage.

type

google.cloud.asset_v1.types.GcsDestination

bigquery_destination

Destination on BigQuery. The output table stores the fields in asset proto as columns in BigQuery.

Type

google.cloud.asset_v1.types.BigQueryDestination

class google.cloud.asset_v1.types.OutputResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Output result of export assets. .. attribute:: gcs_result

Export result on Cloud Storage.

type

google.cloud.asset_v1.types.GcsOutputResult

class google.cloud.asset_v1.types.PartitionSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Specifications of BigQuery partitioned table as export destination.

partition_key

The partition key for BigQuery partitioned table.

Type

google.cloud.asset_v1.types.PartitionSpec.PartitionKey

class PartitionKey(value)[source]

Bases: proto.enums.Enum

This enum is used to determine the partition key column when exporting assets to BigQuery partitioned table(s). Note that, if the partition key is a timestamp column, the actual partition is based on its date value (expressed in UTC. see details in https://cloud.google.com/bigquery/docs/partitioned-tables#date_timestamp_partitioned_tables).

PARTITION_KEY_UNSPECIFIED = 0
READ_TIME = 1
REQUEST_TIME = 2
class google.cloud.asset_v1.types.PubsubDestination(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A Pub/Sub destination. .. attribute:: topic

The name of the Pub/Sub topic to publish to. Example: projects/PROJECT_ID/topics/TOPIC_ID.

type

str

class google.cloud.asset_v1.types.RelatedAsset(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

An asset identify in Google Cloud which contains its name, type and ancestors. An asset can be any resource in the Google Cloud resource hierarchy, a resource outside the Google Cloud resource hierarchy (such as Google Kubernetes Engine clusters and objects), or a policy (e.g. Cloud IAM policy). See Supported asset types for more information.

asset

The full name of the asset. Example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1

See Resource names for more information.

Type

str

asset_type

The type of the asset. Example: compute.googleapis.com/Disk

See Supported asset types for more information.

Type

str

ancestors

The ancestors of an asset in Google Cloud resource hierarchy, represented as a list of relative resource names. An ancestry path starts with the closest ancestor in the hierarchy and ends at root.

Example: ["projects/123456789", "folders/5432", "organizations/1234"]

Type

Sequence[str]

class google.cloud.asset_v1.types.RelatedAssets(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The detailed related assets with the relationship_type. .. attribute:: relationship_attributes

The detailed relationship attributes.

type

google.cloud.asset_v1.types.RelationshipAttributes

assets

The peer resources of the relationship.

Type

Sequence[google.cloud.asset_v1.types.RelatedAsset]

class google.cloud.asset_v1.types.RelatedResource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The detailed related resource. .. attribute:: asset_type

The type of the asset. Example: compute.googleapis.com/Instance

type

str

full_resource_name

The full resource name of the related resource. Example: //compute.googleapis.com/projects/my_proj_123/zones/instance/instance123

Type

str

class google.cloud.asset_v1.types.RelatedResources(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The related resources of the primary resource. .. attribute:: related_resources

The detailed related resources of the primary resource.

type

Sequence[google.cloud.asset_v1.types.RelatedResource]

class google.cloud.asset_v1.types.RelationshipAttributes(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The relationship attributes which include type, source_resource_type, target_resource_type and action.

type_

The unique identifier of the relationship type. Example: INSTANCE_TO_INSTANCEGROUP

Type

str

source_resource_type

The source asset type. Example: compute.googleapis.com/Instance

Type

str

target_resource_type

The target asset type. Example: compute.googleapis.com/Disk

Type

str

action

The detail of the relationship, e.g. contains, attaches

Type

str

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

Bases: proto.message.Message

A representation of a Google Cloud resource. .. attribute:: version

The API version. Example: v1

type

str

discovery_document_uri

The URL of the discovery document containing the resource’s JSON schema. Example: https://www.googleapis.com/discovery/v1/apis/compute/v1/rest

This value is unspecified for resources that do not have an API based on a discovery document, such as Cloud Bigtable.

Type

str

discovery_name

The JSON schema name listed in the discovery document. Example: Project

This value is unspecified for resources that do not have an API based on a discovery document, such as Cloud Bigtable.

Type

str

resource_url

The REST URL for accessing the resource. An HTTP GET request using this URL returns the resource itself. Example: https://cloudresourcemanager.googleapis.com/v1/projects/my-project-123

This value is 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 Google Cloud assets, this value is the parent resource defined in the Cloud IAM policy hierarchy. Example: //cloudresourcemanager.googleapis.com/projects/my_project_123

For third-party assets, this field may be set differently.

Type

str

data

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

Type

google.protobuf.struct_pb2.Struct

location

The location of the resource in Google Cloud, such as its zone and region. For more information, see https://cloud.google.com/about/locations/.

Type

str

class google.cloud.asset_v1.types.ResourceSearchResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A result of Resource Search, containing information of a cloud resource.

name

The full resource name of this resource. Example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1. See Cloud Asset Inventory Resource Name Format for more information.

To search against the name:

  • use a field query. Example: name:instance1

  • use a free text query. Example: instance1

Type

str

asset_type

The type of this resource. Example: compute.googleapis.com/Disk.

To search against the asset_type:

  • specify the asset_type field in your search request.

Type

str

project

The project that this resource belongs to, in the form of projects/{PROJECT_NUMBER}. This field is available when the resource belongs to a project.

To search against project:

  • use a field query. Example: project:12345

  • use a free text query. Example: 12345

  • specify the scope field as this project in your search request.

Type

str

folders

The folder(s) that this resource belongs to, in the form of folders/{FOLDER_NUMBER}. This field is available when the resource belongs to one or more folders.

To search against folders:

  • use a field query. Example: folders:(123 OR 456)

  • use a free text query. Example: 123

  • specify the scope field as this folder in your search request.

Type

Sequence[str]

organization

The organization that this resource belongs to, in the form of organizations/{ORGANIZATION_NUMBER}. This field is available when the resource belongs to an organization.

To search against organization:

  • use a field query. Example: organization:123

  • use a free text query. Example: 123

  • specify the scope field as this organization in your search request.

Type

str

display_name

The display name of this resource. This field is available only when the resource’s proto contains it.

To search against the display_name:

  • use a field query. Example: displayName:"My Instance"

  • use a free text query. Example: "My Instance"

Type

str

description

One or more paragraphs of text description of this resource. Maximum length could be up to 1M bytes. This field is available only when the resource’s proto contains it.

To search against the description:

  • use a field query. Example: description:"important instance"

  • use a free text query. Example: "important instance"

Type

str

location

Location can be global, regional like us-east1, or zonal like us-west1-b. This field is available only when the resource’s proto contains it.

To search against the location:

  • use a field query. Example: location:us-west*

  • use a free text query. Example: us-west*

Type

str

labels

Labels associated with this resource. See Labelling and grouping GCP resources for more information. This field is available only when the resource’s proto contains it.

To search against the labels:

  • use a field query:

    • query on any label’s key or value. Example: labels:prod

    • query by a given label. Example: labels.env:prod

    • query by a given label’s existence. Example: labels.env:*

  • use a free text query. Example: prod

Type

Sequence[google.cloud.asset_v1.types.ResourceSearchResult.LabelsEntry]

network_tags

Network tags associated with this resource. Like labels, network tags are a type of annotations used to group GCP resources. See Labelling GCP resources for more information. This field is available only when the resource’s proto contains it.

To search against the network_tags:

  • use a field query. Example: networkTags:internal

  • use a free text query. Example: internal

Type

Sequence[str]

kms_key

The Cloud KMS CryptoKey name or CryptoKeyVersion name. This field is available only when the resource’s proto contains it.

To search against the kms_key:

  • use a field query. Example: kmsKey:key

  • use a free text query. Example: key

Type

str

create_time

The create timestamp of this resource, at which the resource was created. The granularity is in seconds. Timestamp.nanos will always be 0. This field is available only when the resource’s proto contains it.

To search against create_time:

  • use a field query.

    • value in seconds since unix epoch. Example: createTime > 1609459200

    • value in date string. Example: createTime > 2021-01-01

    • value in date-time string (must be quoted). Example: createTime > "2021-01-01T00:00:00"

Type

google.protobuf.timestamp_pb2.Timestamp

update_time

The last update timestamp of this resource, at which the resource was last modified or deleted. The granularity is in seconds. Timestamp.nanos will always be 0. This field is available only when the resource’s proto contains it.

To search against update_time:

  • use a field query.

    • value in seconds since unix epoch. Example: updateTime < 1609459200

    • value in date string. Example: updateTime < 2021-01-01

    • value in date-time string (must be quoted). Example: updateTime < "2021-01-01T00:00:00"

Type

google.protobuf.timestamp_pb2.Timestamp

state

The state of this resource. Different resources types have different state definitions that are mapped from various fields of different resource types. This field is available only when the resource’s proto contains it.

Example: If the resource is an instance provided by Compute Engine, its state will include PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. See status definition in API Reference. If the resource is a project provided by Cloud Resource Manager, its state will include LIFECYCLE_STATE_UNSPECIFIED, ACTIVE, DELETE_REQUESTED and DELETE_IN_PROGRESS. See lifecycleState definition in API Reference.

To search against the state:

  • use a field query. Example: state:RUNNING

  • use a free text query. Example: RUNNING

Type

str

additional_attributes

The additional searchable attributes of this resource. The attributes may vary from one resource type to another. Examples: projectId for Project, dnsName for DNS ManagedZone. This field contains a subset of the resource metadata fields that are returned by the List or Get APIs provided by the corresponding GCP service (e.g., Compute Engine). see API references and supported searchable attributes to see which fields are included.

You can search values of these fields through free text search. However, you should not consume the field programically as the field names and values may change as the GCP service updates to a new incompatible API version.

To search against the additional_attributes:

  • use a free text query to match the attributes values. Example: to search additional_attributes = { dnsName: "foobar" }, you can issue a query foobar.

Type

google.protobuf.struct_pb2.Struct

parent_full_resource_name

The full resource name of this resource’s parent, if it has one. To search against the parent_full_resource_name:

  • use a field query. Example: parentFullResourceName:"project-name"

  • use a free text query. Example: project-name

Type

str

versioned_resources

Versioned resource representations of this resource. This is repeated because there could be multiple versions of resource representations during version migration.

This versioned_resources field is not searchable. Some attributes of the resource representations are exposed in additional_attributes field, so as to allow users to search on them.

Type

Sequence[google.cloud.asset_v1.types.VersionedResource]

attached_resources

Attached resources of this resource. For example, an OSConfig Inventory is an attached resource of a Compute Instance. This field is repeated because a resource could have multiple attached resources.

This attached_resources field is not searchable. Some attributes of the attached resources are exposed in additional_attributes field, so as to allow users to search on them.

Type

Sequence[google.cloud.asset_v1.types.AttachedResource]

relationships

A map of related resources of this resource, keyed by the relationship type. A relationship type is in the format of {SourceType}*{ACTION}*{DestType}. Example: DISK_TO_INSTANCE, DISK_TO_NETWORK, INSTANCE_TO_INSTANCEGROUP. See supported relationship types.

Type

Sequence[google.cloud.asset_v1.types.ResourceSearchResult.RelationshipsEntry]

parent_asset_type

The type of this resource’s immediate parent, if there is one.

To search against the parent_asset_type:

  • use a field query. Example: parentAssetType:"cloudresourcemanager.googleapis.com/Project"

  • use a free text query. Example: cloudresourcemanager.googleapis.com/Project

Type

str

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class RelationshipsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.asset_v1.types.SearchAllIamPoliciesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Search all IAM policies request. .. attribute:: scope

Required. A scope can be a project, a folder, or an organization. The search is limited to the IAM policies within the scope. The caller must be granted the `cloudasset.assets.searchAllIamPolicies <https://cloud.google.com/asset-inventory/docs/access-control#required_permissions>`__ permission on the desired scope.

The allowed values are:

  • projects/{PROJECT_ID} (e.g., “projects/foo-bar”)

  • projects/{PROJECT_NUMBER} (e.g., “projects/12345678”)

  • folders/{FOLDER_NUMBER} (e.g., “folders/1234567”)

  • organizations/{ORGANIZATION_NUMBER} (e.g., “organizations/123456”)

type

str

query

Optional. The query statement. See how to construct a query for more information. If not specified or empty, it will search all the IAM policies within the specified scope. Note that the query string is compared against each Cloud IAM policy binding, including its members, roles, and Cloud IAM conditions. The returned Cloud IAM policies will only contain the bindings that match your query. To learn more about the IAM policy structure, see IAM policy doc.

Examples:

  • policy:amy@gmail.com to find IAM policy bindings that specify user “amy@gmail.com”.

  • policy:roles/compute.admin to find IAM policy bindings that specify the Compute Admin role.

  • policy:comp* to find IAM policy bindings that contain “comp” as a prefix of any word in the binding.

  • policy.role.permissions:storage.buckets.update to find IAM policy bindings that specify a role containing “storage.buckets.update” permission. Note that if callers don’t have iam.roles.get access to a role’s included permissions, policy bindings that specify this role will be dropped from the search results.

  • policy.role.permissions:upd* to find IAM policy bindings that specify a role containing “upd” as a prefix of any word in the role permission. Note that if callers don’t have iam.roles.get access to a role’s included permissions, policy bindings that specify this role will be dropped from the search results.

  • resource:organizations/123456 to find IAM policy bindings that are set on “organizations/123456”.

  • resource=//cloudresourcemanager.googleapis.com/projects/myproject to find IAM policy bindings that are set on the project named “myproject”.

  • Important to find IAM policy bindings that contain “Important” as a word in any of the searchable fields (except for the included permissions).

  • resource:(instance1 OR instance2) policy:amy to find IAM policy bindings that are set on resources “instance1” or “instance2” and also specify user “amy”.

  • roles:roles/compute.admin to find IAM policy bindings that specify the Compute Admin role.

  • memberTypes:user to find IAM policy bindings that contain the “user” member type.

Type

str

page_size

Optional. The page size for search result pagination. Page size is capped at 500 even if a larger value is given. If set to zero, server will pick an appropriate default. Returned results may be fewer than requested. When this happens, there could be more results as long as next_page_token is returned.

Type

int

page_token

Optional. If present, retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of all other method parameters must be identical to those in the previous call.

Type

str

asset_types

Optional. A list of asset types that the IAM policies are attached to. If empty, it will search the IAM policies that are attached to all the searchable asset types.

Regular expressions are also supported. For example:

  • “compute.googleapis.com.*” snapshots IAM policies attached to asset type starts with “compute.googleapis.com”.

  • “.*Instance” snapshots IAM policies attached to asset type ends with “Instance”.

  • “.*Instance.*” snapshots IAM policies attached to asset type contains “Instance”.

See RE2 for all supported regular expression syntax. If the regular expression does not match any supported asset type, an INVALID_ARGUMENT error will be returned.

Type

Sequence[str]

order_by

Optional. A comma-separated list of fields specifying the sorting order of the results. The default order is ascending. Add ” DESC” after the field name to indicate descending order. Redundant space characters are ignored. Example: “assetType DESC, resource”. Only singular primitive fields in the response are sortable:

  • resource

  • assetType

  • project All the other fields such as repeated fields (e.g., folders) and non-primitive fields (e.g., policy) are not supported.

Type

str

class google.cloud.asset_v1.types.SearchAllIamPoliciesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Search all IAM policies response. .. attribute:: results

A list of IamPolicy that match the search query. Related information such as the associated resource is returned along with the policy.

type

Sequence[google.cloud.asset_v1.types.IamPolicySearchResult]

next_page_token

Set if there are more results than those appearing in this response; to get the next set of results, call this method again, using this value as the page_token.

Type

str

property raw_page
class google.cloud.asset_v1.types.SearchAllResourcesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Search all resources request. .. attribute:: scope

Required. A scope can be a project, a folder, or an organization. The search is limited to the resources within the scope. The caller must be granted the `cloudasset.assets.searchAllResources <https://cloud.google.com/asset-inventory/docs/access-control#required_permissions>`__ permission on the desired scope.

The allowed values are:

  • projects/{PROJECT_ID} (e.g., “projects/foo-bar”)

  • projects/{PROJECT_NUMBER} (e.g., “projects/12345678”)

  • folders/{FOLDER_NUMBER} (e.g., “folders/1234567”)

  • organizations/{ORGANIZATION_NUMBER} (e.g., “organizations/123456”)

type

str

query

Optional. The query statement. See how to construct a query for more information. If not specified or empty, it will search all the resources within the specified scope.

Examples:

  • name:Important to find Cloud resources whose name contains “Important” as a word.

  • name=Important to find the Cloud resource whose name is exactly “Important”.

  • displayName:Impor* to find Cloud resources whose display name contains “Impor” as a prefix of any word in the field.

  • location:us-west* to find Cloud resources whose location contains both “us” and “west” as prefixes.

  • labels:prod to find Cloud resources whose labels contain “prod” as a key or value.

  • labels.env:prod to find Cloud resources that have a label “env” and its value is “prod”.

  • labels.env:* to find Cloud resources that have a label “env”.

  • kmsKey:key to find Cloud resources encrypted with a customer-managed encryption key whose name contains the word “key”.

  • state:ACTIVE to find Cloud resources whose state contains “ACTIVE” as a word.

  • NOT state:ACTIVE to find Cloud resources whose state doesn’t contain “ACTIVE” as a word.

  • createTime<1609459200 to find Cloud resources that were created before “2021-01-01 00:00:00 UTC”. 1609459200 is the epoch timestamp of “2021-01-01 00:00:00 UTC” in seconds.

  • updateTime>1609459200 to find Cloud resources that were updated after “2021-01-01 00:00:00 UTC”. 1609459200 is the epoch timestamp of “2021-01-01 00:00:00 UTC” in seconds.

  • Important to find Cloud resources that contain “Important” as a word in any of the searchable fields.

  • Impor* to find Cloud resources that contain “Impor” as a prefix of any word in any of the searchable fields.

  • Important location:(us-west1 OR global) to find Cloud resources that contain “Important” as a word in any of the searchable fields and are also located in the “us-west1” region or the “global” location.

Type

str

asset_types

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

Regular expressions are also supported. For example:

  • “compute.googleapis.com.*” snapshots resources whose asset type starts with “compute.googleapis.com”.

  • “.*Instance” snapshots resources whose asset type ends with “Instance”.

  • “.*Instance.*” snapshots resources whose asset type contains “Instance”.

See RE2 for all supported regular expression syntax. If the regular expression does not match any supported asset type, an INVALID_ARGUMENT error will be returned.

Type

Sequence[str]

page_size

Optional. The page size for search result pagination. Page size is capped at 500 even if a larger value is given. If set to zero, server will pick an appropriate default. Returned results may be fewer than requested. When this happens, there could be more results as long as next_page_token is returned.

Type

int

page_token

Optional. If present, then retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of all other method parameters, must be identical to those in the previous call.

Type

str

order_by

Optional. A comma-separated list of fields specifying the sorting order of the results. The default order is ascending. Add ” DESC” after the field name to indicate descending order. Redundant space characters are ignored. Example: “location DESC, name”. Only singular primitive fields in the response are sortable:

  • name

  • assetType

  • project

  • displayName

  • description

  • location

  • kmsKey

  • createTime

  • updateTime

  • state

  • parentFullResourceName

  • parentAssetType

All the other fields such as repeated fields (e.g., networkTags), map fields (e.g., labels) and struct fields (e.g., additionalAttributes) are not supported.

Type

str

read_mask

Optional. A comma-separated list of fields specifying which fields to be returned in ResourceSearchResult. Only ‘*’ or combination of top level fields can be specified. Field names of both snake_case and camelCase are supported. Examples: "*", "name,location", "name,versionedResources".

The read_mask paths must be valid field paths listed but not limited to (both snake_case and camelCase are supported):

  • name

  • assetType

  • project

  • displayName

  • description

  • location

  • labels

  • networkTags

  • kmsKey

  • createTime

  • updateTime

  • state

  • additionalAttributes

  • versionedResources

If read_mask is not specified, all fields except versionedResources will be returned. If only ‘*’ is specified, all fields including versionedResources will be returned. Any invalid field path will trigger INVALID_ARGUMENT error.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.asset_v1.types.SearchAllResourcesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Search all resources response. .. attribute:: results

A list of Resources that match the search query. It contains the resource standard metadata information.

type

Sequence[google.cloud.asset_v1.types.ResourceSearchResult]

next_page_token

If there are more results than those appearing in this response, then next_page_token is included. To get the next set of results, call this method again using the value of next_page_token as page_token.

Type

str

property raw_page
class google.cloud.asset_v1.types.TemporalAsset(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

An asset in Google Cloud and its temporal metadata, including the time window when it was observed and its status during that window.

window

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

Type

google.cloud.asset_v1.types.TimeWindow

deleted

Whether the asset has been deleted or not.

Type

bool

asset

An asset in Google Cloud.

Type

google.cloud.asset_v1.types.Asset

prior_asset_state

State of prior_asset.

Type

google.cloud.asset_v1.types.TemporalAsset.PriorAssetState

prior_asset

Prior copy of the asset. Populated if prior_asset_state is PRESENT. Currently this is only set for responses in Real-Time Feed.

Type

google.cloud.asset_v1.types.Asset

class PriorAssetState(value)[source]

Bases: proto.enums.Enum

State of prior asset.

DELETED = 4
DOES_NOT_EXIST = 3
INVALID = 2
PRESENT = 1
PRIOR_ASSET_STATE_UNSPECIFIED = 0
class google.cloud.asset_v1.types.TimeWindow(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A time window specified by its start_time and end_time. .. attribute:: start_time

Start time of the time window (exclusive).

type

google.protobuf.timestamp_pb2.Timestamp

end_time

End time of the time window (inclusive). If not specified, the current timestamp is used instead.

Type

google.protobuf.timestamp_pb2.Timestamp

class google.cloud.asset_v1.types.UpdateFeedRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Update asset feed request. .. attribute:: feed

Required. 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.

type

google.cloud.asset_v1.types.Feed

update_mask

Required. 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.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.asset_v1.types.VersionedResource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Resource representation as defined by the corresponding service providing the resource for a given API version.

version

API version of the resource.

Example: If the resource is an instance provided by Compute Engine v1 API as defined in https://cloud.google.com/compute/docs/reference/rest/v1/instances, version will be “v1”.

Type

str

resource

JSON representation of the resource as defined by the corresponding service providing this resource.

Example: If the resource is an instance provided by Compute Engine, this field will contain the JSON representation of the instance as defined by Compute Engine: https://cloud.google.com/compute/docs/reference/rest/v1/instances.

You can find the resource definition for each supported resource type in this table: https://cloud.google.com/asset-inventory/docs/supported-asset-types#searchable_asset_types

Type

google.protobuf.struct_pb2.Struct