Reference documentation and code samples for the Google Cloud Asset V1 Client class ResourceSearchResult.
A result of Resource Search, containing information of a cloud resource.
Generated from protobuf message google.cloud.asset.v1.ResourceSearchResult
Namespace
Google \ Cloud \ Asset \ V1Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
The full resource name of this resource. Example: |
↳ asset_type |
string
The type of this resource. Example: |
↳ 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 |
↳ folders |
array
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 |
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 |
↳ 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 |
↳ 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 |
↳ location |
string
Location can be |
↳ labels |
array|Google\Protobuf\Internal\MapField
User 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 the |
↳ network_tags |
array
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 the |
↳ kms_key |
string
The Cloud KMS CryptoKey name or CryptoKeyVersion name. This field only presents for the purpose of backward compatibility. Use the |
↳ kms_keys |
array
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 |
Google\Protobuf\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 |
↳ update_time |
Google\Protobuf\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 |
↳ 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 |
↳ additional_attributes |
Google\Protobuf\Struct
The additional searchable attributes of this resource. The attributes may vary from one resource type to another. Examples: |
↳ parent_full_resource_name |
string
The full resource name of this resource's parent, if it has one. To search against the |
↳ versioned_resources |
array<Google\Cloud\Asset\V1\VersionedResource>
Versioned resource representations of this resource. This is repeated because there could be multiple versions of resource representations during version migration. This |
↳ attached_resources |
array<Google\Cloud\Asset\V1\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 |
↳ relationships |
array|Google\Protobuf\Internal\MapField
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 |
array
This field is only present for the purpose of backward compatibility. Use the |
↳ tag_values |
array
This field is only present for the purpose of backward compatibility. Use the |
↳ tag_value_ids |
array
This field is only present for the purpose of backward compatibility. Use the |
↳ tags |
array<Google\Cloud\Asset\V1\Tag>
The tags directly attached to this resource. To search against the |
↳ effective_tags |
array<Google\Cloud\Asset\V1\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 |
↳ parent_asset_type |
string
The type of this resource's immediate parent, if there is one. To search against the |
↳ scc_security_marks |
array|Google\Protobuf\Internal\MapField
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: |
getName
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
Returns | |
---|---|
Type | Description |
string |
setName
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
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getAssetType
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.
Returns | |
---|---|
Type | Description |
string |
setAssetType
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.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getProject
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.
Returns | |
---|---|
Type | Description |
string |
setProject
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.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getFolders
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.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setFolders
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.
Parameter | |
---|---|
Name | Description |
var |
string[]
|
Returns | |
---|---|
Type | Description |
$this |
getOrganization
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.
Returns | |
---|---|
Type | Description |
string |
setOrganization
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.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getDisplayName
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"
Returns | |
---|---|
Type | Description |
string |
setDisplayName
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"
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getDescription
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"
Returns | |
---|---|
Type | Description |
string |
setDescription
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"
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getLocation
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*
Returns | |
---|---|
Type | Description |
string |
setLocation
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*
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getLabels
User 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 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:*
- query on any label's key or value. Example:
- Use a free text query. Example:
prod
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\MapField |
setLabels
User 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 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:*
- query on any label's key or value. Example:
- Use a free text query. Example:
prod
Parameter | |
---|---|
Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
Returns | |
---|---|
Type | Description |
$this |
getNetworkTags
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 the network_tags
:
- Use a field query. Example:
networkTags:internal
- Use a free text query. Example:
internal
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setNetworkTags
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 the network_tags
:
- Use a field query. Example:
networkTags:internal
- Use a free text query. Example:
internal
Parameter | |
---|---|
Name | Description |
var |
string[]
|
Returns | |
---|---|
Type | Description |
$this |
getKmsKey
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
Returns | |
---|---|
Type | Description |
string |
setKmsKey
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
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getKmsKeys
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
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setKmsKeys
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
Parameter | |
---|---|
Name | Description |
var |
string[]
|
Returns | |
---|---|
Type | Description |
$this |
getCreateTime
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"
- value in seconds since unix epoch. Example:
Returns | |
---|---|
Type | Description |
Google\Protobuf\Timestamp|null |
hasCreateTime
clearCreateTime
setCreateTime
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"
- value in seconds since unix epoch. Example:
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Timestamp
|
Returns | |
---|---|
Type | Description |
$this |
getUpdateTime
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"
- value in seconds since unix epoch. Example:
Returns | |
---|---|
Type | Description |
Google\Protobuf\Timestamp|null |
hasUpdateTime
clearUpdateTime
setUpdateTime
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"
- value in seconds since unix epoch. Example:
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Timestamp
|
Returns | |
---|---|
Type | Description |
$this |
getState
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
Returns | |
---|---|
Type | Description |
string |
setState
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
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getAdditionalAttributes
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 the additional_attributes
:
- Use a free text query to match the attributes values. Example: to search
additional_attributes = { dnsName: "foobar" }
, you can issue a queryfoobar
.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Struct|null |
hasAdditionalAttributes
clearAdditionalAttributes
setAdditionalAttributes
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 the additional_attributes
:
- Use a free text query to match the attributes values. Example: to search
additional_attributes = { dnsName: "foobar" }
, you can issue a queryfoobar
.
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Struct
|
Returns | |
---|---|
Type | Description |
$this |
getParentFullResourceName
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
Returns | |
---|---|
Type | Description |
string |
setParentFullResourceName
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
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getVersionedResources
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.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setVersionedResources
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.
Parameter | |
---|---|
Name | Description |
var |
array<Google\Cloud\Asset\V1\VersionedResource>
|
Returns | |
---|---|
Type | Description |
$this |
getAttachedResources
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.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setAttachedResources
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.
Parameter | |
---|---|
Name | Description |
var |
array<Google\Cloud\Asset\V1\AttachedResource>
|
Returns | |
---|---|
Type | Description |
$this |
getRelationships
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
.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\MapField |
setRelationships
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
.
Parameter | |
---|---|
Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
Returns | |
---|---|
Type | Description |
$this |
getTagKeys
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
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setTagKeys
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
Parameter | |
---|---|
Name | Description |
var |
string[]
|
Returns | |
---|---|
Type | Description |
$this |
getTagValues
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
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setTagValues
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
Parameter | |
---|---|
Name | Description |
var |
string[]
|
Returns | |
---|---|
Type | Description |
$this |
getTagValueIds
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
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setTagValueIds
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
Parameter | |
---|---|
Name | Description |
var |
string[]
|
Returns | |
---|---|
Type | Description |
$this |
getTags
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
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setTags
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
Parameter | |
---|---|
Name | Description |
var |
array<Google\Cloud\Asset\V1\Tag>
|
Returns | |
---|---|
Type | Description |
$this |
getEffectiveTags
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"
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setEffectiveTags
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"
Parameter | |
---|---|
Name | Description |
var |
array<Google\Cloud\Asset\V1\EffectiveTagDetails>
|
Returns | |
---|---|
Type | Description |
$this |
getParentAssetType
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
Returns | |
---|---|
Type | Description |
string |
setParentAssetType
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
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getSccSecurityMarks
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:*
- query by a given key value pair. Example:
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\MapField |
setSccSecurityMarks
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:*
- query by a given key value pair. Example:
Parameter | |
---|---|
Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
Returns | |
---|---|
Type | Description |
$this |