Package google.cloud.asset.v1

Index

AssetService

Asset service definition.

BatchGetAssetsHistory

rpc BatchGetAssetsHistory(BatchGetAssetsHistoryRequest) returns (BatchGetAssetsHistoryResponse)

Batch gets the update history of assets that overlap a time window. 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. Otherwise, this API outputs history with asset in both non-delete or deleted status. If a specified asset does not exist, this API returns an INVALID_ARGUMENT error.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

ExportAssets

rpc ExportAssets(ExportAssetsRequest) returns (Operation)

Exports assets with time and resource types to a given Cloud Storage location/BigQuery table. For Cloud Storage location destinations, the output format is newline-delimited JSON. Each line represents a google.cloud.asset.v1.Asset in the JSON format; for BigQuery table destinations, the output table stores the fields in asset Protobuf as columns. This API implements the google.longrunning.Operation API, which allows you to keep track of the export. We recommend intervals of at least 2 seconds with exponential retry to poll the export operation result. For regular-size resource parent, the export operation usually finishes within 5 minutes.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

ListAssets

rpc ListAssets(ListAssetsRequest) returns (ListAssetsResponse)

Lists assets with time and resource types and returns paged results in response.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

SearchAllIamPolicies

rpc SearchAllIamPolicies(SearchAllIamPoliciesRequest) returns (SearchAllIamPoliciesResponse)

Searches all IAM policies within the specified scope, such as a project, folder, or organization. The caller must be granted the cloudasset.assets.searchAllIamPolicies permission on the desired scope, otherwise the request will be rejected.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

SearchAllResources

rpc SearchAllResources(SearchAllResourcesRequest) returns (SearchAllResourcesResponse)

Searches all Cloud de Confiance resources within the specified scope, such as a project, folder, or organization. The caller must be granted the cloudasset.assets.searchAllResources permission on the desired scope, otherwise the request will be rejected.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

Asset

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

Fields
update_time

Timestamp

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

name

string

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

See Resource names for more information.

asset_type

string

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

See Supported asset types for more information.

resource

Resource

A representation of the resource.

iam_policy

Policy

A representation of the IAM policy set on a Cloud de Confiance resource. There can be a maximum of one IAM policy set on any given resource. In addition, 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.

org_policy[]

Policy

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

os_inventory

Inventory

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

related_assets
(deprecated)

RelatedAssets

DEPRECATED. This field only presents for the purpose of backward-compatibility. The server will never generate responses with this field. The related assets of the asset of one relationship type. One asset only represents one type of relationship.

related_asset

RelatedAsset

One related asset of the current asset.

ancestors[]

string

The ancestry path of an asset in Cloud de Confiance 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"]

asset_exceptions[]

AssetException

The exceptions of a resource.

Union field access_context_policy. A representation of an access policy. access_context_policy can be only one of the following:
access_policy

AccessPolicy

Also refer to the access policy user guide.

access_level

AccessLevel

Also refer to the access level user guide.

service_perimeter

ServicePerimeter

Also refer to the service perimeter user guide.

AssetEnrichment

The enhanced metadata information for a resource.

Fields

Union field EnrichmentData.

EnrichmentData can be only one of the following:

resource_owners

ResourceOwners

The resource owners for a resource.

Note that this field only contains the members that have "roles/owner" role in the resource's IAM Policy.

AssetException

An exception of an asset.

Fields
exception_type

ExceptionType

The type of exception.

details

string

The details of the exception.

ExceptionType

The type of exception.

Enums
EXCEPTION_TYPE_UNSPECIFIED exception_type is not applicable for the current asset.
TRUNCATION The asset content is truncated.

AttachedResource

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

Fields
asset_type

string

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://documentation.s3ns.fr/asset-inventory/docs/supported-asset-types

versioned_resources[]

VersionedResource

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

BatchGetAssetsHistoryRequest

Batch get assets history request.

Fields
parent

string

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

