Class: MuxRuby::CreateUploadRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/mux_ruby/models/create_upload_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateUploadRequest

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/mux_ruby/models/create_upload_request.rb', line 38

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'timeout')
    self.timeout = attributes[:'timeout']
  else
    self.timeout = 3600
  end

  if attributes.has_key?(:'cors_origin')
    self.cors_origin = attributes[:'cors_origin']
  end

  if attributes.has_key?(:'new_asset_settings')
    self.new_asset_settings = attributes[:'new_asset_settings']
  end
end

Instance Attribute Details

#cors_origin ⇒ Object

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.



14
15
16
 
# File 'lib/mux_ruby/models/create_upload_request.rb', line 14

def cors_origin
  @cors_origin
end

#new_asset_settings ⇒ Object

Returns the value of attribute new_asset_settings.



16
17
18
 
# File 'lib/mux_ruby/models/create_upload_request.rb', line 16

def new_asset_settings
  @new_asset_settings
end

#timeout ⇒ Object

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`



11
12
13
 
# File 'lib/mux_ruby/models/create_upload_request.rb', line 11

def timeout
  @timeout
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



19
20
21
22
23
24
25
 
# File 'lib/mux_ruby/models/create_upload_request.rb', line 19

def self.attribute_map
  {
    :'timeout' => :'timeout',
    :'cors_origin' => :'cors_origin',
    :'new_asset_settings' => :'new_asset_settings'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



126
127
128
 
# File 'lib/mux_ruby/models/create_upload_request.rb', line 126

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_types ⇒ Object

Attribute type mapping.



28
29
30
31
32
33
34
 
# File 'lib/mux_ruby/models/create_upload_request.rb', line 28

def self.openapi_types
  {
    :'timeout' => :'Integer',
    :'cors_origin' => :'String',
    :'new_asset_settings' => :'CreateAssetRequest'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



103
104
105
106
107
108
109
 
# File 'lib/mux_ruby/models/create_upload_request.rb', line 103

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      timeout == o.timeout &&
      cors_origin == o.cors_origin &&
      new_asset_settings == o.new_asset_settings
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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
 
# File 'lib/mux_ruby/models/create_upload_request.rb', line 154

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    MuxRuby.const_get(type).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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/mux_ruby/models/create_upload_request.rb', line 219

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/mux_ruby/models/create_upload_request.rb', line 133

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


113
114
115
 
# File 'lib/mux_ruby/models/create_upload_request.rb', line 113

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



119
120
121
 
# File 'lib/mux_ruby/models/create_upload_request.rb', line 119

def hash
  [timeout, cors_origin, new_asset_settings].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/mux_ruby/models/create_upload_request.rb', line 61

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

  if @new_asset_settings.nil?
    invalid_properties.push('invalid value for "new_asset_settings", new_asset_settings cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



199
200
201
 
# File 'lib/mux_ruby/models/create_upload_request.rb', line 199

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



205
206
207
208
209
210
211
212
213
 
# File 'lib/mux_ruby/models/create_upload_request.rb', line 205

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



193
194
195
 
# File 'lib/mux_ruby/models/create_upload_request.rb', line 193

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



80
81
82
83
84
85
 
# File 'lib/mux_ruby/models/create_upload_request.rb', line 80

def valid?
  return false if !@timeout.nil? && @timeout > 604800
  return false if !@timeout.nil? && @timeout < 60
  return false if @new_asset_settings.nil?
  true
end