Class: MuxRuby::AbridgedVideoView

Inherits:
Object
  • Object
show all
Defined in:
lib/mux_ruby/models/abridged_video_view.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AbridgedVideoView

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
172
173
174
175
176
 
# File 'lib/mux_ruby/models/abridged_video_view.rb', line 108

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#country_code ⇒ Object

Returns the value of attribute country_code.



34
35
36
 
# File 'lib/mux_ruby/models/abridged_video_view.rb', line 34

def country_code
  @country_code
end

#error_type_id ⇒ Object

Returns the value of attribute error_type_id.



32
33
34
 
# File 'lib/mux_ruby/models/abridged_video_view.rb', line 32

def error_type_id
  @error_type_id
end

#id ⇒ Object

Returns the value of attribute id.



18
19
20
 
# File 'lib/mux_ruby/models/abridged_video_view.rb', line 18

def id
  @id
end

#playback_failure ⇒ Object

Returns the value of attribute playback_failure.



44
45
46
 
# File 'lib/mux_ruby/models/abridged_video_view.rb', line 44

def playback_failure
  @playback_failure
end

#player_error_code ⇒ Object

Returns the value of attribute player_error_code.



30
31
32
 
# File 'lib/mux_ruby/models/abridged_video_view.rb', line 30

def player_error_code
  @player_error_code
end

#player_error_message ⇒ Object

Returns the value of attribute player_error_message.



28
29
30
 
# File 'lib/mux_ruby/models/abridged_video_view.rb', line 28

def player_error_message
  @player_error_message
end

#total_row_count ⇒ Object

Returns the value of attribute total_row_count.



26
27
28
 
# File 'lib/mux_ruby/models/abridged_video_view.rb', line 26

def total_row_count
  @total_row_count
end

#video_title ⇒ Object

Returns the value of attribute video_title.



24
25
26
 
# File 'lib/mux_ruby/models/abridged_video_view.rb', line 24

def video_title
  @video_title
end

#view_end ⇒ Object

Returns the value of attribute view_end.



38
39
40
 
# File 'lib/mux_ruby/models/abridged_video_view.rb', line 38

def view_end
  @view_end
end

#view_start ⇒ Object

Returns the value of attribute view_start.



36
37
38
 
# File 'lib/mux_ruby/models/abridged_video_view.rb', line 36

def view_start
  @view_start
end

#viewer_application_name ⇒ Object

Returns the value of attribute viewer_application_name.



22
23
24
 
# File 'lib/mux_ruby/models/abridged_video_view.rb', line 22

def viewer_application_name
  @viewer_application_name
end

#viewer_experience_score ⇒ Object

Returns the value of attribute viewer_experience_score.



40
41
42
 
# File 'lib/mux_ruby/models/abridged_video_view.rb', line 40

def viewer_experience_score
  @viewer_experience_score
end

#viewer_os_family ⇒ Object

Returns the value of attribute viewer_os_family.



20
21
22
 
# File 'lib/mux_ruby/models/abridged_video_view.rb', line 20

def viewer_os_family
  @viewer_os_family
end

#watch_time ⇒ Object

Returns the value of attribute watch_time.



42
43
44
 
# File 'lib/mux_ruby/models/abridged_video_view.rb', line 42

def watch_time
  @watch_time
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



67
68
69
 
# File 'lib/mux_ruby/models/abridged_video_view.rb', line 67

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/mux_ruby/models/abridged_video_view.rb', line 47

def self.attribute_map
  {
    :'id' => :'id',
    :'viewer_os_family' => :'viewer_os_family',
    :'viewer_application_name' => :'viewer_application_name',
    :'video_title' => :'video_title',
    :'total_row_count' => :'total_row_count',
    :'player_error_message' => :'player_error_message',
    :'player_error_code' => :'player_error_code',
    :'error_type_id' => :'error_type_id',
    :'country_code' => :'country_code',
    :'view_start' => :'view_start',
    :'view_end' => :'view_end',
    :'viewer_experience_score' => :'viewer_experience_score',
    :'watch_time' => :'watch_time',
    :'playback_failure' => :'playback_failure'
  }
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



227
228
229
 
# File 'lib/mux_ruby/models/abridged_video_view.rb', line 227

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/mux_ruby/models/abridged_video_view.rb', line 92

def self.openapi_nullable
  Set.new([
    :'viewer_os_family',
    :'viewer_application_name',
    :'video_title',
    :'player_error_message',
    :'player_error_code',
    :'error_type_id',
    :'country_code',
    :'viewer_experience_score',
    :'watch_time',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/mux_ruby/models/abridged_video_view.rb', line 72

def self.openapi_types
  {
    :'id' => :'String',
    :'viewer_os_family' => :'String',
    :'viewer_application_name' => :'String',
    :'video_title' => :'String',
    :'total_row_count' => :'Integer',
    :'player_error_message' => :'String',
    :'player_error_code' => :'String',
    :'error_type_id' => :'Integer',
    :'country_code' => :'String',
    :'view_start' => :'String',
    :'view_end' => :'String',
    :'viewer_experience_score' => :'Float',
    :'watch_time' => :'Integer',
    :'playback_failure' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/mux_ruby/models/abridged_video_view.rb', line 193

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      viewer_os_family == o.viewer_os_family &&
      viewer_application_name == o.viewer_application_name &&
      video_title == o.video_title &&
      total_row_count == o.total_row_count &&
      player_error_message == o.player_error_message &&
      player_error_code == o.player_error_code &&
      error_type_id == o.error_type_id &&
      country_code == o.country_code &&
      view_start == o.view_start &&
      view_end == o.view_end &&
      viewer_experience_score == o.viewer_experience_score &&
      watch_time == o.watch_time &&
      playback_failure == o.playback_failure
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



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
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/mux_ruby/models/abridged_video_view.rb', line 257

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 = MuxRuby.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



328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/mux_ruby/models/abridged_video_view.rb', line 328

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



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/mux_ruby/models/abridged_video_view.rb', line 234

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  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


214
215
216
 
# File 'lib/mux_ruby/models/abridged_video_view.rb', line 214

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



220
221
222
 
# File 'lib/mux_ruby/models/abridged_video_view.rb', line 220

def hash
  [id, viewer_os_family, viewer_application_name, video_title, total_row_count, player_error_message, player_error_code, error_type_id, country_code, view_start, view_end, viewer_experience_score, watch_time, playback_failure].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



180
181
182
183
 
# File 'lib/mux_ruby/models/abridged_video_view.rb', line 180

def list_invalid_properties
  invalid_properties = Array.new
  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



304
305
306
 
# File 'lib/mux_ruby/models/abridged_video_view.rb', line 304

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



310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/mux_ruby/models/abridged_video_view.rb', line 310

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



298
299
300
 
# File 'lib/mux_ruby/models/abridged_video_view.rb', line 298

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



187
188
189
 
# File 'lib/mux_ruby/models/abridged_video_view.rb', line 187

def valid?
  true
end