Authorization requires one or more of the following IAM permissions on the specified resource parent:

  • cloudasset.assets.exportResource
  • cloudasset.assets.exportIamPolicy
asset_names[]

string

A list of the full names of the assets. See: https://documentation.s3ns.fr/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.

content_type

ContentType

Optional. The content type.

read_time_window

TimeWindow

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.

relationship_types[]

string

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.

BatchGetAssetsHistoryResponse

Batch get assets history response.

Fields
assets[]

TemporalAsset

A list of assets with valid time windows.

BigQueryDestination

A BigQuery destination for exporting assets to.

Fields
dataset

string

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. Setting the contentType for exportAssets determines the schema of the BigQuery table. Setting separateTablesPerAssetType to TRUE also influences the schema.

table

string

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.

force

bool

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_ARGUMENT error.

partition_spec

PartitionSpec

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

separate_tables_per_asset_type

bool

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://documentation.s3ns.fr/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://documentation.s3ns.fr/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.

ContentType

Asset content type.

Enums
CONTENT_TYPE_UNSPECIFIED Unspecified content type.
RESOURCE Resource metadata.
IAM_POLICY The actual IAM policy set on a resource.
ORG_POLICY The organization policy set on an asset.
ACCESS_POLICY The Access Context Manager policy set on an asset.
OS_INVENTORY The runtime OS Inventory information.
RELATIONSHIP The related resources.

EffectiveTagDetails

The effective tags and the ancestor resources from which they were inherited.

Fields
effective_tags[]

Tag

The effective tags inherited from the attached_resource. Note that tags with the same key but different values may attach to resources at a different hierarchy levels. The lower hierarchy tag value will overwrite the higher hierarchy tag value of the same tag key. In this case, the tag value at the higher hierarchy level will be removed. For more information, see tag inheritance.

attached_resource

string

The full resource name of the ancestor from which effective_tags are inherited, according to tag inheritance.

ExportAssetsRequest

Export asset request.

Fields
parent

string

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

Authorization requires one or more of the following IAM permissions on the specified resource parent:

  • cloudasset.assets.exportResource
  • cloudasset.assets.exportIamPolicy
read_time

Timestamp

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.

asset_types[]

string

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.

content_type

ContentType

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

output_config

OutputConfig

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

relationship_types[]

string

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.

ExportAssetsResponse

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

Fields
read_time

Timestamp

Time the snapshot was taken.

output_config

OutputConfig

Output configuration indicating where the results were output to.

output_result

OutputResult

Output result indicating where the assets were exported to. For example, a set of actual 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 Cloud Storage object limit.

GcsDestination

A Cloud Storage location.

Fields
Union field object_uri. Required. object_uri can be only one of the following:
uri

string

The URI of the Cloud Storage object. It's the same URI that is used by gcloud storage. 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.

uri_prefix

string

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.

GcsOutputResult

A Cloud Storage output result.

Fields
uris[]

string

List of URIs of the Cloud Storage objects. Example: "gs://bucket_name/object_name".

IamPolicySearchResult

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

Fields
resource

string

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
asset_type

string

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

string

The project that the associated Cloud de Confiance 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 organization, this field will be empty.

To search against the project:

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

string

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

string

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

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
explanation

Explanation

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

Explanation

Explanation about the IAM policy search result.

Fields
matched_permissions

map<string, 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.

Permissions

IAM permissions

Fields
permissions[]

string

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

ListAssetsRequest

ListAssets request.

Fields
parent

string

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

Authorization requires one or more of the following IAM permissions on the specified resource parent:

  • cloudasset.assets.listResource
  • cloudasset.assets.listIamPolicy
  • cloudasset.assets.listOrgPolicy
  • cloudasset.assets.listAccessPolicy
  • cloudasset.assets.listOSInventories
read_time

Timestamp

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.

asset_types[]

string

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.

content_type

ContentType

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

page_size

int32

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

page_token

string

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.

