google_api_cloud_asset v0.14.1 GoogleApi.CloudAsset.V1.Model.ResourceSearchResult View Source
A result of Resource Search, containing information of a cloud resource.
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 GCP service (e.g., Compute Engine). see API references and supported searchable attributes for more information.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"
.
- use a free text query to match the attributes values. Example: to search
assetType
(type:String.t
, default:nil
) - 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.
- specify the
description
(type:String.t
, default:nil
) - One or more paragraphs of text description of this resource. Maximum length could be up to 1M bytes.To search against the
description
:- use a field query. Example:
description : "*important instance*"
- use a free text query. Example:
"*important instance*"
- use a field query. Example:
displayName
(type:String.t
, default:nil
) - The display name of this resource.To search against the
display_name
:- use a field query. Example:
displayName : "My Instance"
- use a free text query. Example:
"My Instance"
- use a field query. Example:
labels
(type:map()
, default:nil
) - Labels associated with this resource. See Labelling and grouping GCP resources for more information.To search against the
labels
:- use a field query, as following:
- 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'sexistence. Example:
labels.env : *
- query on any label's key or value. Example:
- use a free text query. Example:
"prod"
- use a field query, as following:
location
(type:String.t
, default:nil
) - Location can beglobal
, regional likeus-east1
, or zonal likeus-west1-b
.To search against the
location
:- use a field query. Example:
location : "us-west*"
- use a free text query. Example:
"us-west*"
- use a field query. Example:
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 the
name
:- use a field query. Example:
name : "instance1"
- use a free text query. Example:
"instance1"
- use a field query. Example:
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 GCP resources. See Labelling GCP resources for more information.To search against the
network_tags
:- use a field query. Example:
networkTags : "internal"
- use a free text query. Example:
"internal"
- use a field query. Example:
project
(type:String.t
, default:nil
) - The project that this resource belongs to, in the form of projects/{PROJECT_NUMBER}.To search against the
project
:- specify the
scope
field as this project in your search request.
- specify the
Link to this section Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Link to this section Types
Specs
Link to this section Functions
Specs
Unwrap a decoded JSON object into its complex fields.