class Shotstack::Edit
An edit defines the arrangement of a video on a timeline, an audio edit or an image design and the output format.
Attributes
An optional webhook callback URL used to receive status notifications when a render completes or fails. See [webhooks](shotstack.gitbook.io/docs/guides/architecting-an-application/webhooks) for more details.
The disk type to use for storing footage and assets for each render. See [disk types](shotstack.gitbook.io/docs/guides/architecting-an-application/disk-types) for more details. <ul> <li>`local` - optimized for high speed rendering with up to 512MB storage</li> <li>`mount` - optimized for larger file sizes and longer videos with 5GB for source footage and 512MB for output render</li> </ul>
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/shotstack/models/edit.rb, line 62 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/shotstack/models/edit.rb, line 52 def self.attribute_map { :'timeline' => :'timeline', :'output' => :'output', :'callback' => :'callback', :'disk' => :'disk' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/shotstack/models/edit.rb, line 177 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/shotstack/models/edit.rb, line 84 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Shotstack::Edit` 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 `Shotstack::Edit`. 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?(:'timeline') self.timeline = attributes[:'timeline'] end if attributes.key?(:'output') self.output = attributes[:'output'] end if attributes.key?(:'callback') self.callback = attributes[:'callback'] end if attributes.key?(:'disk') self.disk = attributes[:'disk'] else self.disk = 'local' end end
List of attributes with nullable: true
# File lib/shotstack/models/edit.rb, line 77 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/shotstack/models/edit.rb, line 67 def self.openapi_types { :'timeline' => :'Timeline', :'output' => :'Output', :'callback' => :'String', :'disk' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/shotstack/models/edit.rb, line 153 def ==(o) return true if self.equal?(o) self.class == o.class && timeline == o.timeline && output == o.output && callback == o.callback && disk == o.disk 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/shotstack/models/edit.rb, line 207 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 = Shotstack.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/shotstack/models/edit.rb, line 278 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/shotstack/models/edit.rb, line 184 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
Custom attribute writer method checking allowed values (enum). @param [Object] disk Object to be assigned
# File lib/shotstack/models/edit.rb, line 143 def disk=(disk) validator = EnumAttributeValidator.new('String', ["local", "mount"]) unless validator.valid?(disk) fail ArgumentError, "invalid value for \"disk\", must be one of #{validator.allowable_values}." end @disk = disk end
@see the `==` method @param [Object] Object to be compared
# File lib/shotstack/models/edit.rb, line 164 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/shotstack/models/edit.rb, line 170 def hash [timeline, output, callback, disk].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/shotstack/models/edit.rb, line 118 def list_invalid_properties invalid_properties = Array.new if @timeline.nil? invalid_properties.push('invalid value for "timeline", timeline cannot be nil.') end if @output.nil? invalid_properties.push('invalid value for "output", output cannot be nil.') end invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/shotstack/models/edit.rb, line 260 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/shotstack/models/edit.rb, line 248 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/shotstack/models/edit.rb, line 133 def valid? return false if @timeline.nil? return false if @output.nil? disk_validator = EnumAttributeValidator.new('String', ["local", "mount"]) return false unless disk_validator.valid?(@disk) true end