relationship_types[]

string

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.

ListAssetsResponse

ListAssets response.

Fields
read_time

Timestamp

Time the snapshot was taken.

assets[]

Asset

Assets.

next_page_token

string

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.

OutputConfig

Output configuration for export assets destination.

Fields
Union field destination. Asset export destination. destination can be only one of the following:
gcs_destination

GcsDestination

Destination on Cloud Storage.

bigquery_destination

BigQueryDestination

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

OutputResult

Output result of export assets.

Fields
Union field result. Asset export result. result can be only one of the following:
gcs_result

GcsOutputResult

Export result on Cloud Storage.

PartitionSpec

Specifications of BigQuery partitioned table as export destination.

Fields
partition_key

PartitionKey

The partition key for BigQuery partitioned table.

PartitionKey

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://documentation.s3ns.fr/bigquery/docs/partitioned-tables#date_timestamp_partitioned_tables).

Enums
PARTITION_KEY_UNSPECIFIED Unspecified partition key. If used, it means using non-partitioned table.
READ_TIME The time when the snapshot is taken. If specified as partition key, the result table(s) is partitioned by the additional timestamp column, readTime. If [read_time] in ExportAssetsRequest is specified, the readTime column's value will be the same as it. Otherwise, its value will be the current time that is used to take the snapshot.
REQUEST_TIME The time when the request is received and started to be processed. If specified as partition key, the result table(s) is partitioned by the requestTime column, an additional timestamp column representing when the request was received.

RelatedAsset

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

Fields
asset

string

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

See Resource names for more information.

asset_type

string

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

See Supported asset types for more information.

ancestors[]

string

The ancestors of an asset in Cloud de Confiance 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"]

relationship_type

string

The unique identifier of the relationship type. Example: INSTANCE_TO_INSTANCEGROUP

RelatedAssets

DEPRECATED. This message only presents for the purpose of backward-compatibility. The server will never populate this message in responses. The detailed related assets with the relationship_type.

Fields
relationship_attributes

RelationshipAttributes

The detailed relationship attributes.

assets[]

RelatedAsset

The peer resources of the relationship.

RelatedResource

The detailed related resource.

Fields
asset_type

string

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

full_resource_name

string

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

RelatedResources

The related resources of the primary resource.

Fields
related_resources[]

RelatedResource

The detailed related resources of the primary resource.

RelationshipAttributes

DEPRECATED. This message only presents for the purpose of backward-compatibility. The server will never populate this message in responses. The relationship attributes which include type, source_resource_type, target_resource_type and action.

Fields
type

string

The unique identifier of the relationship type. Example: INSTANCE_TO_INSTANCEGROUP

source_resource_type

string

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

target_resource_type

string

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

action

string

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

Resource

A representation of a Cloud de Confiance resource.

Fields
version

string

The API version. Example: v1

discovery_document_uri

string

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.

discovery_name

string

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.

resource_url

string

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.

parent

string

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

For Cloud de Confiance assets, this value is the parent resource defined in the IAM policy hierarchy. Example: //cloudresourcemanager.googleapis.com/projects/my_project_123

data

Struct

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

location

string

The location of the resource in Cloud de Confiance, such as its zone and region. For more information, see https://documentation.s3ns.fr/about/locations/.

ResourceOwners

The resource owners information.

Fields
resource_owners[]

string

List of resource owners.

ResourceSearchResult

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

Fields
name

string

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
asset_type

string

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

string

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.
folders[]

string

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

string

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

string

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

To search against the display_name:

  • Use a field query. Example: displayName:"My Instance"
  • Use a free text query. Example: "My Instance"
description

string

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 Protobuf contains it.

To search against the description:

  • Use a field query. Example: description:"important instance"
  • Use a free text query. Example: "important instance"
location

string

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

To search against the location:

  • Use a field query. Example: location:us-west*
  • Use a free text query. Example: us-west*
labels

map<string, string>

