Class: OCI::Identity::Models::Tag
- Inherits:
-
Object
- Object
- OCI::Identity::Models::Tag
- Defined in:
- lib/oci/identity/models/tag.rb
Overview
A tag definition that belongs to a specific tag namespace. "Defined tags" must be set up in your tenancy before you can apply them to resources. For more information, see [Managing Tags and Tag Namespaces](docs.cloud.oracle.com/Content/Identity/Concepts/taggingoverview.htm).
Constant Summary collapse
- LIFECYCLE_STATE_ENUM =
[ LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze, LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze, LIFECYCLE_STATE_DELETING = 'DELETING'.freeze, LIFECYCLE_STATE_DELETED = 'DELETED'.freeze, LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
[Required] The OCID of the compartment that contains the tag definition.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#description ⇒ String
[Required] The description you assign to the tag.
-
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource.
-
#id ⇒ String
[Required] The OCID of the tag definition.
-
#is_cost_tracking ⇒ BOOLEAN
Indicates whether the tag is enabled for cost tracking.
-
#is_retired ⇒ BOOLEAN
[Required] Indicates whether the tag is retired.
-
#lifecycle_state ⇒ String
The tag’s current state.
-
#name ⇒ String
[Required] The name of the tag.
-
#tag_namespace_id ⇒ String
[Required] The OCID of the namespace that contains the tag definition.
-
#tag_namespace_name ⇒ String
[Required] The name of the tag namespace that contains the tag definition.
-
#time_created ⇒ DateTime
[Required] Date and time the tag was created, in the format defined by RFC3339.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Tag
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ Tag
Initializes the object
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 |
# File 'lib/oci/identity/models/tag.rb', line 140 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId'] raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id') self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id'] self.tag_namespace_id = attributes[:'tagNamespaceId'] if attributes[:'tagNamespaceId'] raise 'You cannot provide both :tagNamespaceId and :tag_namespace_id' if attributes.key?(:'tagNamespaceId') && attributes.key?(:'tag_namespace_id') self.tag_namespace_id = attributes[:'tag_namespace_id'] if attributes[:'tag_namespace_id'] self.tag_namespace_name = attributes[:'tagNamespaceName'] if attributes[:'tagNamespaceName'] raise 'You cannot provide both :tagNamespaceName and :tag_namespace_name' if attributes.key?(:'tagNamespaceName') && attributes.key?(:'tag_namespace_name') self.tag_namespace_name = attributes[:'tag_namespace_name'] if attributes[:'tag_namespace_name'] self.id = attributes[:'id'] if attributes[:'id'] self.name = attributes[:'name'] if attributes[:'name'] self.description = attributes[:'description'] if attributes[:'description'] self. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = attributes[:'defined_tags'] if attributes[:'defined_tags'] self.is_retired = attributes[:'isRetired'] unless attributes[:'isRetired'].nil? raise 'You cannot provide both :isRetired and :is_retired' if attributes.key?(:'isRetired') && attributes.key?(:'is_retired') self.is_retired = attributes[:'is_retired'] unless attributes[:'is_retired'].nil? self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState'] raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state') self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state'] self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated'] raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created') self.time_created = attributes[:'time_created'] if attributes[:'time_created'] self.is_cost_tracking = attributes[:'isCostTracking'] unless attributes[:'isCostTracking'].nil? raise 'You cannot provide both :isCostTracking and :is_cost_tracking' if attributes.key?(:'isCostTracking') && attributes.key?(:'is_cost_tracking') self.is_cost_tracking = attributes[:'is_cost_tracking'] unless attributes[:'is_cost_tracking'].nil? end |
Instance Attribute Details
#compartment_id ⇒ String
[Required] The OCID of the compartment that contains the tag definition.
23 24 25 |
# File 'lib/oci/identity/models/tag.rb', line 23 def compartment_id @compartment_id end |
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). Example: ‘{"CostCenter": "42"}“
59 60 61 |
# File 'lib/oci/identity/models/tag.rb', line 59 def @defined_tags end |
#description ⇒ String
[Required] The description you assign to the tag.
45 46 47 |
# File 'lib/oci/identity/models/tag.rb', line 45 def description @description end |
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). Example: ‘"Finance"`
52 53 54 |
# File 'lib/oci/identity/models/tag.rb', line 52 def @freeform_tags end |
#id ⇒ String
[Required] The OCID of the tag definition.
36 37 38 |
# File 'lib/oci/identity/models/tag.rb', line 36 def id @id end |
#is_cost_tracking ⇒ BOOLEAN
Indicates whether the tag is enabled for cost tracking.
80 81 82 |
# File 'lib/oci/identity/models/tag.rb', line 80 def is_cost_tracking @is_cost_tracking end |
#is_retired ⇒ BOOLEAN
[Required] Indicates whether the tag is retired. See [Retiring Key Definitions and Namespace Definitions](docs.cloud.oracle.com/Content/Identity/Concepts/taggingoverview.htm#Retiring).
65 66 67 |
# File 'lib/oci/identity/models/tag.rb', line 65 def is_retired @is_retired end |
#lifecycle_state ⇒ String
The tag’s current state. After creating a tag, make sure its ‘lifecycleState` is ACTIVE before using it. After retiring a tag, make sure its `lifecycleState` is INACTIVE before using it.
69 70 71 |
# File 'lib/oci/identity/models/tag.rb', line 69 def lifecycle_state @lifecycle_state end |
#name ⇒ String
[Required] The name of the tag. The name must be unique across all tags in the namespace and can’t be changed.
41 42 43 |
# File 'lib/oci/identity/models/tag.rb', line 41 def name @name end |
#tag_namespace_id ⇒ String
[Required] The OCID of the namespace that contains the tag definition.
27 28 29 |
# File 'lib/oci/identity/models/tag.rb', line 27 def tag_namespace_id @tag_namespace_id end |
#tag_namespace_name ⇒ String
[Required] The name of the tag namespace that contains the tag definition.
32 33 34 |
# File 'lib/oci/identity/models/tag.rb', line 32 def tag_namespace_name @tag_namespace_name end |
#time_created ⇒ DateTime
[Required] Date and time the tag was created, in the format defined by RFC3339. Example: ‘2016-08-25T21:10:29.600Z`
75 76 77 |
# File 'lib/oci/identity/models/tag.rb', line 75 def time_created @time_created end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 |
# File 'lib/oci/identity/models/tag.rb', line 83 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'compartment_id': :'compartmentId', 'tag_namespace_id': :'tagNamespaceId', 'tag_namespace_name': :'tagNamespaceName', 'id': :'id', 'name': :'name', 'description': :'description', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags', 'is_retired': :'isRetired', 'lifecycle_state': :'lifecycleState', 'time_created': :'timeCreated', 'is_cost_tracking': :'isCostTracking' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 |
# File 'lib/oci/identity/models/tag.rb', line 103 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'compartment_id': :'String', 'tag_namespace_id': :'String', 'tag_namespace_name': :'String', 'id': :'String', 'name': :'String', 'description': :'String', 'freeform_tags': :'Hash<String, String>', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'is_retired': :'BOOLEAN', 'lifecycle_state': :'String', 'time_created': :'DateTime', 'is_cost_tracking': :'BOOLEAN' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 |
# File 'lib/oci/identity/models/tag.rb', line 227 def ==(other) return true if equal?(other) self.class == other.class && compartment_id == other.compartment_id && tag_namespace_id == other.tag_namespace_id && tag_namespace_name == other.tag_namespace_name && id == other.id && name == other.name && description == other.description && == other. && == other. && is_retired == other.is_retired && lifecycle_state == other.lifecycle_state && time_created == other.time_created && is_cost_tracking == other.is_cost_tracking end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 |
# File 'lib/oci/identity/models/tag.rb', line 268 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /^Array<(.*)>/i # check to ensure the input is an array given that the the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) public_method("#{key}=").call( attributes[self.class.attribute_map[key]] .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) } ) end elsif !attributes[self.class.attribute_map[key]].nil? public_method("#{key}=").call( OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]]) ) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end |
#eql?(other) ⇒ Boolean
248 249 250 |
# File 'lib/oci/identity/models/tag.rb', line 248 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
257 258 259 |
# File 'lib/oci/identity/models/tag.rb', line 257 def hash [compartment_id, tag_namespace_id, tag_namespace_name, id, name, description, , , is_retired, lifecycle_state, time_created, is_cost_tracking].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
301 302 303 304 305 306 307 308 309 310 |
# File 'lib/oci/identity/models/tag.rb', line 301 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = public_method(attr).call next if value.nil? && !instance_variable_defined?("@#{attr}") hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
295 296 297 |
# File 'lib/oci/identity/models/tag.rb', line 295 def to_s to_hash.to_s end |