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.



1606
1607
1608
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 1606

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

Instance Attribute Details

#create_timeString

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

Returns:

  • (String)


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

def create_time
  @create_time
end

#descriptionString

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

Returns:

  • (String)


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

def description
  @description
end

#etagString

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)


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

def etag
  @etag
end

#nameString

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)


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

def name
  @name
end

#namespaced_nameString

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

Returns:

  • (String)


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

def namespaced_name
  @namespaced_name
end

#parentString

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)


1590
1591
1592
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 1590

def parent
  @parent
end

#short_nameString

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)


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

def short_name
  @short_name
end

#update_timeString

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

Returns:

  • (String)


1604
1605
1606
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 1604

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 1611

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