class OCI::Marketplace::Models::DocumentationLink
A link to a documentation resource on the internet.
Attributes
The category that the document belongs to. @return [String]
Text that describes the resource. @return [String]
The URL of the resource. @return [String]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/marketplace/models/documentation_link.rb, line 23 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'name': :'name', 'url': :'url', 'document_category': :'documentCategory' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :name The value to assign to the {#name} property @option attributes [String] :url The value to assign to the {#url} property @option attributes [String] :document_category The value to assign to the {#document_category} property
# File lib/oci/marketplace/models/documentation_link.rb, line 53 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.name = attributes[:'name'] if attributes[:'name'] self.url = attributes[:'url'] if attributes[:'url'] self.document_category = attributes[:'documentCategory'] if attributes[:'documentCategory'] raise 'You cannot provide both :documentCategory and :document_category' if attributes.key?(:'documentCategory') && attributes.key?(:'document_category') self.document_category = attributes[:'document_category'] if attributes[:'document_category'] end
Attribute type mapping.
# File lib/oci/marketplace/models/documentation_link.rb, line 34 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'name': :'String', 'url': :'String', 'document_category': :'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/marketplace/models/documentation_link.rb, line 77 def ==(other) return true if equal?(other) self.class == other.class && name == other.name && url == other.url && document_category == other.document_category 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/marketplace/models/documentation_link.rb, line 109 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/marketplace/models/documentation_link.rb, line 89 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/marketplace/models/documentation_link.rb, line 98 def hash [name, url, document_category].hash end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/marketplace/models/documentation_link.rb, line 142 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/marketplace/models/documentation_link.rb, line 136 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/marketplace/models/documentation_link.rb, line 159 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