class OCI::DataCatalog::Models::SearchTermSummary
Summary of a term associated with an object. This is a brief summary returned as part of the search result.
Attributes
[Required] A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
@return [String]
Unique id of the parent glossary. @return [String]
Name of the parent glossary. @return [String]
Unique term key that is immutable. @return [String]
This terms parent term key. Will be null if the term has no parent term. @return [String]
Name of the parent term key. Will be null if the term has no parent term. @return [String]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/data_catalog/models/search_term_summary.rb, line 38 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'key': :'key', 'display_name': :'displayName', 'glossary_key': :'glossaryKey', 'glossary_name': :'glossaryName', 'parent_term_key': :'parentTermKey', 'parent_term_name': :'parentTermName' # 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 [String] :display_name The value to assign to the {#display_name} property @option attributes [String] :glossary_key The value to assign to the {#glossary_key} property @option attributes [String] :glossary_name The value to assign to the {#glossary_name} property @option attributes [String] :parent_term_key The value to assign to the {#parent_term_key} property @option attributes [String] :parent_term_name The value to assign to the {#parent_term_name} property
# File lib/oci/data_catalog/models/search_term_summary.rb, line 77 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.display_name = attributes[:'displayName'] if attributes[:'displayName'] raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name') self.display_name = attributes[:'display_name'] if attributes[:'display_name'] 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.glossary_name = attributes[:'glossaryName'] if attributes[:'glossaryName'] raise 'You cannot provide both :glossaryName and :glossary_name' if attributes.key?(:'glossaryName') && attributes.key?(:'glossary_name') self.glossary_name = attributes[:'glossary_name'] if attributes[:'glossary_name'] self.parent_term_key = attributes[:'parentTermKey'] if attributes[:'parentTermKey'] raise 'You cannot provide both :parentTermKey and :parent_term_key' if attributes.key?(:'parentTermKey') && attributes.key?(:'parent_term_key') self.parent_term_key = attributes[:'parent_term_key'] if attributes[:'parent_term_key'] self.parent_term_name = attributes[:'parentTermName'] if attributes[:'parentTermName'] raise 'You cannot provide both :parentTermName and :parent_term_name' if attributes.key?(:'parentTermName') && attributes.key?(:'parent_term_name') self.parent_term_name = attributes[:'parent_term_name'] if attributes[:'parent_term_name'] end
Attribute type mapping.
# File lib/oci/data_catalog/models/search_term_summary.rb, line 52 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'key': :'String', 'display_name': :'String', 'glossary_key': :'String', 'glossary_name': :'String', 'parent_term_key': :'String', 'parent_term_name': :'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/search_term_summary.rb, line 123 def ==(other) return true if equal?(other) self.class == other.class && key == other.key && display_name == other.display_name && glossary_key == other.glossary_key && glossary_name == other.glossary_name && parent_term_key == other.parent_term_key && parent_term_name == other.parent_term_name 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/search_term_summary.rb, line 158 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/search_term_summary.rb, line 138 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/data_catalog/models/search_term_summary.rb, line 147 def hash [key, display_name, glossary_key, glossary_name, parent_term_key, parent_term_name].hash 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/search_term_summary.rb, line 191 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/search_term_summary.rb, line 185 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/search_term_summary.rb, line 208 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