Class: OCI::DataCatalog::Models::BaseTag
- Inherits:
-
Object
- Object
- OCI::DataCatalog::Models::BaseTag
- Defined in:
- lib/oci/data_catalog/models/base_tag.rb
Overview
Represents the association of an object to a term. Tags are immutable.
Constant Summary collapse
- LIFECYCLE_STATE_ENUM =
[ LIFECYCLE_STATE_CREATING = 'CREATING'.freeze, LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze, LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze, LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze, LIFECYCLE_STATE_DELETING = 'DELETING'.freeze, LIFECYCLE_STATE_DELETED = 'DELETED'.freeze, LIFECYCLE_STATE_FAILED = 'FAILED'.freeze, LIFECYCLE_STATE_MOVING = 'MOVING'.freeze ].freeze
Instance Attribute Summary collapse
-
#created_by_id ⇒ String
OCID of the user who created the tag.
-
#key ⇒ String
[Required] Unique tag key that is immutable.
-
#lifecycle_state ⇒ String
The current state of the tag.
-
#name ⇒ String
Name of the tag which matches the term name.
-
#term_description ⇒ String
Description of the related term.
-
#term_key ⇒ String
Unique key of the related term.
-
#term_path ⇒ String
Path of the related term.
-
#time_created ⇒ DateTime
The date and time the tag was created, in the format defined by RFC3339.
-
#uri ⇒ String
URI to the tag instance in the API.
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 = {}) ⇒ BaseTag
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 = {}) ⇒ BaseTag
Initializes the object
109 110 111 112 113 114 115 116 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 |
# File 'lib/oci/data_catalog/models/base_tag.rb', line 109 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.key = attributes[:'key'] if attributes[:'key'] self.name = attributes[:'name'] if attributes[:'name'] self.term_key = attributes[:'termKey'] if attributes[:'termKey'] raise 'You cannot provide both :termKey and :term_key' if attributes.key?(:'termKey') && attributes.key?(:'term_key') self.term_key = attributes[:'term_key'] if attributes[:'term_key'] self.term_path = attributes[:'termPath'] if attributes[:'termPath'] raise 'You cannot provide both :termPath and :term_path' if attributes.key?(:'termPath') && attributes.key?(:'term_path') self.term_path = attributes[:'term_path'] if attributes[:'term_path'] self.term_description = attributes[:'termDescription'] if attributes[:'termDescription'] raise 'You cannot provide both :termDescription and :term_description' if attributes.key?(:'termDescription') && attributes.key?(:'term_description') self.term_description = attributes[:'term_description'] if attributes[:'term_description'] 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.created_by_id = attributes[:'createdById'] if attributes[:'createdById'] raise 'You cannot provide both :createdById and :created_by_id' if attributes.key?(:'createdById') && attributes.key?(:'created_by_id') self.created_by_id = attributes[:'created_by_id'] if attributes[:'created_by_id'] self.uri = attributes[:'uri'] if attributes[:'uri'] end |
Instance Attribute Details
#created_by_id ⇒ String
OCID of the user who created the tag.
54 55 56 |
# File 'lib/oci/data_catalog/models/base_tag.rb', line 54 def created_by_id @created_by_id end |
#key ⇒ String
[Required] Unique tag key that is immutable.
24 25 26 |
# File 'lib/oci/data_catalog/models/base_tag.rb', line 24 def key @key end |
#lifecycle_state ⇒ String
The current state of the tag.
44 45 46 |
# File 'lib/oci/data_catalog/models/base_tag.rb', line 44 def lifecycle_state @lifecycle_state end |
#name ⇒ String
Name of the tag which matches the term name.
28 29 30 |
# File 'lib/oci/data_catalog/models/base_tag.rb', line 28 def name @name end |
#term_description ⇒ String
Description of the related term.
40 41 42 |
# File 'lib/oci/data_catalog/models/base_tag.rb', line 40 def term_description @term_description end |
#term_key ⇒ String
Unique key of the related term.
32 33 34 |
# File 'lib/oci/data_catalog/models/base_tag.rb', line 32 def term_key @term_key end |
#term_path ⇒ String
Path of the related term.
36 37 38 |
# File 'lib/oci/data_catalog/models/base_tag.rb', line 36 def term_path @term_path end |
#time_created ⇒ DateTime
The date and time the tag was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z
50 51 52 |
# File 'lib/oci/data_catalog/models/base_tag.rb', line 50 def time_created @time_created end |
#uri ⇒ String
URI to the tag instance in the API.
58 59 60 |
# File 'lib/oci/data_catalog/models/base_tag.rb', line 58 def uri @uri end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 |
# File 'lib/oci/data_catalog/models/base_tag.rb', line 61 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'key': :'key', 'name': :'name', 'term_key': :'termKey', 'term_path': :'termPath', 'term_description': :'termDescription', 'lifecycle_state': :'lifecycleState', 'time_created': :'timeCreated', 'created_by_id': :'createdById', 'uri': :'uri' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 |
# File 'lib/oci/data_catalog/models/base_tag.rb', line 78 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'key': :'String', 'name': :'String', 'term_key': :'String', 'term_path': :'String', 'term_description': :'String', 'lifecycle_state': :'String', 'time_created': :'DateTime', 'created_by_id': :'String', 'uri': :'String' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
173 174 175 176 177 178 179 180 181 182 183 184 185 186 |
# File 'lib/oci/data_catalog/models/base_tag.rb', line 173 def ==(other) return true if equal?(other) self.class == other.class && key == other.key && name == other.name && term_key == other.term_key && term_path == other.term_path && term_description == other.term_description && lifecycle_state == other.lifecycle_state && time_created == other.time_created && created_by_id == other.created_by_id && uri == other.uri end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 |
# File 'lib/oci/data_catalog/models/base_tag.rb', line 211 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
191 192 193 |
# File 'lib/oci/data_catalog/models/base_tag.rb', line 191 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
200 201 202 |
# File 'lib/oci/data_catalog/models/base_tag.rb', line 200 def hash [key, name, term_key, term_path, term_description, lifecycle_state, time_created, created_by_id, uri].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
244 245 246 247 248 249 250 251 252 253 |
# File 'lib/oci/data_catalog/models/base_tag.rb', line 244 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
238 239 240 |
# File 'lib/oci/data_catalog/models/base_tag.rb', line 238 def to_s to_hash.to_s end |