Class: SiteimproveAPIClient::ContentOptimizationTargetUrlOptimization

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ContentOptimizationTargetUrlOptimization

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/siteimprove_api_client/models/content_optimization_target_url_optimization.rb', line 105

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

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

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

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

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

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

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

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

Instance Attribute Details

#database ⇒ Object

The database for the keyword



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

def database
  @database
end

#h1_occurrences ⇒ Object

The number of occurrences in H1



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

def h1_occurrences
  @h1_occurrences
end

#h2_occurrences ⇒ Object

The number of occurrences in H2



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

def h2_occurrences
  @h2_occurrences
end

#h3_occurrences ⇒ Object

The number of occurrences in H3



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

def h3_occurrences
  @h3_occurrences
end

#keyword ⇒ Object

The keyword string



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

def keyword
  @keyword
end

#meta_description_occurrences ⇒ Object

The number of occurrences in the meta description



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

def meta_description_occurrences
  @meta_description_occurrences
end

#search_volume ⇒ Object

The search volume of the keyword



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

def search_volume
  @search_volume
end

#title_occurrences ⇒ Object

The number of occurrences in the title



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

def title_occurrences
  @title_occurrences
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



79
80
81
 
# File 'lib/siteimprove_api_client/models/content_optimization_target_url_optimization.rb', line 79

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/siteimprove_api_client/models/content_optimization_target_url_optimization.rb', line 65

def self.attribute_map
  {
    :'database' => :'database',
    :'h1_occurrences' => :'h1_occurrences',
    :'h2_occurrences' => :'h2_occurrences',
    :'h3_occurrences' => :'h3_occurrences',
    :'keyword' => :'keyword',
    :'meta_description_occurrences' => :'meta_description_occurrences',
    :'search_volume' => :'search_volume',
    :'title_occurrences' => :'title_occurrences'
  }
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



243
244
245
 
# File 'lib/siteimprove_api_client/models/content_optimization_target_url_optimization.rb', line 243

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



98
99
100
101
 
# File 'lib/siteimprove_api_client/models/content_optimization_target_url_optimization.rb', line 98

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

.openapi_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/siteimprove_api_client/models/content_optimization_target_url_optimization.rb', line 84

def self.openapi_types
  {
    :'database' => :'String',
    :'h1_occurrences' => :'Integer',
    :'h2_occurrences' => :'Integer',
    :'h3_occurrences' => :'Integer',
    :'keyword' => :'String',
    :'meta_description_occurrences' => :'Integer',
    :'search_volume' => :'Integer',
    :'title_occurrences' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/siteimprove_api_client/models/content_optimization_target_url_optimization.rb', line 215

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      database == o.database &&
      h1_occurrences == o.h1_occurrences &&
      h2_occurrences == o.h2_occurrences &&
      h3_occurrences == o.h3_occurrences &&
      keyword == o.keyword &&
      meta_description_occurrences == o.meta_description_occurrences &&
      search_volume == o.search_volume &&
      title_occurrences == o.title_occurrences
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



274
275
276
277
278
279
280
281
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
 
# File 'lib/siteimprove_api_client/models/content_optimization_target_url_optimization.rb', line 274

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



345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/siteimprove_api_client/models/content_optimization_target_url_optimization.rb', line 345

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



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/siteimprove_api_client/models/content_optimization_target_url_optimization.rb', line 250

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


230
231
232
 
# File 'lib/siteimprove_api_client/models/content_optimization_target_url_optimization.rb', line 230

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



236
237
238
 
# File 'lib/siteimprove_api_client/models/content_optimization_target_url_optimization.rb', line 236

def hash
  [database, h1_occurrences, h2_occurrences, h3_occurrences, keyword, meta_description_occurrences, search_volume, title_occurrences].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



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/siteimprove_api_client/models/content_optimization_target_url_optimization.rb', line 155

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

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

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

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

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

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

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



321
322
323
 
# File 'lib/siteimprove_api_client/models/content_optimization_target_url_optimization.rb', line 321

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



327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/siteimprove_api_client/models/content_optimization_target_url_optimization.rb', line 327

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



315
316
317
 
# File 'lib/siteimprove_api_client/models/content_optimization_target_url_optimization.rb', line 315

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



190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/siteimprove_api_client/models/content_optimization_target_url_optimization.rb', line 190

def valid?
  return false if @database.nil?
  database_validator = EnumAttributeValidator.new('String', ["unknown", "bing_united_states", "google_united_arab_emirates", "google_afghanistan", "google_albania", "google_armenia", "google_angola", "google_austria", "google_azerbaijan", "google_bosniaand_herzegovina", "google_bangladesh", "google_belgium", "google_bulgaria", "google_bahrain", "google_brunei", "google_bolivia", "google_botswana", "google_belarus", "google_belize", "google_canada", "google_democratic_republicofthe_congo", "google_switzerland", "google_chile", "google_cameroon", "google_colombia", "google_israel", "google_india", "google_japan", "google_argentina", "google_australia", "google_brazil", "google_hong_kong", "google_mexico", "google_singapore", "google_turkey", "google_united_states", "google_united_kingdom", "google_costa_rica", "google_cape_verde", "google_cyprus", "google_czech_republic", "google_germany", "google_denmark", "google_dominican_republic", "google_algeria", "google_ecuador", "google_estonia", "google_egypt", "google_spain", "google_ethiopia", "google_finland", "google_france", "google_georgia", "google_ghana", "google_greece", "google_guatemala", "google_guyana", "google_honduras", "google_croatia", "google_haiti", "google_hungary", "google_indonesia", "google_ireland", "google_iceland", "google_italy", "google_jamaica", "google_jordan", "google_cambodia", "google_south_korea", "google_kuwait", "google_kazakhstan", "google_lebanon", "google_sri_lanka", "google_lithuania", "google_luxembourg", "google_latvia", "google_libya", "google_morocco", "google_moldova", "google_montenegro", "google_madagascar", "google_mongolia", "google_malta", "google_mauritius", "google_malaysia", "google_mozambique", "google_namibia", "google_nigeria", "google_nicaragua", "google_netherlands", "google_norway", "google_nepal", "google_new_zealand", "google_oman", "google_peru", "google_philippines", "google_poland", "google_portugal", "google_paraguay", "google_romania", "google_serbia", "google_russia", "google_saudi_arabia", "google_sweden", "google_slovenia", "google_slovakia", "google_senegal", "google_el_salvador", "google_thailand", "google_tunisia", "google_trinidadand_tobago", "google_ukraine", "google_uruguay", "google_venezuela", "google_vietnam", "google_south_africa", "google_zambia", "google_zimbabwe", "google_mobile_canada", "google_mobile_indonesia", "google_mobile_israel", "google_mobile_india", "google_mobile_australia", "google_mobile_brazil", "google_mobile_united_states", "google_mobile_mexico", "google_mobile_turkey", "google_mobile_united_kingdom", "google_mobile_germany", "google_mobile_denmark", "google_mobile_spain", "google_mobile_france", "google_mobile_italy", "google_mobile_netherlands", "google_mobile_sweden", "google_mobile_slovakia", "google_mobile_romania", "google_mobile_greece", "google_mobile_colombia"])
  return false unless database_validator.valid?(@database)
  return false if @h1_occurrences.nil?
  return false if @h2_occurrences.nil?
  return false if @h3_occurrences.nil?
  return false if @meta_description_occurrences.nil?
  return false if @search_volume.nil?
  return false if @title_occurrences.nil?
  true
end