User labels associated with this resource. See Labelling and grouping Cloud de Confiance resources for more information. This field is available only when the resource's Protobuf 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
network_tags[]

string

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

To search against the network_tags:

  • Use a field query. Example: networkTags:internal
  • Use a free text query. Example: internal
kms_key
(deprecated)

string

The Cloud KMS CryptoKey name or CryptoKeyVersion name.

This field only presents for the purpose of backward compatibility. Use the kms_keys field to retrieve Cloud KMS key information. This field is available only when the resource's Protobuf contains it and will only be populated for these resource types for backward compatible purposes.

To search against the kms_key:

  • Use a field query. Example: kmsKey:key
  • Use a free text query. Example: key
kms_keys[]

string

The Cloud KMS CryptoKey names or CryptoKeyVersion names. This field is available only when the resource's Protobuf contains it.

To search against the kms_keys:

  • Use a field query. Example: kmsKeys:key
  • Use a free text query. Example: key
create_time

Timestamp

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 Protobuf 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"
update_time

Timestamp

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 Protobuf 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"
state

string

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 Protobuf 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 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
additional_attributes

Struct

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 Cloud de Confiance 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 Cloud de Confiance 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.
parent_full_resource_name

string

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
versioned_resources[]

VersionedResource

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.

attached_resources[]

AttachedResource

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.

relationships

map<string, RelatedResources>

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.

tag_keys[]
(deprecated)

string

This field is only present for the purpose of backward compatibility. Use the tags field instead.

TagKey namespaced names, in the format of {ORG_ID}/{TAG_KEY_SHORT_NAME}. To search against the tagKeys:

  • Use a field query. Example:

    • tagKeys:"123456789/env*"
    • tagKeys="123456789/env"
    • tagKeys:"env"
  • Use a free text query. Example:

    • env
tag_values[]
(deprecated)

string

This field is only present for the purpose of backward compatibility. Use the tags field instead.

TagValue namespaced names, in the format of {ORG_ID}/{TAG_KEY_SHORT_NAME}/{TAG_VALUE_SHORT_NAME}. To search against the tagValues:

  • Use a field query. Example:

    • tagValues:"env"
    • tagValues:"env/prod"
    • tagValues:"123456789/env/prod*"
    • tagValues="123456789/env/prod"
  • Use a free text query. Example:

    • prod
tag_value_ids[]
(deprecated)

string

This field is only present for the purpose of backward compatibility. Use the tags field instead.

TagValue IDs, in the format of tagValues/{TAG_VALUE_ID}. To search against the tagValueIds:

  • Use a field query. Example:

    • tagValueIds="tagValues/456"
  • Use a free text query. Example:

    • 456
tags[]

Tag

The tags directly attached to this resource.

To search against the tags:

  • Use a field query. Example:

    • tagKeys:"123456789/env*"
    • tagKeys="123456789/env"
    • tagKeys:"env"
    • tagKeyIds="tagKeys/123"
    • tagValues:"env"
    • tagValues:"env/prod"
    • tagValues:"123456789/env/prod*"
    • tagValues="123456789/env/prod"
    • tagValueIds="tagValues/456"
  • Use a free text query. Example:

    • env/prod
effective_tags[]

EffectiveTagDetails

The effective tags on this resource. All of the tags that are both attached to and inherited by a resource are collectively called the effective tags. For more information, see tag inheritance.

To search against the effective_tags:

  • Use a field query. Example:
  • effectiveTagKeys:"123456789/env*"
  • effectiveTagKeys="123456789/env"
  • effectiveTagKeys:"env"
  • effectiveTagKeyIds="tagKeys/123"
  • effectiveTagValues:"env"
  • effectiveTagValues:"env/prod"
  • effectiveTagValues:"123456789/env/prod*"
  • effectiveTagValues="123456789/env/prod"
  • effectiveTagValueIds="tagValues/456"
enrichments[]

AssetEnrichment

