Class: Google::Apis::CloudresourcemanagerV3::TagKey

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

Overview

A TagKey, used to group a set of TagValues.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ TagKey

Returns a new instance of TagKey.



1601
1602
1603
 
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 1601

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

Instance Attribute Details

#create_time ⇒ String

Output only. Creation time. Corresponds to the JSON property createTime

Returns:

  • (String) 


1556
1557
1558
 
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 1556

def create_time
  @create_time
end

#description ⇒ String

Optional. User-assigned description of the TagKey. Must not exceed 256 characters. Read-write. Corresponds to the JSON property description

Returns:

  • (String) 


1562
1563
1564
 
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 1562

def description
  @description
end

#etag ⇒ String

Optional. Entity tag which users can pass to prevent race conditions. This field is always set in server responses. See UpdateTagKeyRequest for details. Corresponds to the JSON property etag

Returns:

  • (String) 


1568
1569
1570
 
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 1568

def etag
  @etag
end

#name ⇒ String

Immutable. The resource name for a TagKey. Must be in the format tagKeys/ tag_key_id`, wheretag_key_idis the generated numeric id for the TagKey. Corresponds to the JSON propertyname`

Returns:

  • (String) 


1574
1575
1576
 
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 1574

def name
  @name
end

#namespaced_name ⇒ String

Output only. Immutable. Namespaced name of the TagKey. Corresponds to the JSON property namespacedName

Returns:

  • (String) 


1579
1580
1581
 
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 1579

def namespaced_name
  @namespaced_name
end

#parent ⇒ String

Immutable. The resource name of the new TagKey's parent. Must be of the form organizations/org_id`. Corresponds to the JSON propertyparent`

Returns:

  • (String) 


1585
1586
1587
 
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 1585

def parent
  @parent
end

#short_name ⇒ String

Required. Immutable. The user friendly name for a TagKey. The short name should be unique for TagKeys within the same tag namespace. The short name must be 1-63 characters, beginning and ending with an alphanumeric character ([ a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. Corresponds to the JSON property shortName

Returns:

  • (String) 


1594
1595
1596
 
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 1594

def short_name
  @short_name
end

#update_time ⇒ String

Output only. Update time. Corresponds to the JSON property updateTime

Returns:

  • (String) 


1599
1600
1601
 
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 1599

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
 
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 1606

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @etag = args[:etag] if args.key?(:etag)
  @name = args[:name] if args.key?(:name)
  @namespaced_name = args[:namespaced_name] if args.key?(:namespaced_name)
  @parent = args[:parent] if args.key?(:parent)
  @short_name = args[:short_name] if args.key?(:short_name)
  @update_time = args[:update_time] if args.key?(:update_time)
end