Class: Google::Apis::CloudassetV1::ResourceSearchResult

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/cloudasset_v1/classes.rb,
lib/google/apis/cloudasset_v1/representations.rb,
lib/google/apis/cloudasset_v1/representations.rb

Overview

A result of Resource Search, containing information of a cloud resource.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ResourceSearchResult

Returns a new instance of ResourceSearchResult.



4201
4202
4203
 
# File 'lib/google/apis/cloudasset_v1/classes.rb', line 4201

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#additional_attributes ⇒ Hash<String,Object>

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 queryfoobar. Corresponds to the JSON propertyadditionalAttributes`

Returns:

  • (Hash<String,Object>) 


3991
3992
3993
 
# File 'lib/google/apis/cloudasset_v1/classes.rb', line 3991

def additional_attributes
  @additional_attributes
end

#asset_type ⇒ String

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. Corresponds to the JSON property assetType

Returns:

  • (String) 


3998
3999
4000
 
# File 'lib/google/apis/cloudasset_v1/classes.rb', line 3998

def asset_type
  @asset_type
end

#attached_resources ⇒ Array<Google::Apis::CloudassetV1::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 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. Corresponds to the JSON property attachedResources

Returns:



4007
4008
4009
 
# File 'lib/google/apis/cloudasset_v1/classes.rb', line 4007

def attached_resources
  @attached_resources
end

#create_time ⇒ String

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" Corresponds to the JSON property createTime

Returns:

  • (String) 


4018
4019
4020
 
# File 'lib/google/apis/cloudasset_v1/classes.rb', line 4018

def create_time
  @create_time
end

#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 description: * use a field query. Example: description:"important instance" * use a free text query. Example: "important instance" Corresponds to the JSON property description

Returns:

  • (String) 


4027
4028
4029
 
# File 'lib/google/apis/cloudasset_v1/classes.rb', line 4027

def description
  @description
end

#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 display_name: * use a field query. Example: displayName:"My Instance" * use a free text query. Example: "My Instance" Corresponds to the JSON property displayName

Returns:

  • (String) 


4035
4036
4037
 
# File 'lib/google/apis/cloudasset_v1/classes.rb', line 4035

def display_name
  @display_name
end

#folders ⇒ Array<String>

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. Corresponds to the JSON property folders

Returns:

  • (Array<String>) 


4044
4045
4046
 
# File 'lib/google/apis/cloudasset_v1/classes.rb', line 4044

def folders
  @folders
end

#kms_key ⇒ String

The Cloud KMS CryptoKey name or CryptoKeyVersion name. This field is available only when the resource's Protobuf contains it. To search against the kms_key: * use a field query. Example: kmsKey:key * use a free text query. Example: key Corresponds to the JSON property kmsKey

Returns:

  • (String) 


4054
4055
4056
 
# File 'lib/google/apis/cloudasset_v1/classes.rb', line 4054

def kms_key
  @kms_key
end

#labels ⇒ Hash<String,String>

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 Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


4066
4067
4068
 
# File 'lib/google/apis/cloudasset_v1/classes.rb', line 4066

def labels
  @labels
end

#location ⇒ String

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* Corresponds to the JSON property location

Returns:

  • (String) 


4074
4075
4076
 
# File 'lib/google/apis/cloudasset_v1/classes.rb', line 4074

def location
  @location
end

#name ⇒ String

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 Corresponds to the JSON property name

Returns:

  • (String) 


4084
4085
4086
 
# File 'lib/google/apis/cloudasset_v1/classes.rb', line 4084

def name
  @name
end

#network_tags ⇒ Array<String>

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 Corresponds to the JSON property networkTags

Returns:

  • (Array<String>) 


4095
4096
4097
 
# File 'lib/google/apis/cloudasset_v1/classes.rb', line 4095

def network_tags
  @network_tags
end

#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 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. Corresponds to the JSON property organization

Returns:

  • (String) 


4104
4105
4106
 
# File 'lib/google/apis/cloudasset_v1/classes.rb', line 4104

def organization
  @organization
end

#parent_asset_type ⇒ String

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 Corresponds to the JSON property parentAssetType

Returns:

  • (String) 


4112
4113
4114
 
# File 'lib/google/apis/cloudasset_v1/classes.rb', line 4112

def parent_asset_type
  @parent_asset_type
end

#parent_full_resource_name ⇒ String

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 Corresponds to the JSON property parentFullResourceName

Returns:

  • (String) 


4120
4121
4122
 
# File 'lib/google/apis/cloudasset_v1/classes.rb', line 4120

def parent_full_resource_name
  @parent_full_resource_name
end

#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 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. Corresponds to the JSON property project

Returns:

  • (String) 


4129
4130
4131
 
# File 'lib/google/apis/cloudasset_v1/classes.rb', line 4129

def project
  @project
end

#relationships ⇒ Hash<String,Google::Apis::CloudassetV1::RelatedResources>

A map of related resources of this resource, keyed by the relationship type. A relationship type is in the format of SourceTypeACTIONDestType. Example: DISK_TO_INSTANCE, DISK_TO_NETWORK, INSTANCE_TO_INSTANCEGROUP. See supported relationship types. Corresponds to the JSON property relationships

Returns:



4138
4139
4140
 
# File 'lib/google/apis/cloudasset_v1/classes.rb', line 4138

def relationships
  @relationships
end

#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 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 Corresponds to the JSON property state

Returns:

  • (String) 


4155
4156
4157
 
# File 'lib/google/apis/cloudasset_v1/classes.rb', line 4155

def state
  @state
end

#tag_keys ⇒ Array<String>

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 Corresponds to the JSON property tagKeys

Returns:

  • (Array<String>) 


4163
4164
4165
 
# File 'lib/google/apis/cloudasset_v1/classes.rb', line 4163

def tag_keys
  @tag_keys
end

#tag_value_ids ⇒ Array<String>

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 Corresponds to the JSON property tagValueIds

Returns:

  • (Array<String>) 


4170
4171
4172
 
# File 'lib/google/apis/cloudasset_v1/classes.rb', line 4170

def tag_value_ids
  @tag_value_ids
end

#tag_values ⇒ Array<String>

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 Corresponds to the JSON property tagValues

Returns:

  • (Array<String>) 


4179
4180
4181
 
# File 'lib/google/apis/cloudasset_v1/classes.rb', line 4179

def tag_values
  @tag_values
end

#update_time ⇒ String

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" Corresponds to the JSON property updateTime

Returns:

  • (String) 


4190
4191
4192
 
# File 'lib/google/apis/cloudasset_v1/classes.rb', line 4190

def update_time
  @update_time
end

#versioned_resources ⇒ Array<Google::Apis::CloudassetV1::VersionedResource>

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. Corresponds to the JSON property versionedResources

Returns:



4199
4200
4201
 
# File 'lib/google/apis/cloudasset_v1/classes.rb', line 4199

def versioned_resources
  @versioned_resources
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
 
# File 'lib/google/apis/cloudasset_v1/classes.rb', line 4206

def update!(**args)
  @additional_attributes = args[:additional_attributes] if args.key?(:additional_attributes)
  @asset_type = args[:asset_type] if args.key?(:asset_type)
  @attached_resources = args[:attached_resources] if args.key?(:attached_resources)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @folders = args[:folders] if args.key?(:folders)
  @kms_key = args[:kms_key] if args.key?(:kms_key)
  @labels = args[:labels] if args.key?(:labels)
  @location = args[:location] if args.key?(:location)
  @name = args[:name] if args.key?(:name)
  @network_tags = args[:network_tags] if args.key?(:network_tags)
  @organization = args[:organization] if args.key?(:organization)
  @parent_asset_type = args[:parent_asset_type] if args.key?(:parent_asset_type)
  @parent_full_resource_name = args[:parent_full_resource_name] if args.key?(:parent_full_resource_name)
  @project = args[:project] if args.key?(:project)
  @relationships = args[:relationships] if args.key?(:relationships)
  @state = args[:state] if args.key?(:state)
  @tag_keys = args[:tag_keys] if args.key?(:tag_keys)
  @tag_value_ids = args[:tag_value_ids] if args.key?(:tag_value_ids)
  @tag_values = args[:tag_values] if args.key?(:tag_values)
  @update_time = args[:update_time] if args.key?(:update_time)
  @versioned_resources = args[:versioned_resources] if args.key?(:versioned_resources)
end