Enrichments of the asset. Currently supported enrichment types with SearchAllResources API:

  • RESOURCE_OWNERS

The corresponding read masks in order to get the enrichment:

  • enrichments.resource_owners

The corresponding required permissions:

  • cloudasset.assets.searchEnrichmentResourceOwners

Example query to get resource owner enrichment:

  scope: "projects/my-project"
  query: "name: my-project"
  assetTypes: "cloudresourcemanager.googleapis.com/Project"
  readMask: {
     paths: "asset_type"
     paths: "name"
     paths: "enrichments.resource_owners"
  }
parent_asset_type

string

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
scc_security_marks

map<string, string>

The actual content of Security Command Center security marks associated with the asset.

To search against SCC SecurityMarks field:

  • Use a field query:
    • query by a given key value pair. Example: sccSecurityMarks.foo=bar
    • query by a given key's existence. Example: sccSecurityMarks.foo:*

SearchAllIamPoliciesRequest

Search all IAM policies request.

Fields
scope

string

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 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")

Authorization requires the following IAM permission on the specified resource scope:

  • cloudasset.assets.searchAllIamPolicies
query

string

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 IAM policy binding, including its principals, roles, and IAM conditions. The returned IAM policies will only contain the bindings that match your query. To learn more about the IAM policy structure, see the IAM policy documentation.

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 principal type "user".
page_size

int32

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 or a negative value, 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.

page_token

string

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.

asset_types[]

string

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 asset types supported by search APIs

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.

order_by

string

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.

SearchAllIamPoliciesResponse

Search all IAM policies response.

Fields
results[]

IamPolicySearchResult

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

next_page_token

string

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.

SearchAllResourcesRequest

Search all resources request.

Fields
scope

string

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 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")

Authorization requires the following IAM permission on the specified resource scope:

  • cloudasset.assets.searchAllResources
query

string

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 de Confiance resources whose name contains Important as a word.
  • name=Important to find the Cloud de Confiance resource whose name is exactly Important.
  • displayName:Impor* to find Cloud de Confiance resources whose display name contains Impor as a prefix of any word in the field.
  • location:us-west* to find Cloud de Confiance resources whose location contains both us and west as prefixes.
  • labels:prod to find Cloud de Confiance resources whose labels contain prod as a key or value.
  • labels.env:prod to find Cloud de Confiance resources that have a label env and its value is prod.
  • labels.env:* to find Cloud de Confiance resources that have a label env.
  • tagKeys:env to find Cloud de Confiance resources that have directly attached tags where the TagKey.namespacedName contains env.
  • tagValues:prod* to find Cloud de Confiance resources that have directly attached tags where the TagValue.namespacedName contains a word prefixed by prod.
  • tagValueIds=tagValues/123 to find Cloud de Confiance resources that have directly attached tags where the TagValue.name is exactly tagValues/123.
  • effectiveTagKeys:env to find Cloud de Confiance resources that have directly attached or inherited tags where the TagKey.namespacedName contains env.
  • effectiveTagValues:prod* to find Cloud de Confiance resources that have directly attached or inherited tags where the TagValue.namespacedName contains a word prefixed by prod.
  • effectiveTagValueIds=tagValues/123 to find Cloud de Confiance resources that have directly attached or inherited tags where the TagValue.name is exactly tagValues/123.
  • kmsKey:key to find Cloud de Confiance resources encrypted with a customer-managed encryption key whose name contains key as a word. This field is deprecated. Use the kmsKeys field to retrieve Cloud KMS key information.
  • kmsKeys:key to find Cloud de Confiance resources encrypted with customer-managed encryption keys whose name contains the word key.
  • relationships:instance-group-1 to find Cloud de Confiance resources that have relationships with instance-group-1 in the related resource name.
  • relationships:INSTANCE_TO_INSTANCEGROUP to find Compute Engine instances that have relationships of type INSTANCE_TO_INSTANCEGROUP.
  • relationships.INSTANCE_TO_INSTANCEGROUP:instance-group-1 to find Compute Engine instances that have relationships with instance-group-1 in the Compute Engine instance group resource name, for relationship type INSTANCE_TO_INSTANCEGROUP.
  • sccSecurityMarks.key=value to find Cloud resources that are attached with security marks whose key is key and value is value.
  • sccSecurityMarks.key:* to find Cloud resources that are attached with security marks whose key is key.
  • state:ACTIVE to find Cloud de Confiance resources whose state contains ACTIVE as a word.
  • NOT state:ACTIVE to find Cloud de Confiance resources whose state doesn't contain ACTIVE as a word.
  • createTime<1609459200 to find Cloud de Confiance 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 de Confiance 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 de Confiance resources that contain Important as a word in any of the searchable fields.
  • Impor* to find Cloud de Confiance 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 de Confiance 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.
