Class: OCI::Identity::Models::TagSummary
- Inherits:
-
Object
- Object
- OCI::Identity::Models::TagSummary
- Defined in:
- lib/oci/identity/models/tag_summary.rb
Overview
A tag definition that belongs to a specific tag namespace.
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
The OCID of the compartment that contains the tag definition.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#description ⇒ String
The description you assign to the tag.
-
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource.
-
#id ⇒ String
The OCID of the tag definition.
-
#is_cost_tracking ⇒ BOOLEAN
Indicates whether the tag is enabled for cost tracking.
-
#is_retired ⇒ BOOLEAN
Whether the tag is retired.
-
#lifecycle_state ⇒ String
The tag's current state.
-
#name ⇒ String
The name assigned to the tag during creation.
-
#time_created ⇒ DateTime
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 = {}) ⇒ TagSummary
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 = {}) ⇒ TagSummary
Initializes the object
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 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 |
# File 'lib/oci/identity/models/tag_summary.rb', line 117 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.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
The OCID of the compartment that contains the tag definition.
14 15 16 |
# File 'lib/oci/identity/models/tag_summary.rb', line 14 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\"}}
42 43 44 |
# File 'lib/oci/identity/models/tag_summary.rb', line 42 def @defined_tags end |
#description ⇒ String
The description you assign to the tag.
28 29 30 |
# File 'lib/oci/identity/models/tag_summary.rb', line 28 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\"}
35 36 37 |
# File 'lib/oci/identity/models/tag_summary.rb', line 35 def @freeform_tags end |
#id ⇒ String
The OCID of the tag definition.
18 19 20 |
# File 'lib/oci/identity/models/tag_summary.rb', line 18 def id @id end |
#is_cost_tracking ⇒ BOOLEAN
Indicates whether the tag is enabled for cost tracking.
63 64 65 |
# File 'lib/oci/identity/models/tag_summary.rb', line 63 def is_cost_tracking @is_cost_tracking end |
#is_retired ⇒ BOOLEAN
Whether the tag is retired. See Retiring Key Definitions and Namespace Definitions.
48 49 50 |
# File 'lib/oci/identity/models/tag_summary.rb', line 48 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.
52 53 54 |
# File 'lib/oci/identity/models/tag_summary.rb', line 52 def lifecycle_state @lifecycle_state end |
#name ⇒ String
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.
24 25 26 |
# File 'lib/oci/identity/models/tag_summary.rb', line 24 def name @name end |
#time_created ⇒ DateTime
Date and time the tag was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
58 59 60 |
# File 'lib/oci/identity/models/tag_summary.rb', line 58 def time_created @time_created end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 |
# File 'lib/oci/identity/models/tag_summary.rb', line 66 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'compartment_id': :'compartmentId', '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.
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 |
# File 'lib/oci/identity/models/tag_summary.rb', line 84 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'compartment_id': :'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.
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 |
# File 'lib/oci/identity/models/tag_summary.rb', line 179 def ==(other) return true if equal?(other) self.class == other.class && compartment_id == other.compartment_id && 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
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 |
# File 'lib/oci/identity/models/tag_summary.rb', line 218 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
198 199 200 |
# File 'lib/oci/identity/models/tag_summary.rb', line 198 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
207 208 209 |
# File 'lib/oci/identity/models/tag_summary.rb', line 207 def hash [compartment_id, 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
251 252 253 254 255 256 257 258 259 260 |
# File 'lib/oci/identity/models/tag_summary.rb', line 251 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
245 246 247 |
# File 'lib/oci/identity/models/tag_summary.rb', line 245 def to_s to_hash.to_s end |