class OCI::DataCatalog::Models::BaseTagSummary
Represents the association of an object to a term.
Constants
- LIFECYCLE_STATE_ENUM
Attributes
Unique id of the parent glossary of the term. @return [String]
[Required] Unique tag key that is immutable. @return [String]
State of the Tag. @return [String]
Name of the tag that matches the term name. @return [String]
Description of the related term. @return [String]
Unique key of the related term. @return [String]
Path of the related term. @return [String]
The date and time the tag was created, in the format defined by [RFC3339](tools.ietf.org/html/rfc3339). Example: `2019-03-25T21:10:29.600Z`
@return [DateTime]
URI to the tag instance in the API. @return [String]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/data_catalog/models/base_tag_summary.rb, line 60 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'key': :'key', 'time_created': :'timeCreated', 'name': :'name', 'uri': :'uri', 'term_key': :'termKey', 'term_path': :'termPath', 'term_description': :'termDescription', 'glossary_key': :'glossaryKey', 'lifecycle_state': :'lifecycleState' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :key The value to assign to the {#key} property @option attributes [DateTime] :time_created The value to assign to the {#time_created} property @option attributes [String] :name The value to assign to the {#name} property @option attributes [String] :uri The value to assign to the {#uri} property @option attributes [String] :term_key The value to assign to the {#term_key} property @option attributes [String] :term_path The value to assign to the {#term_path} property @option attributes [String] :term_description The value to assign to the {#term_description} property @option attributes [String] :glossary_key The value to assign to the {#glossary_key} property @option attributes [String] :lifecycle_state The value to assign to the {#lifecycle_state} property
# File lib/oci/data_catalog/models/base_tag_summary.rb, line 108 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.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.name = attributes[:'name'] if attributes[:'name'] self.uri = attributes[:'uri'] if attributes[:'uri'] 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.glossary_key = attributes[:'glossaryKey'] if attributes[:'glossaryKey'] raise 'You cannot provide both :glossaryKey and :glossary_key' if attributes.key?(:'glossaryKey') && attributes.key?(:'glossary_key') self.glossary_key = attributes[:'glossary_key'] if attributes[:'glossary_key'] 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'] end
Attribute type mapping.
# File lib/oci/data_catalog/models/base_tag_summary.rb, line 77 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'key': :'String', 'time_created': :'DateTime', 'name': :'String', 'uri': :'String', 'term_key': :'String', 'term_path': :'String', 'term_description': :'String', 'glossary_key': :'String', 'lifecycle_state': :'String' # rubocop:enable Style/SymbolLiteral } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# File lib/oci/data_catalog/models/base_tag_summary.rb, line 172 def ==(other) return true if equal?(other) self.class == other.class && key == other.key && time_created == other.time_created && name == other.name && uri == other.uri && term_key == other.term_key && term_path == other.term_path && term_description == other.term_description && glossary_key == other.glossary_key && lifecycle_state == other.lifecycle_state end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/oci/data_catalog/models/base_tag_summary.rb, line 210 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
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/data_catalog/models/base_tag_summary.rb, line 190 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/data_catalog/models/base_tag_summary.rb, line 199 def hash [key, time_created, name, uri, term_key, term_path, term_description, glossary_key, lifecycle_state].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] lifecycle_state
Object
to be assigned
# File lib/oci/data_catalog/models/base_tag_summary.rb, line 161 def lifecycle_state=(lifecycle_state) raise "Invalid value for 'lifecycle_state': this must be one of the values in LIFECYCLE_STATE_ENUM." if lifecycle_state && !LIFECYCLE_STATE_ENUM.include?(lifecycle_state) @lifecycle_state = lifecycle_state end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/data_catalog/models/base_tag_summary.rb, line 243 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/data_catalog/models/base_tag_summary.rb, line 237 def to_s to_hash.to_s end
Private Instance Methods
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/oci/data_catalog/models/base_tag_summary.rb, line 260 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end