asset_types[]

string

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

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.

page_size

int32

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 or a negative value, 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.

page_token

string

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.

order_by

string

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 the following fields in the response are sortable:

  • name
  • assetType
  • project
  • displayName
  • description
  • location
  • createTime
  • updateTime
  • state
  • parentFullResourceName
  • parentAssetType
read_mask

FieldMask

Optional. A comma-separated list of fields that you want returned in the results. The following fields are returned by default if not specified:

  • name
  • assetType
  • project
  • folders
  • organization
  • displayName
  • description
  • location
  • labels
  • tags
  • effectiveTags
  • networkTags
  • kmsKeys
  • createTime
  • updateTime
  • state
  • additionalAttributes
  • parentFullResourceName
  • parentAssetType

Some fields of large size, such as versionedResources, attachedResources, effectiveTags etc., are not returned by default, but you can specify them in the read_mask parameter if you want to include them. If "*" is specified, all available fields are returned. Examples: "name,location", "name,versionedResources", "*". Any invalid field path will trigger INVALID_ARGUMENT error.

SearchAllResourcesResponse

Search all resources response.

Fields
results[]

ResourceSearchResult

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

next_page_token

string

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.

Tag

The key and value for a tag.

Fields
tag_key

string

TagKey namespaced name, in the format of {ORG_ID}/{TAG_KEY_SHORT_NAME}.

tag_key_id

string

TagKey ID, in the format of tagKeys/{TAG_KEY_ID}.

tag_value

string

TagValue namespaced name, in the format of {ORG_ID}/{TAG_KEY_SHORT_NAME}/{TAG_VALUE_SHORT_NAME}.

tag_value_id

string

TagValue ID, in the format of tagValues/{TAG_VALUE_ID}.

TemporalAsset

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

Fields
window

TimeWindow

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

deleted

bool

Whether the asset has been deleted or not.

asset

Asset

An asset in Cloud de Confiance.

prior_asset_state

PriorAssetState

State of prior_asset.

prior_asset

Asset

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

PriorAssetState

State of prior asset.

Enums
PRIOR_ASSET_STATE_UNSPECIFIED prior_asset is not applicable for the current asset.
PRESENT prior_asset is populated correctly.
INVALID Failed to set prior_asset.
DOES_NOT_EXIST Current asset is the first known state.
DELETED prior_asset is a deletion.

TimeWindow

A time window specified by its start_time and end_time.

Fields
start_time

Timestamp

Start time of the time window (exclusive).

end_time

Timestamp

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

VersionedResource

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

Fields
version

string

API version of the resource.

Example: If the resource is an instance provided by Compute Engine v1 API as defined in https://documentation.s3ns.fr/compute/docs/reference/rest/v1/instances, version will be "v1".

resource

Struct

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://documentation.s3ns.fr/compute/docs/reference/rest/v1/instances.

You can find the resource definition for each supported resource type in this table: https://documentation.s3ns.fr/asset-inventory/docs/supported-asset-types

asset_exceptions[]

AssetException

The exceptions of a resource.