class MuxRuby::Upload
Attributes
Only set once the upload is in the `asset_created` state.
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.
Unique identifier for the Direct Upload
.
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`
The URL to upload the associated source media to.
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/mux_ruby/models/upload.rb, line 80 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/mux_ruby/models/upload.rb, line 239 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# 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
List of attributes with nullable: true
# File lib/mux_ruby/models/upload.rb, line 100 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# 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
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# 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
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# 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
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# 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
@see the `==` method @param [Object] Object to be compared
# File lib/mux_ruby/models/upload.rb, line 226 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# 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
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# 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
Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned
# File lib/mux_ruby/models/upload.rb, line 200 def status=(status) validator = EnumAttributeValidator.new('String', ["waiting", "asset_created", "errored", "cancelled", "timed_out"]) unless validator.valid?(status) fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}." end @status = status end
Custom attribute writer method with validation @param [Object] timeout Value to be assigned
# File lib/mux_ruby/models/upload.rb, line 186 def timeout=(timeout) if !timeout.nil? && timeout > 604800 fail ArgumentError, 'invalid value for "timeout", must be smaller than or equal to 604800.' end if !timeout.nil? && timeout < 60 fail ArgumentError, 'invalid value for "timeout", must be greater than or equal to 60.' end @timeout = timeout end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/mux_ruby/models/upload.rb, line 310 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# 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