Class: SiteimproveAPIClient::Document

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Document

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/siteimprove_api_client/models/document.rb', line 107

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `SiteimproveAPIClient::Document` 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::Document`. 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?(:'url')
    self.url = attributes[:'url']
  end

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#_links ⇒ Object

Returns the value of attribute _links.



54
55
56
 
# File 'lib/siteimprove_api_client/models/document.rb', line 54

def _links
  @_links
end

#document_too_large ⇒ Object

Is the document too large to be checked. The current limit is 15mb.



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

def document_too_large
  @document_too_large
end

#documents ⇒ Object

Number of documents that link to the document.



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

def documents
  @documents
end

#failing ⇒ Object

If the document is password protected or otherwise in-accessible.



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

def failing
  @failing
end

#id ⇒ Object

The ID of the document.



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

def id
  @id
end

#is_content_checked ⇒ Object

There is a delay between finding the link, and actually checking the document. "is_content_checked" will be false until the document has been checked.



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

def is_content_checked
  @is_content_checked
end

#is_ok ⇒ Object

Is document available (HTTP 200).



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

def is_ok
  @is_ok
end

#last_modified ⇒ Object

When was the document last modified.



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

def last_modified
  @last_modified
end

#page_views ⇒ Object

Number of times this page has been viewed



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

def page_views
  @page_views
end

#pages ⇒ Object

Number of pages that link to the document.



46
47
48
 
# File 'lib/siteimprove_api_client/models/document.rb', line 46

def pages
  @pages
end

#size_bytes ⇒ Object

Size in bytes.



49
50
51
 
# File 'lib/siteimprove_api_client/models/document.rb', line 49

def size_bytes
  @size_bytes
end

#to_be_checked ⇒ Object

If link has been found, but belongs to a part of the site that have been excluded in settings - "to_be_checked" will be false.



52
53
54
 
# File 'lib/siteimprove_api_client/models/document.rb', line 52

def to_be_checked
  @to_be_checked
end

#url ⇒ Object

The URL of the document.



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

def url
  @url
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



76
77
78
 
# File 'lib/siteimprove_api_client/models/document.rb', line 76

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/siteimprove_api_client/models/document.rb', line 57

def self.attribute_map
  {
    :'id' => :'id',
    :'url' => :'url',
    :'document_too_large' => :'document_too_large',
    :'documents' => :'documents',
    :'failing' => :'failing',
    :'is_content_checked' => :'is_content_checked',
    :'is_ok' => :'is_ok',
    :'last_modified' => :'last_modified',
    :'page_views' => :'page_views',
    :'pages' => :'pages',
    :'size_bytes' => :'size_bytes',
    :'to_be_checked' => :'to_be_checked',
    :'_links' => :'_links'
  }
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



251
252
253
 
# File 'lib/siteimprove_api_client/models/document.rb', line 251

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



100
101
102
103
 
# File 'lib/siteimprove_api_client/models/document.rb', line 100

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

.openapi_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/siteimprove_api_client/models/document.rb', line 81

def self.openapi_types
  {
    :'id' => :'Integer',
    :'url' => :'String',
    :'document_too_large' => :'Boolean',
    :'documents' => :'Integer',
    :'failing' => :'Boolean',
    :'is_content_checked' => :'Boolean',
    :'is_ok' => :'Boolean',
    :'last_modified' => :'Time',
    :'page_views' => :'Integer',
    :'pages' => :'Integer',
    :'size_bytes' => :'Integer',
    :'to_be_checked' => :'Boolean',
    :'_links' => :'Links4'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/siteimprove_api_client/models/document.rb', line 218

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      url == o.url &&
      document_too_large == o.document_too_large &&
      documents == o.documents &&
      failing == o.failing &&
      is_content_checked == o.is_content_checked &&
      is_ok == o.is_ok &&
      last_modified == o.last_modified &&
      page_views == o.page_views &&
      pages == o.pages &&
      size_bytes == o.size_bytes &&
      to_be_checked == o.to_be_checked &&
      _links == o._links
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/siteimprove_api_client/models/document.rb', line 282

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/siteimprove_api_client/models/document.rb', line 353

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/siteimprove_api_client/models/document.rb', line 258

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


238
239
240
 
# File 'lib/siteimprove_api_client/models/document.rb', line 238

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



244
245
246
 
# File 'lib/siteimprove_api_client/models/document.rb', line 244

def hash
  [id, url, document_too_large, documents, failing, is_content_checked, is_ok, last_modified, page_views, pages, size_bytes, to_be_checked, _links].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/siteimprove_api_client/models/document.rb', line 175

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

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

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

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

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

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



329
330
331
 
# File 'lib/siteimprove_api_client/models/document.rb', line 329

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/siteimprove_api_client/models/document.rb', line 335

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

Returns:

  • (String) —

    String presentation of the object



323
324
325
 
# File 'lib/siteimprove_api_client/models/document.rb', line 323

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



206
207
208
209
210
211
212
213
214
 
# File 'lib/siteimprove_api_client/models/document.rb', line 206

def valid?
  return false if @id.nil?
  return false if @document_too_large.nil?
  return false if @failing.nil?
  return false if @is_content_checked.nil?
  return false if @pages.nil?
  return false if @to_be_checked.nil?
  true
end