Google Cloud Asset V1 Client - Class ResourceSearchResult (1.9.2)

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.

Next ID: 31

Generated from protobuf message google.cloud.asset.v1.ResourceSearchResult

Constructor.

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

Generated from protobuf field string name = 1;

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

Generated from protobuf field string name = 1;

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.

Generated from protobuf field string asset_type = 2;

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.

Generated from protobuf field string asset_type = 2;

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.

Generated from protobuf field string project = 3;

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.

Generated from protobuf field string project = 3;

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.

Generated from protobuf field repeated string folders = 17;

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.

Generated from protobuf field repeated string folders = 17;

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.

Generated from protobuf field string organization = 18;

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.

Generated from protobuf field string organization = 18;

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"

Generated from protobuf field string display_name = 4;

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"

Generated from protobuf field string display_name = 4;

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"

Generated from protobuf field string description = 5;

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"

Generated from protobuf field string description = 5;

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*

Generated from protobuf field string location = 6;

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*

Generated from protobuf field string location = 6;

Labels associated with this resource. See Labelling and grouping GCP 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

Generated from protobuf field map<string, string> labels = 7;

Labels associated with this resource. See Labelling and grouping GCP 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

Generated from protobuf field map<string, string> labels = 7;

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

To search against the network_tags :

• Use a field query. Example: networkTags:internal
• Use a free text query. Example: internal

Generated from protobuf field repeated string network_tags = 8;

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

To search against the network_tags :

• Use a field query. Example: networkTags:internal
• Use a free text query. Example: internal

Generated from protobuf field repeated string network_tags = 8;

The Cloud KMS CryptoKey name or CryptoKeyVersion name.

This field only presents for the purpose of backward compatibility. Please use the kms_keys field to retrieve 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

Generated from protobuf field string kms_key = 10 [deprecated = true];

The Cloud KMS CryptoKey name or CryptoKeyVersion name.

This field only presents for the purpose of backward compatibility. Please use the kms_keys field to retrieve 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

Generated from protobuf field string kms_key = 10 [deprecated = true];

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

Generated from protobuf field repeated string kms_keys = 28;

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

Generated from protobuf field repeated string kms_keys = 28;

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"

Generated from protobuf field .google.protobuf.Timestamp create_time = 11;

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"

Generated from protobuf field .google.protobuf.Timestamp create_time = 11;

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"

Generated from protobuf field .google.protobuf.Timestamp update_time = 12;

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"

Generated from protobuf field .google.protobuf.Timestamp update_time = 12;

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 Cloud Resource Manager, its state will include LIFECYCLE_STATE_UNSPECIFIED, ACTIVE, DELETE_REQUESTED and DELETE_IN_PROGRESS. See lifecycleState definition in API Reference . To search against the state :

• Use a field query. Example: state:RUNNING
• Use a free text query. Example: RUNNING

Generated from protobuf field string state = 13;

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 Cloud Resource Manager, its state will include LIFECYCLE_STATE_UNSPECIFIED, ACTIVE, DELETE_REQUESTED and DELETE_IN_PROGRESS. See lifecycleState definition in API Reference . To search against the state :

• Use a field query. Example: state:RUNNING
• Use a free text query. Example: RUNNING

Generated from protobuf field string state = 13;

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

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

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

Generated from protobuf field .google.protobuf.Struct additional_attributes = 9;

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

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

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

Generated from protobuf field .google.protobuf.Struct additional_attributes = 9;

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

Generated from protobuf field string parent_full_resource_name = 19;

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

Generated from protobuf field string parent_full_resource_name = 19;

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.

Generated from protobuf field repeated .google.cloud.asset.v1.VersionedResource versioned_resources = 16;

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.

Generated from protobuf field repeated .google.cloud.asset.v1.VersionedResource versioned_resources = 16;

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.

Generated from protobuf field repeated .google.cloud.asset.v1.AttachedResource attached_resources = 20;

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.

Generated from protobuf field repeated .google.cloud.asset.v1.AttachedResource attached_resources = 20;

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 .

Generated from protobuf field map<string, .google.cloud.asset.v1.RelatedResources> relationships = 21;

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 .

Generated from protobuf field map<string, .google.cloud.asset.v1.RelatedResources> relationships = 21;

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

Generated from protobuf field repeated string tag_keys = 23;

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

Generated from protobuf field repeated string tag_keys = 23;

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

Generated from protobuf field repeated string tag_values = 25;

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

Generated from protobuf field repeated string tag_values = 25;

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

To search against the tagValueIds :

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

Generated from protobuf field repeated string tag_value_ids = 26;

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

To search against the tagValueIds :

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

Generated from protobuf field repeated string tag_value_ids = 26;

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

Generated from protobuf field string parent_asset_type = 103;

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

Generated from protobuf field string parent_asset_type = 103;