Class: VeniceClient::VideoModelConstraints

Inherits:
Object
  • Object
show all
Defined in:
lib/venice_client/models/video_model_constraints.rb

Overview

Constraints that apply to video models.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VideoModelConstraints

Initializes the object



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
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
 
# File 'lib/venice_client/models/video_model_constraints.rb', line 101

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `VeniceClient::VideoModelConstraints` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `VeniceClient::VideoModelConstraints`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'aspect_ratios')
    if (value = attributes[:'aspect_ratios']).is_a?(Array)
      self.aspect_ratios = value
    end
  else
    self.aspect_ratios = nil
  end

  if attributes.key?(:'resolutions')
    if (value = attributes[:'resolutions']).is_a?(Array)
      self.resolutions = value
    end
  else
    self.resolutions = nil
  end

  if attributes.key?(:'durations')
    if (value = attributes[:'durations']).is_a?(Array)
      self.durations = value
    end
  else
    self.durations = nil
  end

  if attributes.key?(:'model_type')
    self.model_type = attributes[:'model_type']
  else
    self.model_type = nil
  end

  if attributes.key?(:'audio')
    self.audio = attributes[:'audio']
  else
    self.audio = nil
  end

  if attributes.key?(:'audio_configurable')
    self.audio_configurable = attributes[:'audio_configurable']
  else
    self.audio_configurable = nil
  end
end

Instance Attribute Details

#aspect_ratios ⇒ Object

The aspect ratios supported by the model. Empty array means the model does not support a defined aspect ratio.



20
21
22
 
# File 'lib/venice_client/models/video_model_constraints.rb', line 20

def aspect_ratios
  @aspect_ratios
end

#audio ⇒ Object

Does the model support audio generation?



32
33
34
 
# File 'lib/venice_client/models/video_model_constraints.rb', line 32

def audio
  @audio
end

#audio_configurable ⇒ Object

Can audio be enabled or disabled for the video generation?



35
36
37
 
# File 'lib/venice_client/models/video_model_constraints.rb', line 35

def audio_configurable
  @audio_configurable
end

#durations ⇒ Object

The durations supported by the model. Empty array means the model does not support a defined duration.



26
27
28
 
# File 'lib/venice_client/models/video_model_constraints.rb', line 26

def durations
  @durations
end

#model_type ⇒ Object

The type of video model.



29
30
31
 
# File 'lib/venice_client/models/video_model_constraints.rb', line 29

def model_type
  @model_type
end

#resolutions ⇒ Object

The resolutions supported by the model. Empty array means the model does not support a defined resolution.



23
24
25
 
# File 'lib/venice_client/models/video_model_constraints.rb', line 23

def resolutions
  @resolutions
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type



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
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/venice_client/models/video_model_constraints.rb', line 317

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 = VeniceClient.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_attribute_map ⇒ Object

Returns attribute mapping this model knows about



72
73
74
 
# File 'lib/venice_client/models/video_model_constraints.rb', line 72

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



77
78
79
 
# File 'lib/venice_client/models/video_model_constraints.rb', line 77

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
 
# File 'lib/venice_client/models/video_model_constraints.rb', line 60

def self.attribute_map
  {
    :'aspect_ratios' => :'aspect_ratios',
    :'resolutions' => :'resolutions',
    :'durations' => :'durations',
    :'model_type' => :'model_type',
    :'audio' => :'audio',
    :'audio_configurable' => :'audio_configurable'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/venice_client/models/video_model_constraints.rb', line 293

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



94
95
96
97
 
# File 'lib/venice_client/models/video_model_constraints.rb', line 94

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



82
83
84
85
86
87
88
89
90
91
 
# File 'lib/venice_client/models/video_model_constraints.rb', line 82

def self.openapi_types
  {
    :'aspect_ratios' => :'Array<String>',
    :'resolutions' => :'Array<String>',
    :'durations' => :'Array<String>',
    :'model_type' => :'String',
    :'audio' => :'Boolean',
    :'audio_configurable' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



267
268
269
270
271
272
273
274
275
276
 
# File 'lib/venice_client/models/video_model_constraints.rb', line 267

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      aspect_ratios == o.aspect_ratios &&
      resolutions == o.resolutions &&
      durations == o.durations &&
      model_type == o.model_type &&
      audio == o.audio &&
      audio_configurable == o.audio_configurable
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/venice_client/models/video_model_constraints.rb', line 388

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

See Also:

  • `==` method


280
281
282
 
# File 'lib/venice_client/models/video_model_constraints.rb', line 280

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



286
287
288
 
# File 'lib/venice_client/models/video_model_constraints.rb', line 286

def hash
  [aspect_ratios, resolutions, durations, model_type, audio, audio_configurable].hash
end

#list_invalid_properties ⇒ Object

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



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
 
# File 'lib/venice_client/models/video_model_constraints.rb', line 160

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @aspect_ratios.nil?
    invalid_properties.push('invalid value for "aspect_ratios", aspect_ratios cannot be nil.')
  end

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

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

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

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

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



364
365
366
 
# File 'lib/venice_client/models/video_model_constraints.rb', line 364

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/venice_client/models/video_model_constraints.rb', line 370

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



358
359
360
 
# File 'lib/venice_client/models/video_model_constraints.rb', line 358

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/venice_client/models/video_model_constraints.rb', line 192

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @aspect_ratios.nil?
  return false if @resolutions.nil?
  return false if @durations.nil?
  return false if @model_type.nil?
  model_type_validator = EnumAttributeValidator.new('String', ["image-to-video", "text-to-video", "video"])
  return false unless model_type_validator.valid?(@model_type)
  return false if @audio.nil?
  return false if @audio_configurable.nil?
  true
end