View Source GoogleApi.CloudAsset.V1.Model.ResourceSearchResult (google_api_cloud_asset v0.35.0)
A result of Resource Search, containing information of a cloud resource. Next ID: 34
Attributes
-
additionalAttributes
(type:map()
, default:nil
) - 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 Google Cloud 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 Google Cloud service updates to a new incompatible API version. To search against theadditional_attributes
: * Use a free text query to match the attributes values. Example: to searchadditional_attributes = { dnsName: "foobar" }
, you can issue a queryfoobar
. -
assetType
(type:String.t
, default:nil
) - The type of this resource. Example:compute.googleapis.com/Disk
. To search against theasset_type
: * Specify theasset_type
field in your search request. -
attachedResources
(type:list(GoogleApi.CloudAsset.V1.Model.AttachedResource.t)
, default:nil
) - 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. Thisattached_resources
field is not searchable. Some attributes of the attached resources are exposed inadditional_attributes
field, so as to allow users to search on them. -
createTime
(type:DateTime.t
, default:nil
) - 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 againstcreate_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"
-
description
(type:String.t
, default:nil
) - 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 thedescription
: Use a field query. Example:description:"important instance"
Use a free text query. Example:"important instance"
-
displayName
(type:String.t
, default:nil
) - The display name of this resource. This field is available only when the resource's Protobuf contains it. To search against thedisplay_name
: Use a field query. Example:displayName:"My Instance"
Use a free text query. Example:"My Instance"
-
effectiveTags
(type:list(GoogleApi.CloudAsset.V1.Model.EffectiveTagDetails.t)
, default:nil
) - 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 theeffective_tags
: Use a field query. Example: - `effectiveTagKeys:"123456789/env"-
effectiveTagKeys="123456789/env"-
effectiveTagKeys:"env"-
effectiveTagValues:"env"-
effectiveTagValues:"env/prod"-
effectiveTagValues:"123456789/env/prod*"-
effectiveTagValues="123456789/env/prod"-
effectiveTagValueIds="tagValues/456"` -
folders
(type:list(String.t)
, default:nil
) - 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 againstfolders
: Use a field query. Example:folders:(123 OR 456)
Use a free text query. Example:123
* Specify thescope
field as this folder in your search request. -
kmsKey
(type:String.t
, default:nil
) - The Cloud KMS CryptoKey name or CryptoKeyVersion name. This field only presents for the purpose of backward compatibility. Use thekms_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 thekms_key
: Use a field query. Example:kmsKey:key
Use a free text query. Example:key
-
kmsKeys
(type:list(String.t)
, default:nil
) - The Cloud KMS CryptoKey names or CryptoKeyVersion names. This field is available only when the resource's Protobuf contains it. To search against thekms_keys
: Use a field query. Example:kmsKeys:key
Use a free text query. Example:key
-
labels
(type:map()
, default:nil
) - Labels associated with this resource. See Labelling and grouping Google Cloud resources for more information. This field is available only when the resource's Protobuf contains it. To search against thelabels
: 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` -
location
(type:String.t
, default:nil
) - Location can beglobal
, regional likeus-east1
, or zonal likeus-west1-b
. This field is available only when the resource's Protobuf contains it. To search against thelocation
: Use a field query. Example: `location:us-west* Use a free text query. Example:
us-west*` -
name
(type:String.t
, default:nil
) - 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 thename
: Use a field query. Example:name:instance1
Use a free text query. Example:instance1
-
networkTags
(type:list(String.t)
, default:nil
) - Network tags associated with this resource. Like labels, network tags are a type of annotations used to group Google Cloud resources. See Labelling Google Cloud resources for more information. This field is available only when the resource's Protobuf contains it. To search against thenetwork_tags
: Use a field query. Example:networkTags:internal
Use a free text query. Example:internal
-
organization
(type:String.t
, default:nil
) - 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 againstorganization
: Use a field query. Example:organization:123
Use a free text query. Example:123
* Specify thescope
field as this organization in your search request. -
parentAssetType
(type:String.t
, default:nil
) - The type of this resource's immediate parent, if there is one. To search against theparent_asset_type
: Use a field query. Example:parentAssetType:"cloudresourcemanager.googleapis.com/Project"
Use a free text query. Example:cloudresourcemanager.googleapis.com/Project
-
parentFullResourceName
(type:String.t
, default:nil
) - The full resource name of this resource's parent, if it has one. To search against theparent_full_resource_name
: Use a field query. Example:parentFullResourceName:"project-name"
Use a free text query. Example:project-name
-
project
(type:String.t
, default:nil
) - 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 againstproject
: Use a field query. Example:project:12345
Use a free text query. Example:12345
* Specify thescope
field as this project in your search request. -
relationships
(type:%{optional(String.t) => GoogleApi.CloudAsset.V1.Model.RelatedResources.t}
, default:nil
) - 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. -
sccSecurityMarks
(type:map()
, default:nil
) - 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:` -
state
(type:String.t
, default:nil
) - 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. Seestatus
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. SeelifecycleState
definition in API Reference. To search against thestate
: Use a field query. Example:state:RUNNING
Use a free text query. Example:RUNNING
-
tagKeys
(type:list(String.t)
, default:nil
) - This field is only present for the purpose of backward compatibility. Use thetags
field instead. TagKey namespaced names, in the format of {ORG_ID}/{TAG_KEY_SHORT_NAME}. To search against thetagKeys
: Use a field query. Example: - `tagKeys:"123456789/env"-
tagKeys="123456789/env"-
tagKeys:"env"* Use a free text query. Example: -
env` -
tagValueIds
(type:list(String.t)
, default:nil
) - This field is only present for the purpose of backward compatibility. Use thetags
field instead. TagValue IDs, in the format of tagValues/{TAG_VALUE_ID}. To search against thetagValueIds
: Use a field query. Example: -tagValueIds="tagValues/456"
Use a free text query. Example: -456
-
tagValues
(type:list(String.t)
, default:nil
) - This field is only present for the purpose of backward compatibility. Use thetags
field instead. TagValue namespaced names, in the format of {ORG_ID}/{TAG_KEY_SHORT_NAME}/{TAG_VALUE_SHORT_NAME}. To search against thetagValues
: 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` -
tags
(type:list(GoogleApi.CloudAsset.V1.Model.Tag.t)
, default:nil
) - The tags directly attached to this resource. To search against thetags
: Use a field query. Example: - `tagKeys:"123456789/env"-
tagKeys="123456789/env"-
tagKeys:"env"-
tagValues:"env"-
tagValues:"env/prod"-
tagValues:"123456789/env/prod"-
tagValues="123456789/env/prod"-
tagValueIds="tagValues/456"` Use a free text query. Example: -env/prod
-
updateTime
(type:DateTime.t
, default:nil
) - 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 againstupdate_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"
-
versionedResources
(type:list(GoogleApi.CloudAsset.V1.Model.VersionedResource.t)
, default:nil
) - Versioned resource representations of this resource. This is repeated because there could be multiple versions of resource representations during version migration. Thisversioned_resources
field is not searchable. Some attributes of the resource representations are exposed inadditional_attributes
field, so as to allow users to search on them.
Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Types
@type t() :: %GoogleApi.CloudAsset.V1.Model.ResourceSearchResult{ additionalAttributes: map() | nil, assetType: String.t() | nil, attachedResources: [GoogleApi.CloudAsset.V1.Model.AttachedResource.t()] | nil, createTime: DateTime.t() | nil, description: String.t() | nil, displayName: String.t() | nil, effectiveTags: [GoogleApi.CloudAsset.V1.Model.EffectiveTagDetails.t()] | nil, folders: [String.t()] | nil, kmsKey: String.t() | nil, kmsKeys: [String.t()] | nil, labels: map() | nil, location: String.t() | nil, name: String.t() | nil, networkTags: [String.t()] | nil, organization: String.t() | nil, parentAssetType: String.t() | nil, parentFullResourceName: String.t() | nil, project: String.t() | nil, relationships: %{ optional(String.t()) => GoogleApi.CloudAsset.V1.Model.RelatedResources.t() } | nil, sccSecurityMarks: map() | nil, state: String.t() | nil, tagKeys: [String.t()] | nil, tagValueIds: [String.t()] | nil, tagValues: [String.t()] | nil, tags: [GoogleApi.CloudAsset.V1.Model.Tag.t()] | nil, updateTime: DateTime.t() | nil, versionedResources: [GoogleApi.CloudAsset.V1.Model.VersionedResource.t()] | nil }
Functions
Unwrap a decoded JSON object into its complex fields.