Class: GroupDocsConversionCloud::ConvertSettings

Inherits:
Object
  • Object
show all
Defined in:
lib/groupdocs_conversion_cloud/models/convert_settings.rb

Overview

Defines conversion request

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConvertSettings

Initializes the object

Parameters:

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

    Model attributes in the form of hash



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/groupdocs_conversion_cloud/models/convert_settings.rb', line 83

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.key?(:'StorageName')
    self.storage_name = attributes[:'StorageName']
  end

  if attributes.key?(:'FilePath')
    self.file_path = attributes[:'FilePath']
  end

  if attributes.key?(:'Format')
    self.format = attributes[:'Format']
  end

  if attributes.key?(:'LoadOptions')
    self.load_options = attributes[:'LoadOptions']
  end

  if attributes.key?(:'ConvertOptions')
    self.convert_options = attributes[:'ConvertOptions']
  end

  if attributes.key?(:'OutputPath')
    self.output_path = attributes[:'OutputPath']
  end

  if attributes.key?(:'FontsPath')
    self.fonts_path = attributes[:'FontsPath']
  end

end

Instance Attribute Details

#convert_options ⇒ Object

Gets or sets format specific convert options for output file



47
48
49
 
# File 'lib/groupdocs_conversion_cloud/models/convert_settings.rb', line 47

def convert_options
  @convert_options
end

#file_path ⇒ Object

Gets or sets absolute path to a file in the storage



38
39
40
 
# File 'lib/groupdocs_conversion_cloud/models/convert_settings.rb', line 38

def file_path
  @file_path
end

#fonts_path ⇒ Object

The path to directory containing custom fonts in storage



53
54
55
 
# File 'lib/groupdocs_conversion_cloud/models/convert_settings.rb', line 53

def fonts_path
  @fonts_path
end

#format ⇒ Object

Gets or sets requested conversion format



41
42
43
 
# File 'lib/groupdocs_conversion_cloud/models/convert_settings.rb', line 41

def format
  @format
end

#load_options ⇒ Object

Gets or sets format specific load options for source file



44
45
46
 
# File 'lib/groupdocs_conversion_cloud/models/convert_settings.rb', line 44

def load_options
  @load_options
end

#output_path ⇒ Object

Gets or sets converted file save path



50
51
52
 
# File 'lib/groupdocs_conversion_cloud/models/convert_settings.rb', line 50

def output_path
  @output_path
end

#storage_name ⇒ Object

StorageName which contains the file



35
36
37
 
# File 'lib/groupdocs_conversion_cloud/models/convert_settings.rb', line 35

def storage_name
  @storage_name
end

Class Method Details

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/groupdocs_conversion_cloud/models/convert_settings.rb', line 56

def self.attribute_map
  {
    :'storage_name' => :'StorageName',
    :'file_path' => :'FilePath',
    :'format' => :'Format',
    :'load_options' => :'LoadOptions',
    :'convert_options' => :'ConvertOptions',
    :'output_path' => :'OutputPath',
    :'fonts_path' => :'FontsPath'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/groupdocs_conversion_cloud/models/convert_settings.rb', line 69

def self.swagger_types
  {
    :'storage_name' => :'String',
    :'file_path' => :'String',
    :'format' => :'String',
    :'load_options' => :'LoadOptions',
    :'convert_options' => :'ConvertOptions',
    :'output_path' => :'String',
    :'fonts_path' => :'String'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/groupdocs_conversion_cloud/models/convert_settings.rb', line 182

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      storage_name == other.storage_name &&
      file_path == other.file_path &&
      format == other.format &&
      load_options == other.load_options &&
      convert_options == other.convert_options &&
      output_path == other.output_path &&
      fonts_path == other.fonts_path
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



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/groupdocs_conversion_cloud/models/convert_settings.rb', line 239

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    Date.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
    temp_model = GroupDocsConversionCloud.const_get(type).new
    temp_model.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



306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/groupdocs_conversion_cloud/models/convert_settings.rb', line 306

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



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/groupdocs_conversion_cloud/models/convert_settings.rb', line 215

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    pname = uncap(self.class.attribute_map[key]).intern
    value = attributes[pname]
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not                    
      if value.is_a?(Array)
        self.send("#{key}=", value.map { |v| _deserialize($1, v) })
      end
    elsif !value.nil?
      self.send("#{key}=", _deserialize(type, value))
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


196
197
198
 
# File 'lib/groupdocs_conversion_cloud/models/convert_settings.rb', line 196

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



202
203
204
 
# File 'lib/groupdocs_conversion_cloud/models/convert_settings.rb', line 202

def hash
  [storage_name, file_path, format, load_options, convert_options, output_path, fonts_path].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/groupdocs_conversion_cloud/models/convert_settings.rb', line 121

def list_invalid_properties
  invalid_properties = []
  if @file_path.nil?
    invalid_properties.push("invalid value for 'file_path', file_path cannot be nil.")
  end

  if @file_path.to_s.length < 1
    invalid_properties.push("invalid value for 'file_path', the character length must be great than or equal to 1.")
  end

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

  if @format.to_s.length < 1
    invalid_properties.push("invalid value for 'format', the character length must be great than or equal to 1.")
  end

  return 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



286
287
288
 
# File 'lib/groupdocs_conversion_cloud/models/convert_settings.rb', line 286

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



292
293
294
295
296
297
298
299
300
 
# File 'lib/groupdocs_conversion_cloud/models/convert_settings.rb', line 292

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



280
281
282
 
# File 'lib/groupdocs_conversion_cloud/models/convert_settings.rb', line 280

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



208
209
210
 
# File 'lib/groupdocs_conversion_cloud/models/convert_settings.rb', line 208

def uncap(str)
  str[0, 1].downcase + str[1..-1]
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



144
145
146
147
148
149
150
 
# File 'lib/groupdocs_conversion_cloud/models/convert_settings.rb', line 144

def valid?
  return false if @file_path.nil?
  return false if @file_path.to_s.length < 1
  return false if @format.nil?
  return false if @format.to_s.length < 1
  return true
end