Class: SiteimproveAPIClient::RedirectMixedPage

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RedirectMixedPage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
153
 
# File 'lib/siteimprove_api_client/models/redirect_mixed_page.rb', line 97

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

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

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

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

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

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

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

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

Instance Attribute Details

#_siteimprove ⇒ Object

Returns the value of attribute _siteimprove.



48
49
50
 
# File 'lib/siteimprove_api_client/models/redirect_mixed_page.rb', line 48

def _siteimprove
  @_siteimprove
end

#cms_url ⇒ Object

Url for the cms entry for editing the page.



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

def cms_url
  @cms_url
end

#days_since_found ⇒ Object

Days since the redirect was found



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

def days_since_found
  @days_since_found
end

#id ⇒ Object

The id of the page



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

def id
  @id
end

#origin_http_status ⇒ Object

The origin http status



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

def origin_http_status
  @origin_http_status
end

#origin_url ⇒ Object

The origin url



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

def origin_url
  @origin_url
end

#page_level ⇒ Object

Page level in site hierarchy.



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

def page_level
  @page_level
end

#page_views ⇒ Object

Number of times this page has been viewed



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

def page_views
  @page_views
end

#referring_pages ⇒ Object

The number of referring pages



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

def referring_pages
  @referring_pages
end

#title ⇒ Object

Title of the page



22
23
24
 
# File 'lib/siteimprove_api_client/models/redirect_mixed_page.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/redirect_mixed_page.rb', line 25

def url
  @url
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



68
69
70
 
# File 'lib/siteimprove_api_client/models/redirect_mixed_page.rb', line 68

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'id' => :'id',
    :'title' => :'title',
    :'url' => :'url',
    :'cms_url' => :'cms_url',
    :'days_since_found' => :'days_since_found',
    :'origin_http_status' => :'origin_http_status',
    :'origin_url' => :'origin_url',
    :'page_level' => :'page_level',
    :'page_views' => :'page_views',
    :'referring_pages' => :'referring_pages',
    :'_siteimprove' => :'_siteimprove'
  }
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



216
217
218
 
# File 'lib/siteimprove_api_client/models/redirect_mixed_page.rb', line 216

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



90
91
92
93
 
# File 'lib/siteimprove_api_client/models/redirect_mixed_page.rb', line 90

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'id' => :'Integer',
    :'title' => :'String',
    :'url' => :'String',
    :'cms_url' => :'String',
    :'days_since_found' => :'Integer',
    :'origin_http_status' => :'Integer',
    :'origin_url' => :'String',
    :'page_level' => :'Integer',
    :'page_views' => :'Integer',
    :'referring_pages' => :'Integer',
    :'_siteimprove' => :'Siteimprove'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      title == o.title &&
      url == o.url &&
      cms_url == o.cms_url &&
      days_since_found == o.days_since_found &&
      origin_http_status == o.origin_http_status &&
      origin_url == o.origin_url &&
      page_level == o.page_level &&
      page_views == o.page_views &&
      referring_pages == o.referring_pages &&
      _siteimprove == o._siteimprove
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



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
284
 
# File 'lib/siteimprove_api_client/models/redirect_mixed_page.rb', line 247

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



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

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



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

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


203
204
205
 
# File 'lib/siteimprove_api_client/models/redirect_mixed_page.rb', line 203

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



209
210
211
 
# File 'lib/siteimprove_api_client/models/redirect_mixed_page.rb', line 209

def hash
  [id, title, url, cms_url, days_since_found, origin_http_status, origin_url, page_level, page_views, referring_pages, _siteimprove].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



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

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

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

  if @referring_pages.nil?
    invalid_properties.push('invalid value for "referring_pages", referring_pages 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



294
295
296
 
# File 'lib/siteimprove_api_client/models/redirect_mixed_page.rb', line 294

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



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

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



288
289
290
 
# File 'lib/siteimprove_api_client/models/redirect_mixed_page.rb', line 288

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



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

def valid?
  return false if @id.nil?
  return false if @days_since_found.nil?
  return false if @referring_pages.nil?
  true
end