Class: MuxRuby::Upload

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Upload

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/mux_ruby/models/upload.rb', line 86

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

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

  if attributes.has_key?(:'timeout')
    self.timeout = attributes[:'timeout']
  else
    self.timeout = 3600
  end

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

  if attributes.has_key?(:'new_asset_settings')
    self.new_asset_settings = attributes[:'new_asset_settings']
  end

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

  if attributes.has_key?(:'error')
    self.error = attributes[:'error']
  end

  if attributes.has_key?(:'cors_origin')
    self.cors_origin = attributes[:'cors_origin']
  end

  if attributes.has_key?(:'url')
    self.url = attributes[:'url']
  end

  if attributes.has_key?(:'test')
    self.test = attributes[:'test']
  end
end

Instance Attribute Details

#asset_id ⇒ Object

Only set once the upload is in the ‘asset_created` state.



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

def asset_id
  @asset_id
end

#cors_origin ⇒ Object

If the upload URL will be used in a browser, you must specify the origin in order for the signed URL to have the correct CORS headers.



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

def cors_origin
  @cors_origin
end

#error ⇒ Object

Returns the value of attribute error.



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

def error
  @error
end

#id ⇒ Object

Returns the value of attribute id.



10
11
12
 
# File 'lib/mux_ruby/models/upload.rb', line 10

def id
  @id
end

#new_asset_settings ⇒ Object

Returns the value of attribute new_asset_settings.



17
18
19
 
# File 'lib/mux_ruby/models/upload.rb', line 17

def new_asset_settings
  @new_asset_settings
end

#status ⇒ Object

Returns the value of attribute status.



15
16
17
 
# File 'lib/mux_ruby/models/upload.rb', line 15

def status
  @status
end

#test ⇒ Object

Returns the value of attribute test.



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

def test
  @test
end

#timeout ⇒ Object

Max time in seconds for the signed upload URL to be valid. If a successful upload has not occurred before the timeout limit, the direct upload is marked ‘timed_out`



13
14
15
 
# File 'lib/mux_ruby/models/upload.rb', line 13

def timeout
  @timeout
end

#url ⇒ Object

The URL to upload the associated source media to.



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

def url
  @url
end

Class Method Details

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/mux_ruby/models/upload.rb', line 55

def self.attribute_map
  {
    :'id' => :'id',
    :'timeout' => :'timeout',
    :'status' => :'status',
    :'new_asset_settings' => :'new_asset_settings',
    :'asset_id' => :'asset_id',
    :'error' => :'error',
    :'cors_origin' => :'cors_origin',
    :'url' => :'url',
    :'test' => :'test'
  }
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



211
212
213
 
# File 'lib/mux_ruby/models/upload.rb', line 211

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

.openapi_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/mux_ruby/models/upload.rb', line 70

def self.openapi_types
  {
    :'id' => :'String',
    :'timeout' => :'Integer',
    :'status' => :'String',
    :'new_asset_settings' => :'Asset',
    :'asset_id' => :'String',
    :'error' => :'UploadError',
    :'cors_origin' => :'String',
    :'url' => :'String',
    :'test' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/mux_ruby/models/upload.rb', line 182

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      timeout == o.timeout &&
      status == o.status &&
      new_asset_settings == o.new_asset_settings &&
      asset_id == o.asset_id &&
      error == o.error &&
      cors_origin == o.cors_origin &&
      url == o.url &&
      test == o.test
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



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/mux_ruby/models/upload.rb', line 239

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    MuxRuby.const_get(type).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



304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/mux_ruby/models/upload.rb', line 304

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



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/mux_ruby/models/upload.rb', line 218

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


198
199
200
 
# File 'lib/mux_ruby/models/upload.rb', line 198

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



204
205
206
 
# File 'lib/mux_ruby/models/upload.rb', line 204

def hash
  [id, timeout, status, new_asset_settings, asset_id, error, cors_origin, url, test].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



133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/mux_ruby/models/upload.rb', line 133

def list_invalid_properties
  invalid_properties = Array.new
  if !@timeout.nil? && @timeout > 604800
    invalid_properties.push('invalid value for "timeout", must be smaller than or equal to 604800.')
  end

  if !@timeout.nil? && @timeout < 60
    invalid_properties.push('invalid value for "timeout", must be greater than or equal to 60.')
  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



284
285
286
 
# File 'lib/mux_ruby/models/upload.rb', line 284

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



290
291
292
293
294
295
296
297
298
 
# File 'lib/mux_ruby/models/upload.rb', line 290

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



278
279
280
 
# File 'lib/mux_ruby/models/upload.rb', line 278

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



148
149
150
151
152
153
154
 
# File 'lib/mux_ruby/models/upload.rb', line 148

def valid?
  return false if !@timeout.nil? && @timeout > 604800
  return false if !@timeout.nil? && @timeout < 60
  status_validator = EnumAttributeValidator.new('String', ['waiting', 'asset_created', 'errored', 'cancelled', 'timed_out'])
  return false unless status_validator.valid?(@status)
  true
end