Class: SiteimproveAPIClient::PageWithBrokenLink

Inherits:
Object
  • Object
show all
Defined in:
lib/siteimprove_api_client/models/page_with_broken_link.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PageWithBrokenLink

Initializes the object



96
97
98
99
100
101
102
103
104
105
106
107
108
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
 
# File 'lib/siteimprove_api_client/models/page_with_broken_link.rb', line 96

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `SiteimproveAPIClient::PageWithBrokenLink` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `SiteimproveAPIClient::PageWithBrokenLink`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'title')
    self.title = attributes[:'title']
  end

  if attributes.key?(:'url')
    self.url = attributes[:'url']
  end

  if attributes.key?(:'broken_links')
    self.broken_links = attributes[:'broken_links']
  end

  if attributes.key?(:'checking_now')
    self.checking_now = attributes[:'checking_now']
  end

  if attributes.key?(:'cms_url')
    self.cms_url = attributes[:'cms_url']
  end

  if attributes.key?(:'page_level')
    self.page_level = attributes[:'page_level']
  end

  if attributes.key?(:'page_score')
    self.page_score = attributes[:'page_score']
  end

  if attributes.key?(:'page_views')
    self.page_views = attributes[:'page_views']
  end

  if attributes.key?(:'_links')
    self._links = attributes[:'_links']
  end

  if attributes.key?(:'_siteimprove')
    self._siteimprove = attributes[:'_siteimprove']
  end
end

Instance Attribute Details

#_links ⇒ Object

Returns the value of attribute _links.



45
46
47
 
# File 'lib/siteimprove_api_client/models/page_with_broken_link.rb', line 45

def _links
  @_links
end

#_siteimprove ⇒ Object

Returns the value of attribute _siteimprove.



47
48
49
 
# File 'lib/siteimprove_api_client/models/page_with_broken_link.rb', line 47

def _siteimprove
  @_siteimprove
end

#broken_links ⇒ Object

Number of broken links on this page.



28
29
30
 
# File 'lib/siteimprove_api_client/models/page_with_broken_link.rb', line 28

def broken_links
  @broken_links
end

#checking_now ⇒ Object

Is true if page is being checked now; otherwise false.



31
32
33
 
# File 'lib/siteimprove_api_client/models/page_with_broken_link.rb', line 31

def checking_now
  @checking_now
end

#cms_url ⇒ Object

Url for the cms entry for editing the page.



34
35
36
 
# File 'lib/siteimprove_api_client/models/page_with_broken_link.rb', line 34

def cms_url
  @cms_url
end

#id ⇒ Object

Id of page.



19
20
21
 
# File 'lib/siteimprove_api_client/models/page_with_broken_link.rb', line 19

def id
  @id
end

#page_level ⇒ Object

Page level in site hierarchy.



37
38
39
 
# File 'lib/siteimprove_api_client/models/page_with_broken_link.rb', line 37

def page_level
  @page_level
end

#page_score ⇒ Object

The page score of the page. This requires integration with Quality Assurance.



40
41
42
 
# File 'lib/siteimprove_api_client/models/page_with_broken_link.rb', line 40

def page_score
  @page_score
end

#page_views ⇒ Object

Number of times this page has been viewed



43
44
45
 
# File 'lib/siteimprove_api_client/models/page_with_broken_link.rb', line 43

def page_views
  @page_views
end

#title ⇒ Object

Title of the page



22
23
24
 
# File 'lib/siteimprove_api_client/models/page_with_broken_link.rb', line 22

def title
  @title
end

#url ⇒ Object

URL for the live version of the page.



25
26
27
 
# File 'lib/siteimprove_api_client/models/page_with_broken_link.rb', line 25

def url
  @url
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



67
68
69
 
# File 'lib/siteimprove_api_client/models/page_with_broken_link.rb', line 67

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/siteimprove_api_client/models/page_with_broken_link.rb', line 50

def self.attribute_map
  {
    :'id' => :'id',
    :'title' => :'title',
    :'url' => :'url',
    :'broken_links' => :'broken_links',
    :'checking_now' => :'checking_now',
    :'cms_url' => :'cms_url',
    :'page_level' => :'page_level',
    :'page_score' => :'page_score',
    :'page_views' => :'page_views',
    :'_links' => :'_links',
    :'_siteimprove' => :'_siteimprove'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



215
216
217
 
# File 'lib/siteimprove_api_client/models/page_with_broken_link.rb', line 215

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



89
90
91
92
 
# File 'lib/siteimprove_api_client/models/page_with_broken_link.rb', line 89

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/siteimprove_api_client/models/page_with_broken_link.rb', line 72

def self.openapi_types
  {
    :'id' => :'Integer',
    :'title' => :'String',
    :'url' => :'String',
    :'broken_links' => :'Integer',
    :'checking_now' => :'Boolean',
    :'cms_url' => :'String',
    :'page_level' => :'Integer',
    :'page_score' => :'Float',
    :'page_views' => :'Integer',
    :'_links' => :'Links54',
    :'_siteimprove' => :'Siteimprove2'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/siteimprove_api_client/models/page_with_broken_link.rb', line 184

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      title == o.title &&
      url == o.url &&
      broken_links == o.broken_links &&
      checking_now == o.checking_now &&
      cms_url == o.cms_url &&
      page_level == o.page_level &&
      page_score == o.page_score &&
      page_views == o.page_views &&
      _links == o._links &&
      _siteimprove == o._siteimprove
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/siteimprove_api_client/models/page_with_broken_link.rb', line 246

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = SiteimproveAPIClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/siteimprove_api_client/models/page_with_broken_link.rb', line 317

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

#build_from_hash(attributes) ⇒ Object

Builds the object from hash



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/siteimprove_api_client/models/page_with_broken_link.rb', line 222

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


202
203
204
 
# File 'lib/siteimprove_api_client/models/page_with_broken_link.rb', line 202

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



208
209
210
 
# File 'lib/siteimprove_api_client/models/page_with_broken_link.rb', line 208

def hash
  [id, title, url, broken_links, checking_now, cms_url, page_level, page_score, page_views, _links, _siteimprove].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/siteimprove_api_client/models/page_with_broken_link.rb', line 156

def list_invalid_properties
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  if @broken_links.nil?
    invalid_properties.push('invalid value for "broken_links", broken_links cannot be nil.')
  end

  if @checking_now.nil?
    invalid_properties.push('invalid value for "checking_now", checking_now cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



293
294
295
 
# File 'lib/siteimprove_api_client/models/page_with_broken_link.rb', line 293

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/siteimprove_api_client/models/page_with_broken_link.rb', line 299

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object



287
288
289
 
# File 'lib/siteimprove_api_client/models/page_with_broken_link.rb', line 287

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



175
176
177
178
179
180
 
# File 'lib/siteimprove_api_client/models/page_with_broken_link.rb', line 175

def valid?
  return false if @id.nil?
  return false if @broken_links.nil?
  return false if @checking_now.nil?
  true
end