Index
AssetService(interface)Asset(message)AssetEnrichment(message)AssetException(message)AssetException.ExceptionType(enum)AttachedResource(message)BatchGetAssetsHistoryRequest(message)BatchGetAssetsHistoryResponse(message)BigQueryDestination(message)ContentType(enum)EffectiveTagDetails(message)ExportAssetsRequest(message)ExportAssetsResponse(message)GcsDestination(message)GcsOutputResult(message)IamPolicySearchResult(message)IamPolicySearchResult.Explanation(message)IamPolicySearchResult.Explanation.Permissions(message)ListAssetsRequest(message)ListAssetsResponse(message)OutputConfig(message)OutputResult(message)PartitionSpec(message)PartitionSpec.PartitionKey(enum)RelatedAsset(message)RelatedAssets(message) (deprecated)RelatedResource(message)RelatedResources(message)RelationshipAttributes(message) (deprecated)Resource(message)ResourceOwners(message)ResourceSearchResult(message)SearchAllIamPoliciesRequest(message)SearchAllIamPoliciesResponse(message)SearchAllResourcesRequest(message)SearchAllResourcesResponse(message)Tag(message)TemporalAsset(message)TemporalAsset.PriorAssetState(enum)TimeWindow(message)VersionedResource(message)
AssetService
Asset service definition.
| BatchGetAssetsHistory |
|---|
|
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.
|
| ExportAssets |
|---|
|
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
|
| ListAssets |
|---|
|
Lists assets with time and resource types and returns paged results in response.
|
| SearchAllIamPolicies |
|---|
|
Searches all IAM policies within the specified scope, such as a project, folder, or organization. The caller must be granted the
|
| SearchAllResources |
|---|
|
Searches all Cloud de Confiance resources within the specified scope, such as a project, folder, or organization. The caller must be granted the
|
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 |
The last update timestamp of an asset. update_time is updated when create/update/delete operation is performed. |
name |
The full name of the asset. Example: See Resource names for more information. |
asset_type |
The type of the asset. Example: See Supported asset types for more information. |
resource |
A representation of the resource. |
iam_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[] |
A representation of an organization policy. There can be more than one organization policy with different constraints set on a given resource. |
os_inventory |
A representation of runtime OS Inventory information. See this topic for more information. |
related_assets |
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 |
One related asset of the current asset. |
ancestors[] |
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: |
asset_exceptions[] |
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 |
Also refer to the access policy user guide. |
access_level |
Also refer to the access level user guide. |
service_perimeter |
Also refer to the service perimeter user guide. |
AssetEnrichment
The enhanced metadata information for a resource.
| Fields | |
|---|---|
Union field
|
|
resource_owners |
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 |
The type of exception. |
details |
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 |
The type of this attached resource. Example: You can find the supported attached asset types of each resource in this table: |
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. |
BatchGetAssetsHistoryRequest
Batch get assets history request.
| Fields | |
|---|---|
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"). Authorization requires one or more of the following IAM permissions on the specified resource
|
asset_names[] |
A list of the full names of the assets. See: https://documentation.s3ns.fr/asset-inventory/docs/resource-name-format Example:
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 |
Optional. The content type. |
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. |
relationship_types[] |
Optional. A list of relationship types to output, for example: |
BatchGetAssetsHistoryResponse
Batch get assets history response.
| Fields | |
|---|---|
assets[] |
A list of assets with valid time windows. |
BigQueryDestination
A BigQuery destination for exporting assets to.
| Fields | |
|---|---|
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. Setting the |
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. |
force |
If the destination table already exists and this flag is |
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 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 |
separate_tables_per_asset_type |
If this flag is 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 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[] |
The effective tags inherited from the |
attached_resource |
The full resource name of the ancestor from which |
ExportAssetsRequest
Export asset request.
| Fields | |
|---|---|
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"). Authorization requires one or more of the following IAM permissions on the specified resource
|
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. |
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:
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 |
Asset content type. If not specified, no content but the asset name will be returned. |
output_config |
Required. Output configuration indicating where the results will be output to. |
relationship_types[] |
A list of relationship types to export, for example: |
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 |
Time the snapshot was taken. |
output_config |
Output configuration indicating where the results were output to. |
output_result |
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 |
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 |
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/ |
GcsOutputResult
A Cloud Storage output result.
| Fields | |
|---|---|
uris[] |
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 |
The full resource name of the resource associated with this IAM policy. Example: To search against the
|
asset_type |
The type of the resource associated with this IAM policy. Example: To search against the
|
project |
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
|
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
|
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
|
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
|
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 |
The map from roles to their included permissions that match the permission query (i.e., a query containing |
Permissions
IAM permissions
| Fields | |
|---|---|
permissions[] |
A list of permissions. A sample permission string: |
ListAssetsRequest
ListAssets request.
| Fields | |
|---|---|
parent |
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
|
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. |
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:
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 |
Asset content type. If not specified, no content but the asset name will be returned. |
page_size |
The maximum number of assets to be returned in a single response. Default is 100, minimum is 1, and maximum is 1000. |
page_token |
The |
relationship_types[] |
A list of relationship types to output, for example: |
ListAssetsResponse
ListAssets response.
| Fields | |
|---|---|
read_time |
Time the snapshot was taken. |
assets[] |
Assets. |
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. |
OutputConfig
Output configuration for export assets destination.
| Fields | |
|---|---|
Union field destination. Asset export destination. destination can be only one of the following: |
|
gcs_destination |
Destination on Cloud Storage. |
bigquery_destination |
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 |
Export result on Cloud Storage. |
PartitionSpec
Specifications of BigQuery partitioned table as export destination.
| Fields | |
|---|---|
partition_key |
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 |
The full name of the asset. Example: See Resource names for more information. |
asset_type |
The type of the asset. Example: See Supported asset types for more information. |
ancestors[] |
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: |
relationship_type |
The unique identifier of the relationship type. Example: |
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 |
The detailed relationship attributes. |
assets[] |
The peer resources of the relationship. |
RelatedResource
The detailed related resource.
| Fields | |
|---|---|
asset_type |
The type of the asset. Example: |
full_resource_name |
The full resource name of the related resource. Example: |
RelatedResources
The related resources of the primary resource.
| Fields | |
|---|---|
related_resources[] |
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 |
The unique identifier of the relationship type. Example: |
source_resource_type |
The source asset type. Example: |
target_resource_type |
The target asset type. Example: |
action |
The detail of the relationship, e.g. |
Resource
A representation of a Cloud de Confiance resource.
| Fields | |
|---|---|
version |
The API version. Example: |
discovery_document_uri |
The URL of the discovery document containing the resource's JSON schema. Example: This value is unspecified for resources that do not have an API based on a discovery document, such as Cloud Bigtable. |
discovery_name |
The JSON schema name listed in the discovery document. Example: This value is unspecified for resources that do not have an API based on a discovery document, such as Cloud Bigtable. |
resource_url |
The REST URL for accessing the resource. An HTTP This value is unspecified for resources without a REST API. |
parent |
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: |
data |
The content of the resource, in which some sensitive fields are removed and may not be present. |
location |
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[] |
List of resource owners. |
ResourceSearchResult
A result of Resource Search, containing information of a cloud resource.
| Fields | |
|---|---|
name |
The full resource name of this resource. Example: To search against the
|
asset_type |
The type of this resource. Example: To search against the
|
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
|
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
|
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
|
display_name |
The display name of this resource. This field is available only when the resource's Protobuf contains it. To search against the
|
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 Protobuf contains it. To search against the
|
location |
Location can be To search against the
|
labels |
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
|
network_tags[] |
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
|
kms_key |
The Cloud KMS CryptoKey name or CryptoKeyVersion name. This field only presents for the purpose of backward compatibility. Use the To search against the
|
kms_keys[] |
The Cloud KMS CryptoKey names or CryptoKeyVersion names. This field is available only when the resource's Protobuf contains it. To search against the
|
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 Protobuf contains it. To search against
|
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 Protobuf contains it. To search against
|
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 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 To search against the
|
additional_attributes |
The additional searchable attributes of this resource. The attributes may vary from one resource type to another. Examples: 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
|
parent_full_resource_name |
The full resource name of this resource's parent, if it has one. To search against the
|
versioned_resources[] |
Versioned resource representations of this resource. This is repeated because there could be multiple versions of resource representations during version migration. This |
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 |
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: |
tag_keys[] |
This field is only present for the purpose of backward compatibility. Use the TagKey namespaced names, in the format of {ORG_ID}/{TAG_KEY_SHORT_NAME}. To search against the
|
tag_values[] |
This field is only present for the purpose of backward compatibility. Use the TagValue namespaced names, in the format of {ORG_ID}/{TAG_KEY_SHORT_NAME}/{TAG_VALUE_SHORT_NAME}. To search against the
|
tag_value_ids[] |
This field is only present for the purpose of backward compatibility. Use the TagValue IDs, in the format of tagValues/{TAG_VALUE_ID}. To search against the
|
tags[] |
The tags directly attached to this resource. To search against the
|
effective_tags[] |
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
|
enrichments[] |
Enrichments of the asset. Currently supported enrichment types with SearchAllResources API:
The corresponding read masks in order to get the enrichment:
The corresponding required permissions:
Example query to get resource owner enrichment: |
parent_asset_type |
The type of this resource's immediate parent, if there is one. To search against the
|
scc_security_marks |
The actual content of Security Command Center security marks associated with the asset. To search against SCC SecurityMarks field:
|
SearchAllIamPoliciesRequest
Search all IAM policies request.
| Fields | |
|---|---|
scope |
Required. A scope can be a project, a folder, or an organization. The search is limited to the IAM policies within the The allowed values are:
Authorization requires the following IAM permission on the specified resource
|
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 Examples:
|
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 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 |
page_token |
Optional. If present, retrieve the next batch of results from the preceding call to this method. |
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 asset types supported by search APIs Regular expressions are also supported. For example:
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 |
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., |
SearchAllIamPoliciesResponse
Search all IAM policies response.
| Fields | |
|---|---|
results[] |
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 |
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 |
SearchAllResourcesRequest
Search all resources request.
| Fields | |
|---|---|
scope |
Required. A scope can be a project, a folder, or an organization. The search is limited to the resources within the The allowed values are:
Authorization requires the following IAM permission on the specified resource
|
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 Examples:
|
asset_types[] |
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:
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 |
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 |
page_token |
Optional. If present, then retrieve the next batch of results from the preceding call to this method. |
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 the following fields in the response are sortable:
|
read_mask |
Optional. A comma-separated list of fields that you want returned in the results. The following fields are returned by default if not specified:
Some fields of large size, such as |
SearchAllResourcesResponse
Search all resources response.
| Fields | |
|---|---|
results[] |
A list of Resources that match the search query. It contains the resource standard metadata information. |
next_page_token |
If there are more results than those appearing in this response, then |
Tag
The key and value for a tag.
| Fields | |
|---|---|
tag_key |
TagKey namespaced name, in the format of {ORG_ID}/{TAG_KEY_SHORT_NAME}. |
tag_key_id |
TagKey ID, in the format of tagKeys/{TAG_KEY_ID}. |
tag_value |
TagValue namespaced name, in the format of {ORG_ID}/{TAG_KEY_SHORT_NAME}/{TAG_VALUE_SHORT_NAME}. |
tag_value_id |
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 |
The time window when the asset data and state was observed. |
deleted |
Whether the asset has been deleted or not. |
asset |
An asset in Cloud de Confiance. |
prior_asset_state |
State of prior_asset. |
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. |
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 |
Start time of the time window (exclusive). |
end_time |
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 |
API version of the resource. Example: If the resource is an instance provided by Compute Engine v1 API as defined in |
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: You can find the resource definition for each supported resource type in this table: |
asset_exceptions[] |
The exceptions of a resource. |