Class: MuxRuby::CreateWebInputRequest
- Inherits:
-
Object
- Object
- MuxRuby::CreateWebInputRequest
- Defined in:
- lib/mux_ruby/models/create_web_input_request.rb
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#auto_launch ⇒ Object
When set to ‘true` the Web Input will automatically launch and start streaming immediately after creation.
-
#created_at ⇒ Object
Time the Web Input was created, defined as a Unix timestamp (seconds since epoch).
-
#id ⇒ Object
Unique identifier for the Web Input.
-
#live_stream_id ⇒ Object
The Live Stream ID to broadcast this Web Input to.
-
#passthrough ⇒ Object
Arbitrary metadata that will be included in the Web Input details and related webhooks.
-
#resolution ⇒ Object
The resolution of the viewport of the Web Input’s browser instance.
-
#status ⇒ Object
Returns the value of attribute status.
-
#timeout ⇒ Object
The number of seconds that the Web Input should stream for before automatically shutting down.
-
#url ⇒ Object
The URL for the Web Input to load.
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_all_of ⇒ Object
List of class defined in allOf (OpenAPI v3).
-
.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 = {}) ⇒ CreateWebInputRequest
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 = {}) ⇒ CreateWebInputRequest
Initializes the object
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 158 159 160 161 162 163 164 165 166 167 168 |
# File 'lib/mux_ruby/models/create_web_input_request.rb', line 116 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `MuxRuby::CreateWebInputRequest` 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::CreateWebInputRequest`. 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?(:'created_at') self.created_at = attributes[:'created_at'] end if attributes.key?(:'url') self.url = attributes[:'url'] end if attributes.key?(:'auto_launch') self.auto_launch = attributes[:'auto_launch'] end if attributes.key?(:'live_stream_id') self.live_stream_id = attributes[:'live_stream_id'] end if attributes.key?(:'status') self.status = attributes[:'status'] end if attributes.key?(:'passthrough') self.passthrough = attributes[:'passthrough'] end if attributes.key?(:'resolution') self.resolution = attributes[:'resolution'] else self.resolution = '1920x1080' end if attributes.key?(:'timeout') self.timeout = attributes[:'timeout'] else self.timeout = 3600 end end |
Instance Attribute Details
#auto_launch ⇒ Object
When set to ‘true` the Web Input will automatically launch and start streaming immediately after creation
28 29 30 |
# File 'lib/mux_ruby/models/create_web_input_request.rb', line 28 def auto_launch @auto_launch end |
#created_at ⇒ Object
Time the Web Input was created, defined as a Unix timestamp (seconds since epoch).
22 23 24 |
# File 'lib/mux_ruby/models/create_web_input_request.rb', line 22 def created_at @created_at end |
#id ⇒ Object
Unique identifier for the Web Input.
19 20 21 |
# File 'lib/mux_ruby/models/create_web_input_request.rb', line 19 def id @id end |
#live_stream_id ⇒ Object
The Live Stream ID to broadcast this Web Input to
31 32 33 |
# File 'lib/mux_ruby/models/create_web_input_request.rb', line 31 def live_stream_id @live_stream_id end |
#passthrough ⇒ Object
Arbitrary metadata that will be included in the Web Input details and related webhooks. Can be used to store your own ID for the Web Input. **Max: 255 characters**.
36 37 38 |
# File 'lib/mux_ruby/models/create_web_input_request.rb', line 36 def passthrough @passthrough end |
#resolution ⇒ Object
The resolution of the viewport of the Web Input’s browser instance. Defaults to 1920x1080 if not set.
39 40 41 |
# File 'lib/mux_ruby/models/create_web_input_request.rb', line 39 def resolution @resolution end |
#status ⇒ Object
Returns the value of attribute status.
33 34 35 |
# File 'lib/mux_ruby/models/create_web_input_request.rb', line 33 def status @status end |
#timeout ⇒ Object
The number of seconds that the Web Input should stream for before automatically shutting down.
42 43 44 |
# File 'lib/mux_ruby/models/create_web_input_request.rb', line 42 def timeout @timeout end |
#url ⇒ Object
The URL for the Web Input to load.
25 26 27 |
# File 'lib/mux_ruby/models/create_web_input_request.rb', line 25 def url @url end |
Class Method Details
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about
82 83 84 |
# File 'lib/mux_ruby/models/create_web_input_request.rb', line 82 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
67 68 69 70 71 72 73 74 75 76 77 78 79 |
# File 'lib/mux_ruby/models/create_web_input_request.rb', line 67 def self.attribute_map { :'id' => :'id', :'created_at' => :'created_at', :'url' => :'url', :'auto_launch' => :'auto_launch', :'live_stream_id' => :'live_stream_id', :'status' => :'status', :'passthrough' => :'passthrough', :'resolution' => :'resolution', :'timeout' => :'timeout' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
238 239 240 |
# File 'lib/mux_ruby/models/create_web_input_request.rb', line 238 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_all_of ⇒ Object
List of class defined in allOf (OpenAPI v3)
108 109 110 111 112 |
# File 'lib/mux_ruby/models/create_web_input_request.rb', line 108 def self.openapi_all_of [ :'WebInput' ] end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
102 103 104 105 |
# File 'lib/mux_ruby/models/create_web_input_request.rb', line 102 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
87 88 89 90 91 92 93 94 95 96 97 98 99 |
# File 'lib/mux_ruby/models/create_web_input_request.rb', line 87 def self.openapi_types { :'id' => :'String', :'created_at' => :'String', :'url' => :'String', :'auto_launch' => :'Boolean', :'live_stream_id' => :'String', :'status' => :'String', :'passthrough' => :'String', :'resolution' => :'String', :'timeout' => :'Integer' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
209 210 211 212 213 214 215 216 217 218 219 220 221 |
# File 'lib/mux_ruby/models/create_web_input_request.rb', line 209 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && created_at == o.created_at && url == o.url && auto_launch == o.auto_launch && live_stream_id == o.live_stream_id && status == o.status && passthrough == o.passthrough && resolution == o.resolution && timeout == o.timeout end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
268 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 |
# File 'lib/mux_ruby/models/create_web_input_request.rb', line 268 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
339 340 341 342 343 344 345 346 347 348 349 350 351 |
# File 'lib/mux_ruby/models/create_web_input_request.rb', line 339 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
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 |
# File 'lib/mux_ruby/models/create_web_input_request.rb', line 245 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
225 226 227 |
# File 'lib/mux_ruby/models/create_web_input_request.rb', line 225 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
231 232 233 |
# File 'lib/mux_ruby/models/create_web_input_request.rb', line 231 def hash [id, created_at, url, auto_launch, live_stream_id, status, passthrough, resolution, timeout].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
172 173 174 175 |
# File 'lib/mux_ruby/models/create_web_input_request.rb', line 172 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
315 316 317 |
# File 'lib/mux_ruby/models/create_web_input_request.rb', line 315 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
321 322 323 324 325 326 327 328 329 330 331 332 333 |
# File 'lib/mux_ruby/models/create_web_input_request.rb', line 321 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
309 310 311 |
# File 'lib/mux_ruby/models/create_web_input_request.rb', line 309 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
179 180 181 182 183 184 185 |
# File 'lib/mux_ruby/models/create_web_input_request.rb', line 179 def valid? status_validator = EnumAttributeValidator.new('String', ["idle", "launching", "streaming"]) return false unless status_validator.valid?(@status) resolution_validator = EnumAttributeValidator.new('String', ["1920x1080", "1280x720", "1080x1920", "720x1280", "1080x1080", "720x720"]) return false unless resolution_validator.valid?(@resolution) true end |