class Shotstack::RenderResponseData
The response data returned with the [RenderResponse](tocs_renderresponse) including status and URL.
Attributes
The time the render task was initially queued.
The output video or audio length in seconds.
An error message, only displayed if an error occurred.
The id of the render task in UUID format.
The owner id of the render task.
The customer subscription plan.
The URL of the poster image if requested. This will only be available if status is done.
The time taken to render the asset in milliseconds.
The status of the render task. <ul> <li>`queued` - render is queued waiting to be rendered</li> <li>`fetching` - assets are being fetched</li> <li>`rendering` - the asset is being rendered</li> <li>`saving` - the final asset is being saved to storage</li> <li>`done` - the asset is ready to be downloaded</li> <li>`failed` - there was an error rendering the asset</li> </ul>
The URL of the thumbnail image if requested. This will only be available if status is done.
The time the render status was last updated.
The URL of the final asset. This will only be available if status is done. This is a temporary URL and will be deleted after 24 hours. By default all assets are copied to the Shotstack
hosting and CDN destination.
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/shotstack/models/render_response_data.rb, line 99 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/shotstack/models/render_response_data.rb, line 80 def self.attribute_map { :'id' => :'id', :'owner' => :'owner', :'plan' => :'plan', :'status' => :'status', :'error' => :'error', :'duration' => :'duration', :'render_time' => :'renderTime', :'url' => :'url', :'poster' => :'poster', :'thumbnail' => :'thumbnail', :'data' => :'data', :'created' => :'created', :'updated' => :'updated' } 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/render_response_data.rb, line 286 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/render_response_data.rb, line 130 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Shotstack::RenderResponseData` 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::RenderResponseData`. 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?(:'owner') self.owner = attributes[:'owner'] end if attributes.key?(:'plan') self.plan = attributes[:'plan'] end if attributes.key?(:'status') self.status = attributes[:'status'] end if attributes.key?(:'error') self.error = attributes[:'error'] end if attributes.key?(:'duration') self.duration = attributes[:'duration'] end if attributes.key?(:'render_time') self.render_time = attributes[:'render_time'] end if attributes.key?(:'url') self.url = attributes[:'url'] end if attributes.key?(:'poster') self.poster = attributes[:'poster'] end if attributes.key?(:'thumbnail') self.thumbnail = attributes[:'thumbnail'] end if attributes.key?(:'data') self.data = attributes[:'data'] end if attributes.key?(:'created') self.created = attributes[:'created'] end if attributes.key?(:'updated') self.updated = attributes[:'updated'] end end
List of attributes with nullable: true
# File lib/shotstack/models/render_response_data.rb, line 123 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/shotstack/models/render_response_data.rb, line 104 def self.openapi_types { :'id' => :'String', :'owner' => :'String', :'plan' => :'String', :'status' => :'String', :'error' => :'String', :'duration' => :'Float', :'render_time' => :'Float', :'url' => :'String', :'poster' => :'String', :'thumbnail' => :'String', :'data' => :'Edit', :'created' => :'String', :'updated' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/shotstack/models/render_response_data.rb, line 253 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && owner == o.owner && plan == o.plan && status == o.status && error == o.error && duration == o.duration && render_time == o.render_time && url == o.url && poster == o.poster && thumbnail == o.thumbnail && data == o.data && created == o.created && updated == o.updated 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/render_response_data.rb, line 316 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/render_response_data.rb, line 387 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/render_response_data.rb, line 293 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/shotstack/models/render_response_data.rb, line 273 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/shotstack/models/render_response_data.rb, line 279 def hash [id, owner, plan, status, error, duration, render_time, url, poster, thumbnail, data, created, updated].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/render_response_data.rb, line 198 def list_invalid_properties invalid_properties = Array.new if @id.nil? invalid_properties.push('invalid value for "id", id cannot be nil.') end if @owner.nil? invalid_properties.push('invalid value for "owner", owner cannot be nil.') end if @status.nil? invalid_properties.push('invalid value for "status", status cannot be nil.') end if @data.nil? invalid_properties.push('invalid value for "data", data cannot be nil.') end if @created.nil? invalid_properties.push('invalid value for "created", created cannot be nil.') end if @updated.nil? invalid_properties.push('invalid value for "updated", updated cannot be nil.') end invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned
# File lib/shotstack/models/render_response_data.rb, line 243 def status=(status) validator = EnumAttributeValidator.new('String', ["queued", "fetching", "rendering", "saving", "done", "failed"]) unless validator.valid?(status) fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}." end @status = status end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/shotstack/models/render_response_data.rb, line 369 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/render_response_data.rb, line 357 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/render_response_data.rb, line 229 def valid? return false if @id.nil? return false if @owner.nil? return false if @status.nil? status_validator = EnumAttributeValidator.new('String', ["queued", "fetching", "rendering", "saving", "done", "failed"]) return false unless status_validator.valid?(@status) return false if @data.nil? return false if @created.nil? return false if @updated.nil? true end