Class: Knievel::ExplainCandidate

Inherits:
ApiModelBase show all
Defined in:
lib/knievel/models/explain_candidate.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ ExplainCandidate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
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
 
# File 'lib/knievel/models/explain_candidate.rb', line 76

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

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

  if attributes.key?(:'ad_id')
    self.ad_id = attributes[:'ad_id']
  else
    self.ad_id = nil
  end

  if attributes.key?(:'creative_id')
    self.creative_id = attributes[:'creative_id']
  else
    self.creative_id = nil
  end

  if attributes.key?(:'flight_id')
    self.flight_id = attributes[:'flight_id']
  else
    self.flight_id = nil
  end

  if attributes.key?(:'campaign_id')
    self.campaign_id = attributes[:'campaign_id']
  else
    self.campaign_id = nil
  end

  if attributes.key?(:'advertiser_id')
    self.advertiser_id = attributes[:'advertiser_id']
  else
    self.advertiser_id = nil
  end

  if attributes.key?(:'weight')
    self.weight = attributes[:'weight']
  else
    self.weight = nil
  end

  if attributes.key?(:'evaluation')
    if (value = attributes[:'evaluation']).is_a?(Array)
      self.evaluation = value
    end
  else
    self.evaluation = nil
  end
end

Instance Attribute Details

#ad_id ⇒ Object

Returns the value of attribute ad_id.



18
19
20
 
# File 'lib/knievel/models/explain_candidate.rb', line 18

def ad_id
  @ad_id
end

#advertiser_id ⇒ Object

Returns the value of attribute advertiser_id.



26
27
28
 
# File 'lib/knievel/models/explain_candidate.rb', line 26

def advertiser_id
  @advertiser_id
end

#campaign_id ⇒ Object

Returns the value of attribute campaign_id.



24
25
26
 
# File 'lib/knievel/models/explain_candidate.rb', line 24

def campaign_id
  @campaign_id
end

#creative_id ⇒ Object

Returns the value of attribute creative_id.



20
21
22
 
# File 'lib/knievel/models/explain_candidate.rb', line 20

def creative_id
  @creative_id
end

#evaluation ⇒ Object

Returns the value of attribute evaluation.



30
31
32
 
# File 'lib/knievel/models/explain_candidate.rb', line 30

def evaluation
  @evaluation
end

#flight_id ⇒ Object

Returns the value of attribute flight_id.



22
23
24
 
# File 'lib/knievel/models/explain_candidate.rb', line 22

def flight_id
  @flight_id
end

#weight ⇒ Object

Returns the value of attribute weight.



28
29
30
 
# File 'lib/knievel/models/explain_candidate.rb', line 28

def weight
  @weight
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



46
47
48
 
# File 'lib/knievel/models/explain_candidate.rb', line 46

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



51
52
53
 
# File 'lib/knievel/models/explain_candidate.rb', line 51

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/knievel/models/explain_candidate.rb', line 33

def self.attribute_map
  {
    :'ad_id' => :'ad_id',
    :'creative_id' => :'creative_id',
    :'flight_id' => :'flight_id',
    :'campaign_id' => :'campaign_id',
    :'advertiser_id' => :'advertiser_id',
    :'weight' => :'weight',
    :'evaluation' => :'evaluation'
  }
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



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/knievel/models/explain_candidate.rb', line 284

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



69
70
71
72
 
# File 'lib/knievel/models/explain_candidate.rb', line 69

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

.openapi_types ⇒ Object

Attribute type mapping.



56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/knievel/models/explain_candidate.rb', line 56

def self.openapi_types
  {
    :'ad_id' => :'Integer',
    :'creative_id' => :'Integer',
    :'flight_id' => :'Integer',
    :'campaign_id' => :'Integer',
    :'advertiser_id' => :'Integer',
    :'weight' => :'Integer',
    :'evaluation' => :'Array<ExplainEvaluation>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/knievel/models/explain_candidate.rb', line 257

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      ad_id == o.ad_id &&
      creative_id == o.creative_id &&
      flight_id == o.flight_id &&
      campaign_id == o.campaign_id &&
      advertiser_id == o.advertiser_id &&
      weight == o.weight &&
      evaluation == o.evaluation
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


271
272
273
 
# File 'lib/knievel/models/explain_candidate.rb', line 271

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



277
278
279
 
# File 'lib/knievel/models/explain_candidate.rb', line 277

def hash
  [ad_id, creative_id, flight_id, campaign_id, advertiser_id, weight, evaluation].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



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
 
# File 'lib/knievel/models/explain_candidate.rb', line 137

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @ad_id.nil?
    invalid_properties.push('invalid value for "ad_id", ad_id cannot be nil.')
  end

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

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

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

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

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

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

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/knievel/models/explain_candidate.rb', line 306

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

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/knievel/models/explain_candidate.rb', line 173

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @ad_id.nil?
  return false if @creative_id.nil?
  return false if @flight_id.nil?
  return false if @campaign_id.nil?
  return false if @advertiser_id.nil?
  return false if @weight.nil?
  return false if @evaluation.nil?
  true
end