Class: Shotstack::RenderResponseData
- Inherits:
-
Object
- Object
- Shotstack::RenderResponseData
- Defined in:
- lib/shotstack/models/render_response_data.rb
Overview
The response data returned with the [RenderResponse](#tocs_renderresponse) including status and URL.
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#created ⇒ Object
The time the render task was initially queued.
-
#data ⇒ Object
Returns the value of attribute data.
-
#duration ⇒ Object
The output video or audio length in seconds.
-
#error ⇒ Object
An error message, only displayed if an error occurred.
-
#id ⇒ Object
The id of the render task in UUID format.
-
#owner ⇒ Object
The owner id of the render task.
-
#plan ⇒ Object
The customer subscription plan.
-
#poster ⇒ Object
The URL of the poster image if requested.
-
#render_time ⇒ Object
The time taken to render the asset in milliseconds.
-
#status ⇒ Object
The status of the render task.
-
#thumbnail ⇒ Object
The URL of the thumbnail image if requested.
-
#updated ⇒ Object
The time the render status was last updated.
-
#url ⇒ Object
The URL of the final asset.
Class Method Summary collapse
-
._deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
.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.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ RenderResponseData
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 = {}) ⇒ RenderResponseData
Initializes the object
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 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 |
# File 'lib/shotstack/models/render_response_data.rb', line 132 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'] else self.id = nil end if attributes.key?(:'owner') self.owner = attributes[:'owner'] else self.owner = nil end if attributes.key?(:'plan') self.plan = attributes[:'plan'] end if attributes.key?(:'status') self.status = attributes[:'status'] else self.status = nil 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 |
Instance Attribute Details
#created ⇒ Object
The time the render task was initially queued.
52 53 54 |
# File 'lib/shotstack/models/render_response_data.rb', line 52 def created @created end |
#data ⇒ Object
Returns the value of attribute data.
49 50 51 |
# File 'lib/shotstack/models/render_response_data.rb', line 49 def data @data end |
#duration ⇒ Object
The output video or audio length in seconds.
35 36 37 |
# File 'lib/shotstack/models/render_response_data.rb', line 35 def duration @duration end |
#error ⇒ Object
An error message, only displayed if an error occurred.
32 33 34 |
# File 'lib/shotstack/models/render_response_data.rb', line 32 def error @error end |
#id ⇒ Object
The id of the render task in UUID format.
20 21 22 |
# File 'lib/shotstack/models/render_response_data.rb', line 20 def id @id end |
#owner ⇒ Object
The owner id of the render task.
23 24 25 |
# File 'lib/shotstack/models/render_response_data.rb', line 23 def owner @owner end |
#plan ⇒ Object
The customer subscription plan.
26 27 28 |
# File 'lib/shotstack/models/render_response_data.rb', line 26 def plan @plan end |
#poster ⇒ Object
The URL of the poster image if requested. This will only be available if status is done.
44 45 46 |
# File 'lib/shotstack/models/render_response_data.rb', line 44 def poster @poster end |
#render_time ⇒ Object
The time taken to render the asset in milliseconds.
38 39 40 |
# File 'lib/shotstack/models/render_response_data.rb', line 38 def render_time @render_time end |
#status ⇒ Object
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>
29 30 31 |
# File 'lib/shotstack/models/render_response_data.rb', line 29 def status @status end |
#thumbnail ⇒ Object
The URL of the thumbnail image if requested. This will only be available if status is done.
47 48 49 |
# File 'lib/shotstack/models/render_response_data.rb', line 47 def thumbnail @thumbnail end |
#updated ⇒ Object
The time the render status was last updated.
55 56 57 |
# File 'lib/shotstack/models/render_response_data.rb', line 55 def updated @updated end |
#url ⇒ Object
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.
41 42 43 |
# File 'lib/shotstack/models/render_response_data.rb', line 41 def url @url end |
Class Method Details
._deserialize(type, value) ⇒ Object
Deserializes the data based on type
305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 |
# File 'lib/shotstack/models/render_response_data.rb', line 305 def self._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_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end |
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about
99 100 101 |
# File 'lib/shotstack/models/render_response_data.rb', line 99 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 |
# 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 |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 |
# File 'lib/shotstack/models/render_response_data.rb', line 281 def self.build_from_hash(attributes) return nil unless attributes.is_a?(Hash) attributes = attributes.transform_keys(&:to_sym) transformed_hash = {} openapi_types.each_pair do |key, type| if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil? transformed_hash["#{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[attribute_map[key]].is_a?(Array) transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) } end elsif !attributes[attribute_map[key]].nil? transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]]) end end new(transformed_hash) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
123 124 125 126 127 128 |
# File 'lib/shotstack/models/render_response_data.rb', line 123 def self.openapi_nullable Set.new([ :'poster', :'thumbnail', ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 |
# 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 |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 |
# File 'lib/shotstack/models/render_response_data.rb', line 248 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 |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
376 377 378 379 380 381 382 383 384 385 386 387 388 |
# File 'lib/shotstack/models/render_response_data.rb', line 376 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 |
#eql?(o) ⇒ Boolean
268 269 270 |
# File 'lib/shotstack/models/render_response_data.rb', line 268 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
274 275 276 |
# File 'lib/shotstack/models/render_response_data.rb', line 274 def hash [id, owner, plan, status, error, duration, render_time, url, poster, thumbnail, data, created, updated].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 |
# File 'lib/shotstack/models/render_response_data.rb', line 206 def list_invalid_properties warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' 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 invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
352 353 354 |
# File 'lib/shotstack/models/render_response_data.rb', line 352 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
358 359 360 361 362 363 364 365 366 367 368 369 370 |
# File 'lib/shotstack/models/render_response_data.rb', line 358 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
346 347 348 |
# File 'lib/shotstack/models/render_response_data.rb', line 346 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
226 227 228 229 230 231 232 233 234 |
# File 'lib/shotstack/models/render_response_data.rb', line 226 def valid? warn '[DEPRECATED] the `valid?` method is obsolete' 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) true end |