Class: MuxRuby::Upload
- Inherits:
-
Object
- Object
- MuxRuby::Upload
- Defined in:
- lib/mux_ruby/models/upload.rb
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#asset_id ⇒ Object
Only set once the upload is in the ‘asset_created` state.
-
#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.
-
#error ⇒ Object
Returns the value of attribute error.
-
#id ⇒ Object
Unique identifier for the Direct Upload.
-
#new_asset_settings ⇒ Object
Returns the value of attribute new_asset_settings.
-
#status ⇒ Object
Returns the value of attribute status.
-
#test ⇒ Object
Indicates if this is a test Direct Upload, in which case the Asset that gets created will be a ‘test` Asset.
-
#timeout ⇒ Object
Max time in seconds for the signed upload URL to be valid.
-
#url ⇒ Object
The URL to upload the associated source media to.
Class Method Summary collapse
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about.
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Upload
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ Upload
Initializes the object
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 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 |
# File 'lib/mux_ruby/models/upload.rb', line 107 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `MuxRuby::Upload` 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::Upload`. 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?(:'timeout') self.timeout = attributes[:'timeout'] else self.timeout = 3600 end if attributes.key?(:'status') self.status = attributes[:'status'] end if attributes.key?(:'new_asset_settings') self.new_asset_settings = attributes[:'new_asset_settings'] end if attributes.key?(:'asset_id') self.asset_id = attributes[:'asset_id'] end if attributes.key?(:'error') self.error = attributes[:'error'] end if attributes.key?(:'cors_origin') self.cors_origin = attributes[:'cors_origin'] end if attributes.key?(:'url') self.url = attributes[:'url'] end if attributes.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.
29 30 31 |
# File 'lib/mux_ruby/models/upload.rb', line 29 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.
34 35 36 |
# File 'lib/mux_ruby/models/upload.rb', line 34 def cors_origin @cors_origin end |
#error ⇒ Object
Returns the value of attribute error.
31 32 33 |
# File 'lib/mux_ruby/models/upload.rb', line 31 def error @error end |
#id ⇒ Object
Unique identifier for the Direct Upload.
19 20 21 |
# File 'lib/mux_ruby/models/upload.rb', line 19 def id @id end |
#new_asset_settings ⇒ Object
Returns the value of attribute new_asset_settings.
26 27 28 |
# File 'lib/mux_ruby/models/upload.rb', line 26 def new_asset_settings @new_asset_settings end |
#status ⇒ Object
Returns the value of attribute status.
24 25 26 |
# File 'lib/mux_ruby/models/upload.rb', line 24 def status @status end |
#test ⇒ Object
Indicates if this is a test Direct Upload, in which case the Asset that gets created will be a ‘test` Asset.
40 41 42 |
# File 'lib/mux_ruby/models/upload.rb', line 40 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`
22 23 24 |
# File 'lib/mux_ruby/models/upload.rb', line 22 def timeout @timeout end |
#url ⇒ Object
The URL to upload the associated source media to.
37 38 39 |
# File 'lib/mux_ruby/models/upload.rb', line 37 def url @url end |
Class Method Details
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about
80 81 82 |
# File 'lib/mux_ruby/models/upload.rb', line 80 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
65 66 67 68 69 70 71 72 73 74 75 76 77 |
# File 'lib/mux_ruby/models/upload.rb', line 65 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
239 240 241 |
# File 'lib/mux_ruby/models/upload.rb', line 239 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
100 101 102 103 |
# File 'lib/mux_ruby/models/upload.rb', line 100 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
85 86 87 88 89 90 91 92 93 94 95 96 97 |
# File 'lib/mux_ruby/models/upload.rb', line 85 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.
210 211 212 213 214 215 216 217 218 219 220 221 222 |
# File 'lib/mux_ruby/models/upload.rb', line 210 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
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 295 296 297 298 299 300 301 302 303 304 305 306 |
# File 'lib/mux_ruby/models/upload.rb', line 269 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
340 341 342 343 344 345 346 347 348 349 350 351 352 |
# File 'lib/mux_ruby/models/upload.rb', line 340 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
246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 |
# File 'lib/mux_ruby/models/upload.rb', line 246 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
226 227 228 |
# File 'lib/mux_ruby/models/upload.rb', line 226 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
232 233 234 |
# File 'lib/mux_ruby/models/upload.rb', line 232 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?
161 162 163 164 165 166 167 168 169 170 171 172 |
# File 'lib/mux_ruby/models/upload.rb', line 161 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)
316 317 318 |
# File 'lib/mux_ruby/models/upload.rb', line 316 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
322 323 324 325 326 327 328 329 330 331 332 333 334 |
# File 'lib/mux_ruby/models/upload.rb', line 322 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
310 311 312 |
# File 'lib/mux_ruby/models/upload.rb', line 310 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
176 177 178 179 180 181 182 |
# File 'lib/mux_ruby/models/upload.rb', line 176 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 |