Class: MuxRuby::StaticRendition

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ StaticRendition

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
185
 
# File 'lib/mux_ruby/models/static_rendition.rb', line 125

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#bitrate ⇒ Object

The bitrate in bits per second



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

def bitrate
  @bitrate
end

#ext ⇒ Object

Extension of the static rendition file



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

def ext
  @ext
end

#filesize ⇒ Object

The file size in bytes



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

def filesize
  @filesize
end

#height ⇒ Object

The height of the static rendition’s file in pixels



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

def height
  @height
end

#id ⇒ Object

The ID of this static rendition, used in managing this static rendition. This field is only valid for ‘static_renditions`, not for `mp4_support`.



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

def id
  @id
end

#name ⇒ Object

Name of the static rendition file



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

def name
  @name
end

#passthrough ⇒ Object

Arbitrary user-supplied metadata set for the static rendition. Max 255 characters.



52
53
54
 
# File 'lib/mux_ruby/models/static_rendition.rb', line 52

def passthrough
  @passthrough
end

#resolution ⇒ Object

Indicates the resolution of this specific MP4 version of this asset. This field is only valid for ‘static_renditions`, not for `mp4_support`.



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

def resolution
  @resolution
end

#resolution_tier ⇒ Object

Indicates the resolution tier of this specific MP4 version of this asset. This field is only valid for ‘static_renditions`, not for `mp4_support`.



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

def resolution_tier
  @resolution_tier
end

#status ⇒ Object

Indicates the status of this specific MP4 version of this asset. This field is only valid for ‘static_renditions`, not for `mp4_support`. * `ready` indicates the MP4 has been generated and is ready for download * `preparing` indicates the asset has not been ingested or the static rendition is still being generated after an asset is ready * `skipped` indicates the static rendition will not be generated because the requested resolution conflicts with the asset attributes after the asset has been ingested * `errored` indicates the static rendition cannot be generated. For example, an asset could not be ingested



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

def status
  @status
end

#type ⇒ Object

Indicates the static rendition type of this specific MP4 version of this asset. This field is only valid for ‘static_renditions`, not for `mp4_support`.



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

def type
  @type
end

#width ⇒ Object

The width of the static rendition’s file in pixels



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

def width
  @width
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



95
96
97
 
# File 'lib/mux_ruby/models/static_rendition.rb', line 95

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'name' => :'name',
    :'ext' => :'ext',
    :'height' => :'height',
    :'width' => :'width',
    :'bitrate' => :'bitrate',
    :'filesize' => :'filesize',
    :'type' => :'type',
    :'status' => :'status',
    :'resolution_tier' => :'resolution_tier',
    :'resolution' => :'resolution',
    :'id' => :'id',
    :'passthrough' => :'passthrough'
  }
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



306
307
308
 
# File 'lib/mux_ruby/models/static_rendition.rb', line 306

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



118
119
120
121
 
# File 'lib/mux_ruby/models/static_rendition.rb', line 118

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'name' => :'String',
    :'ext' => :'String',
    :'height' => :'Integer',
    :'width' => :'Integer',
    :'bitrate' => :'Integer',
    :'filesize' => :'String',
    :'type' => :'String',
    :'status' => :'String',
    :'resolution_tier' => :'String',
    :'resolution' => :'String',
    :'id' => :'String',
    :'passthrough' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/mux_ruby/models/static_rendition.rb', line 274

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      ext == o.ext &&
      height == o.height &&
      width == o.width &&
      bitrate == o.bitrate &&
      filesize == o.filesize &&
      type == o.type &&
      status == o.status &&
      resolution_tier == o.resolution_tier &&
      resolution == o.resolution &&
      id == o.id &&
      passthrough == o.passthrough
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



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/mux_ruby/models/static_rendition.rb', line 336

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



407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/mux_ruby/models/static_rendition.rb', line 407

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



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/mux_ruby/models/static_rendition.rb', line 313

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


293
294
295
 
# File 'lib/mux_ruby/models/static_rendition.rb', line 293

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



299
300
301
 
# File 'lib/mux_ruby/models/static_rendition.rb', line 299

def hash
  [name, ext, height, width, bitrate, filesize, type, status, resolution_tier, resolution, id, passthrough].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



189
190
191
192
 
# File 'lib/mux_ruby/models/static_rendition.rb', line 189

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



383
384
385
 
# File 'lib/mux_ruby/models/static_rendition.rb', line 383

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



389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/mux_ruby/models/static_rendition.rb', line 389

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



377
378
379
 
# File 'lib/mux_ruby/models/static_rendition.rb', line 377

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



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

def valid?
  name_validator = EnumAttributeValidator.new('String', ["low.mp4", "medium.mp4", "high.mp4", "highest.mp4", "audio.m4a", "capped-1080p.mp4", "2160p.mp4", "1440p.mp4", "1080p.mp4", "720p.mp4", "540p.mp4", "480p.mp4", "360p.mp4", "270p.mp4"])
  return false unless name_validator.valid?(@name)
  ext_validator = EnumAttributeValidator.new('String', ["mp4", "m4a"])
  return false unless ext_validator.valid?(@ext)
  type_validator = EnumAttributeValidator.new('String', ["standard", "advanced"])
  return false unless type_validator.valid?(@type)
  status_validator = EnumAttributeValidator.new('String', ["ready", "preparing", "skipped", "errored"])
  return false unless status_validator.valid?(@status)
  resolution_tier_validator = EnumAttributeValidator.new('String', ["2160p", "1440p", "1080p", "720p", "audio-only"])
  return false unless resolution_tier_validator.valid?(@resolution_tier)
  resolution_validator = EnumAttributeValidator.new('String', ["highest", "audio-only", "2160p", "1440p", "1080p", "720p", "540p", "480p", "360p", "270p"])
  return false unless resolution_validator.valid?(@resolution)
  true
end