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.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
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 assigned to the tag during creation.
-
#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.
- #validator ⇒ OCI::Identity::Models::BaseTagDefinitionValidator
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
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 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 |
# File 'lib/oci/identity/models/tag.rb', line 155 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? self.validator = attributes[:'validator'] if attributes[:'validator'] end |
Instance Attribute Details
#compartment_id ⇒ String
[Required] The OCID of the compartment that contains the tag definition.
28 29 30 |
# File 'lib/oci/identity/models/tag.rb', line 28 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.
Example: {\"Operations\": {\"CostCenter\": \"42\"}}
67 68 69 |
# File 'lib/oci/identity/models/tag.rb', line 67 def @defined_tags end |
#description ⇒ String
[Required] The description you assign to the tag.
51 52 53 |
# File 'lib/oci/identity/models/tag.rb', line 51 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.
Example: {\"Department\": \"Finance\"}
59 60 61 |
# File 'lib/oci/identity/models/tag.rb', line 59 def @freeform_tags end |
#id ⇒ String
[Required] The OCID of the tag definition.
41 42 43 |
# File 'lib/oci/identity/models/tag.rb', line 41 def id @id end |
#is_cost_tracking ⇒ BOOLEAN
Indicates whether the tag is enabled for cost tracking.
89 90 91 |
# File 'lib/oci/identity/models/tag.rb', line 89 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.
73 74 75 |
# File 'lib/oci/identity/models/tag.rb', line 73 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. If you delete a tag, you cannot delete another tag until the deleted tag's lifecycleState
changes from DELETING to DELETED.
77 78 79 |
# File 'lib/oci/identity/models/tag.rb', line 77 def lifecycle_state @lifecycle_state end |
#name ⇒ String
[Required] The name assigned to the tag during creation. This is the tag key definition. The name must be unique within the tag namespace and cannot be changed.
47 48 49 |
# File 'lib/oci/identity/models/tag.rb', line 47 def name @name end |
#tag_namespace_id ⇒ String
[Required] The OCID of the namespace that contains the tag definition.
32 33 34 |
# File 'lib/oci/identity/models/tag.rb', line 32 def tag_namespace_id @tag_namespace_id end |
#tag_namespace_name ⇒ String
[Required] The name of the tag namespace that contains the tag definition.
37 38 39 |
# File 'lib/oci/identity/models/tag.rb', line 37 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
84 85 86 |
# File 'lib/oci/identity/models/tag.rb', line 84 def time_created @time_created end |
#validator ⇒ OCI::Identity::Models::BaseTagDefinitionValidator
92 93 94 |
# File 'lib/oci/identity/models/tag.rb', line 92 def validator @validator end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 |
# File 'lib/oci/identity/models/tag.rb', line 95 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', 'validator': :'validator' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 |
# File 'lib/oci/identity/models/tag.rb', line 116 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', 'validator': :'OCI::Identity::Models::BaseTagDefinitionValidator' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 |
# File 'lib/oci/identity/models/tag.rb', line 244 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 && validator == other.validator end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 |
# File 'lib/oci/identity/models/tag.rb', line 286 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
266 267 268 |
# File 'lib/oci/identity/models/tag.rb', line 266 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
275 276 277 |
# File 'lib/oci/identity/models/tag.rb', line 275 def hash [compartment_id, tag_namespace_id, tag_namespace_name, id, name, description, , , is_retired, lifecycle_state, time_created, is_cost_tracking, validator].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
319 320 321 322 323 324 325 326 327 328 |
# File 'lib/oci/identity/models/tag.rb', line 319 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
313 314 315 |
# File 'lib/oci/identity/models/tag.rb', line 313 def to_s to_hash.to_s end |