Class: MuxRuby::DeliveryReport

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DeliveryReport

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
177
178
179
180
181
182
183
184
 
# File 'lib/mux_ruby/models/delivery_report.rb', line 124

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#asset_duration ⇒ Object

The duration of the asset in seconds.



37
38
39
 
# File 'lib/mux_ruby/models/delivery_report.rb', line 37

def asset_duration
  @asset_duration
end

#asset_encoding_tier ⇒ Object

This field is deprecated. Please use ‘asset_video_quality` instead. The encoding tier that the asset was ingested at. [See the video quality guide for more details.](docs.mux.com/guides/use-video-quality-levels)



43
44
45
 
# File 'lib/mux_ruby/models/delivery_report.rb', line 43

def asset_encoding_tier
  @asset_encoding_tier
end

#asset_id ⇒ Object

Unique identifier for the asset.



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

def asset_id
  @asset_id
end

#asset_resolution_tier ⇒ Object

The resolution tier that the asset was ingested at, affecting billing for ingest & storage



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

def asset_resolution_tier
  @asset_resolution_tier
end

#asset_state ⇒ Object

The state of the asset.



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

def asset_state
  @asset_state
end

#asset_video_quality ⇒ Object

The video quality that the asset was ingested at. This field replaces ‘asset_encoding_tier`. [See the video quality guide for more details.](docs.mux.com/guides/use-video-quality-levels)



46
47
48
 
# File 'lib/mux_ruby/models/delivery_report.rb', line 46

def asset_video_quality
  @asset_video_quality
end

#created_at ⇒ Object

Time at which the asset was created. Measured in seconds since the Unix epoch.



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

def created_at
  @created_at
end

#deleted_at ⇒ Object

If exists, time at which the asset was deleted. Measured in seconds since the Unix epoch.



31
32
33
 
# File 'lib/mux_ruby/models/delivery_report.rb', line 31

def deleted_at
  @deleted_at
end

#delivered_seconds ⇒ Object

Total number of delivered seconds during this time window.



49
50
51
 
# File 'lib/mux_ruby/models/delivery_report.rb', line 49

def delivered_seconds
  @delivered_seconds
end

#delivered_seconds_by_resolution ⇒ Object

Returns the value of attribute delivered_seconds_by_resolution.



51
52
53
 
# File 'lib/mux_ruby/models/delivery_report.rb', line 51

def delivered_seconds_by_resolution
  @delivered_seconds_by_resolution
end

#live_stream_id ⇒ Object

Unique identifier for the live stream that created the asset.



19
20
21
 
# File 'lib/mux_ruby/models/delivery_report.rb', line 19

def live_stream_id
  @live_stream_id
end

#passthrough ⇒ Object

The ‘passthrough` value for the asset.



25
26
27
 
# File 'lib/mux_ruby/models/delivery_report.rb', line 25

def passthrough
  @passthrough
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



94
95
96
 
# File 'lib/mux_ruby/models/delivery_report.rb', line 94

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/mux_ruby/models/delivery_report.rb', line 76

def self.attribute_map
  {
    :'live_stream_id' => :'live_stream_id',
    :'asset_id' => :'asset_id',
    :'passthrough' => :'passthrough',
    :'created_at' => :'created_at',
    :'deleted_at' => :'deleted_at',
    :'asset_state' => :'asset_state',
    :'asset_duration' => :'asset_duration',
    :'asset_resolution_tier' => :'asset_resolution_tier',
    :'asset_encoding_tier' => :'asset_encoding_tier',
    :'asset_video_quality' => :'asset_video_quality',
    :'delivered_seconds' => :'delivered_seconds',
    :'delivered_seconds_by_resolution' => :'delivered_seconds_by_resolution'
  }
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



281
282
283
 
# File 'lib/mux_ruby/models/delivery_report.rb', line 281

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



117
118
119
120
 
# File 'lib/mux_ruby/models/delivery_report.rb', line 117

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

.openapi_types ⇒ Object

Attribute type mapping.



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/mux_ruby/models/delivery_report.rb', line 99

def self.openapi_types
  {
    :'live_stream_id' => :'String',
    :'asset_id' => :'String',
    :'passthrough' => :'String',
    :'created_at' => :'String',
    :'deleted_at' => :'String',
    :'asset_state' => :'String',
    :'asset_duration' => :'Float',
    :'asset_resolution_tier' => :'String',
    :'asset_encoding_tier' => :'String',
    :'asset_video_quality' => :'String',
    :'delivered_seconds' => :'Float',
    :'delivered_seconds_by_resolution' => :'DeliveryReportDeliveredSecondsByResolution'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/mux_ruby/models/delivery_report.rb', line 249

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      live_stream_id == o.live_stream_id &&
      asset_id == o.asset_id &&
      passthrough == o.passthrough &&
      created_at == o.created_at &&
      deleted_at == o.deleted_at &&
      asset_state == o.asset_state &&
      asset_duration == o.asset_duration &&
      asset_resolution_tier == o.asset_resolution_tier &&
      asset_encoding_tier == o.asset_encoding_tier &&
      asset_video_quality == o.asset_video_quality &&
      delivered_seconds == o.delivered_seconds &&
      delivered_seconds_by_resolution == o.delivered_seconds_by_resolution
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



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/mux_ruby/models/delivery_report.rb', line 311

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



382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/mux_ruby/models/delivery_report.rb', line 382

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



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/mux_ruby/models/delivery_report.rb', line 288

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


268
269
270
 
# File 'lib/mux_ruby/models/delivery_report.rb', line 268

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



274
275
276
 
# File 'lib/mux_ruby/models/delivery_report.rb', line 274

def hash
  [live_stream_id, asset_id, passthrough, created_at, deleted_at, asset_state, asset_duration, asset_resolution_tier, asset_encoding_tier, asset_video_quality, delivered_seconds, delivered_seconds_by_resolution].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



188
189
190
191
 
# File 'lib/mux_ruby/models/delivery_report.rb', line 188

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



358
359
360
 
# File 'lib/mux_ruby/models/delivery_report.rb', line 358

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



364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/mux_ruby/models/delivery_report.rb', line 364

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



352
353
354
 
# File 'lib/mux_ruby/models/delivery_report.rb', line 352

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



195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/mux_ruby/models/delivery_report.rb', line 195

def valid?
  asset_state_validator = EnumAttributeValidator.new('String', ["ready", "errored", "deleted"])
  return false unless asset_state_validator.valid?(@asset_state)
  asset_resolution_tier_validator = EnumAttributeValidator.new('String', ["audio-only", "720p", "1080p", "1440p", "2160p"])
  return false unless asset_resolution_tier_validator.valid?(@asset_resolution_tier)
  asset_encoding_tier_validator = EnumAttributeValidator.new('String', ["smart", "baseline", "premium"])
  return false unless asset_encoding_tier_validator.valid?(@asset_encoding_tier)
  asset_video_quality_validator = EnumAttributeValidator.new('String', ["basic", "plus", "premium"])
  return false unless asset_video_quality_validator.valid?(@asset_video_quality)
  true
end