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.



1003
1004
1005
 
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 1003

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

Instance Attribute Details

#create_time ⇒ String

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

Returns:

  • (String) 


958
959
960
 
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 958

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) 


964
965
966
 
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 964

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) 


970
971
972
 
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 970

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) 


976
977
978
 
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 976

def name
  @name
end

#namespaced_name ⇒ String

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

Returns:

  • (String) 


981
982
983
 
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 981

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) 


987
988
989
 
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 987

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) 


996
997
998
 
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 996

def short_name
  @short_name
end

#update_time ⇒ String

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

Returns:

  • (String) 


1001
1002
1003
 
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 1001

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
 
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 1008

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