Class: OCI::Marketplace::Models::DocumentationLink

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/marketplace/models/documentation_link.rb

Overview

A link to a documentation resource on the internet.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DocumentationLink

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :name (String) —

    The value to assign to the #name property

  • :url (String) —

    The value to assign to the #url property

  • :document_category (String) —

    The value to assign to the #document_category property



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/oci/marketplace/models/documentation_link.rb', line 54

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

Instance Attribute Details

#document_category ⇒ String

The category that the document belongs to.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/marketplace/models/documentation_link.rb', line 21

def document_category
  @document_category
end

#name ⇒ String

Text that describes the resource.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/marketplace/models/documentation_link.rb', line 13

def name
  @name
end

#url ⇒ String

The URL of the resource.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/marketplace/models/documentation_link.rb', line 17

def url
  @url
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



24
25
26
27
28
29
30
31
32
 
# File 'lib/oci/marketplace/models/documentation_link.rb', line 24

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'url': :'url',
    'document_category': :'documentCategory'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



35
36
37
38
39
40
41
42
43
 
# File 'lib/oci/marketplace/models/documentation_link.rb', line 35

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'url': :'String',
    'document_category': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



78
79
80
81
82
83
84
85
 
# File 'lib/oci/marketplace/models/documentation_link.rb', line 78

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    name == other.name &&
    url == other.url &&
    document_category == other.document_category
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/oci/marketplace/models/documentation_link.rb', line 110

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

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


90
91
92
 
# File 'lib/oci/marketplace/models/documentation_link.rb', line 90

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



99
100
101
 
# File 'lib/oci/marketplace/models/documentation_link.rb', line 99

def hash
  [name, url, document_category].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



143
144
145
146
147
148
149
150
151
152
 
# File 'lib/oci/marketplace/models/documentation_link.rb', line 143

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

Returns:

  • (String) —

    String presentation of the object



137
138
139
 
# File 'lib/oci/marketplace/models/documentation_link.rb', line 137

def to_s
  to_hash.to_s
end