Class: AsposeCellsCloud::SqlScriptSaveOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_cells_cloud/models/sql_script_save_options.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SqlScriptSaveOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
203
204
205
206
207
208
209
210
 
# File 'lib/aspose_cells_cloud/models/sql_script_save_options.rb', line 137

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?(:'CheckIfTableExists')
      self.check_if_table_exists = attributes[:'CheckIfTableExists']
  end
  if attributes.has_key?(:'ColumnTypeMap')
      self.column_type_map = attributes[:'ColumnTypeMap']
  end
  if attributes.has_key?(:'CheckAllDataForColumnType')
      self.check_all_data_for_column_type = attributes[:'CheckAllDataForColumnType']
  end
  if attributes.has_key?(:'AddBlankLineBetweenRows')
      self.add_blank_line_between_rows = attributes[:'AddBlankLineBetweenRows']
  end
  if attributes.has_key?(:'Separator')
      self.separator = attributes[:'Separator']
  end
  if attributes.has_key?(:'OperatorType')
      self.operator_type = attributes[:'OperatorType']
  end
  if attributes.has_key?(:'PrimaryKey')
      self.primary_key = attributes[:'PrimaryKey']
  end
  if attributes.has_key?(:'CreateTable')
      self.create_table = attributes[:'CreateTable']
  end
  if attributes.has_key?(:'IdName')
      self.id_name = attributes[:'IdName']
  end
  if attributes.has_key?(:'StartId')
      self.start_id = attributes[:'StartId']
  end
  if attributes.has_key?(:'TableName')
      self.table_name = attributes[:'TableName']
  end
  if attributes.has_key?(:'ExportAsString')
      self.export_as_string = attributes[:'ExportAsString']
  end
  if attributes.has_key?(:'ExportArea')
      self.export_area = attributes[:'ExportArea']
  end
  if attributes.has_key?(:'HasHeaderRow')
      self.has_header_row = attributes[:'HasHeaderRow']
  end
  if attributes.has_key?(:'SaveFormat')
      self.save_format = attributes[:'SaveFormat']
  end
  if attributes.has_key?(:'CachedFileFolder')
      self.cached_file_folder = attributes[:'CachedFileFolder']
  end
  if attributes.has_key?(:'ClearData')
      self.clear_data = attributes[:'ClearData']
  end
  if attributes.has_key?(:'CreateDirectory')
      self.create_directory = attributes[:'CreateDirectory']
  end
  if attributes.has_key?(:'EnableHTTPCompression')
      self.enable_http_compression = attributes[:'EnableHTTPCompression']
  end
  if attributes.has_key?(:'RefreshChartCache')
      self.refresh_chart_cache = attributes[:'RefreshChartCache']
  end
  if attributes.has_key?(:'SortNames')
      self.sort_names = attributes[:'SortNames']
  end
  if attributes.has_key?(:'ValidateMergedAreas')
      self.validate_merged_areas = attributes[:'ValidateMergedAreas']
  end

end

Instance Attribute Details

#add_blank_line_between_rows ⇒ Object

Insert blank line between each data.



41
42
43
 
# File 'lib/aspose_cells_cloud/models/sql_script_save_options.rb', line 41

def add_blank_line_between_rows
  @add_blank_line_between_rows
end

#cached_file_folder ⇒ Object

Returns the value of attribute cached_file_folder.



65
66
67
 
# File 'lib/aspose_cells_cloud/models/sql_script_save_options.rb', line 65

def cached_file_folder
  @cached_file_folder
end

#check_all_data_for_column_type ⇒ Object

Check all data to find columns’ data type.



39
40
41
 
# File 'lib/aspose_cells_cloud/models/sql_script_save_options.rb', line 39

def check_all_data_for_column_type
  @check_all_data_for_column_type
end

#check_if_table_exists ⇒ Object

Check if the table name exists before creating



35
36
37
 
# File 'lib/aspose_cells_cloud/models/sql_script_save_options.rb', line 35

def check_if_table_exists
  @check_if_table_exists
end

#clear_data ⇒ Object

Returns the value of attribute clear_data.



67
68
69
 
# File 'lib/aspose_cells_cloud/models/sql_script_save_options.rb', line 67

def clear_data
  @clear_data
end

#column_type_map ⇒ Object

Gets and sets the map of column type for different database.



37
38
39
 
# File 'lib/aspose_cells_cloud/models/sql_script_save_options.rb', line 37

def column_type_map
  @column_type_map
end

#create_directory ⇒ Object

Returns the value of attribute create_directory.



69
70
71
 
# File 'lib/aspose_cells_cloud/models/sql_script_save_options.rb', line 69

def create_directory
  @create_directory
end

#create_table ⇒ Object

Indicates whether exporting sql of creating table.



49
50
51
 
# File 'lib/aspose_cells_cloud/models/sql_script_save_options.rb', line 49

def create_table
  @create_table
end

#enable_http_compression ⇒ Object

Returns the value of attribute enable_http_compression.



71
72
73
 
# File 'lib/aspose_cells_cloud/models/sql_script_save_options.rb', line 71

def enable_http_compression
  @enable_http_compression
end

#export_area ⇒ Object

Gets or sets the exporting range.



59
60
61
 
# File 'lib/aspose_cells_cloud/models/sql_script_save_options.rb', line 59

def export_area
  @export_area
end

#export_as_string ⇒ Object

Indicates whether exporting all data as string value.



57
58
59
 
# File 'lib/aspose_cells_cloud/models/sql_script_save_options.rb', line 57

def export_as_string
  @export_as_string
end

#has_header_row ⇒ Object

Indicates whether the range contains header row.



61
62
63
 
# File 'lib/aspose_cells_cloud/models/sql_script_save_options.rb', line 61

def has_header_row
  @has_header_row
end

#id_name ⇒ Object

Gets and sets the name of id column.



51
52
53
 
# File 'lib/aspose_cells_cloud/models/sql_script_save_options.rb', line 51

def id_name
  @id_name
end

#operator_type ⇒ Object

Gets and sets the operator type of sql.



45
46
47
 
# File 'lib/aspose_cells_cloud/models/sql_script_save_options.rb', line 45

def operator_type
  @operator_type
end

#primary_key ⇒ Object

Represents which column is primary key of the data table.



47
48
49
 
# File 'lib/aspose_cells_cloud/models/sql_script_save_options.rb', line 47

def primary_key
  @primary_key
end

#refresh_chart_cache ⇒ Object

Returns the value of attribute refresh_chart_cache.



73
74
75
 
# File 'lib/aspose_cells_cloud/models/sql_script_save_options.rb', line 73

def refresh_chart_cache
  @refresh_chart_cache
end

#save_format ⇒ Object

Returns the value of attribute save_format.



63
64
65
 
# File 'lib/aspose_cells_cloud/models/sql_script_save_options.rb', line 63

def save_format
  @save_format
end

#separator ⇒ Object

Gets and sets character separator of sql script.



43
44
45
 
# File 'lib/aspose_cells_cloud/models/sql_script_save_options.rb', line 43

def separator
  @separator
end

#sort_names ⇒ Object

Returns the value of attribute sort_names.



75
76
77
 
# File 'lib/aspose_cells_cloud/models/sql_script_save_options.rb', line 75

def sort_names
  @sort_names
end

#start_id ⇒ Object

Gets and sets the start id.



53
54
55
 
# File 'lib/aspose_cells_cloud/models/sql_script_save_options.rb', line 53

def start_id
  @start_id
end

#table_name ⇒ Object

Gets and sets the table name.



55
56
57
 
# File 'lib/aspose_cells_cloud/models/sql_script_save_options.rb', line 55

def table_name
  @table_name
end

#validate_merged_areas ⇒ Object

Returns the value of attribute validate_merged_areas.



77
78
79
 
# File 'lib/aspose_cells_cloud/models/sql_script_save_options.rb', line 77

def validate_merged_areas
  @validate_merged_areas
end

Class Method Details

.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
97
98
99
100
101
102
103
104
105
 
# File 'lib/aspose_cells_cloud/models/sql_script_save_options.rb', line 80

def self.attribute_map
  {
    :'check_if_table_exists' => :'CheckIfTableExists',
    :'column_type_map' => :'ColumnTypeMap',
    :'check_all_data_for_column_type' => :'CheckAllDataForColumnType',
    :'add_blank_line_between_rows' => :'AddBlankLineBetweenRows',
    :'separator' => :'Separator',
    :'operator_type' => :'OperatorType',
    :'primary_key' => :'PrimaryKey',
    :'create_table' => :'CreateTable',
    :'id_name' => :'IdName',
    :'start_id' => :'StartId',
    :'table_name' => :'TableName',
    :'export_as_string' => :'ExportAsString',
    :'export_area' => :'ExportArea',
    :'has_header_row' => :'HasHeaderRow',
    :'save_format' => :'SaveFormat',
    :'cached_file_folder' => :'CachedFileFolder',
    :'clear_data' => :'ClearData',
    :'create_directory' => :'CreateDirectory',
    :'enable_http_compression' => :'EnableHTTPCompression',
    :'refresh_chart_cache' => :'RefreshChartCache',
    :'sort_names' => :'SortNames',
    :'validate_merged_areas' => :'ValidateMergedAreas'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/aspose_cells_cloud/models/sql_script_save_options.rb', line 108

def self.swagger_types
  {
    :'check_if_table_exists' => :'BOOLEAN',
    :'column_type_map' => :'String',
    :'check_all_data_for_column_type' => :'BOOLEAN',
    :'add_blank_line_between_rows' => :'BOOLEAN',
    :'separator' => :'String',
    :'operator_type' => :'String',
    :'primary_key' => :'Integer',
    :'create_table' => :'BOOLEAN',
    :'id_name' => :'String',
    :'start_id' => :'Integer',
    :'table_name' => :'String',
    :'export_as_string' => :'BOOLEAN',
    :'export_area' => :'CellArea',
    :'has_header_row' => :'BOOLEAN',
    :'save_format' => :'String',
    :'cached_file_folder' => :'String',
    :'clear_data' => :'BOOLEAN',
    :'create_directory' => :'BOOLEAN',
    :'enable_http_compression' => :'BOOLEAN',
    :'refresh_chart_cache' => :'BOOLEAN',
    :'sort_names' => :'BOOLEAN',
    :'validate_merged_areas' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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/aspose_cells_cloud/models/sql_script_save_options.rb', line 316

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      check_if_table_exists == o.check_if_table_exists &&
      column_type_map == o.column_type_map &&
      check_all_data_for_column_type == o.check_all_data_for_column_type &&
      add_blank_line_between_rows == o.add_blank_line_between_rows &&
      separator == o.separator &&
      operator_type == o.operator_type &&
      primary_key == o.primary_key &&
      create_table == o.create_table &&
      id_name == o.id_name &&
      start_id == o.start_id &&
      table_name == o.table_name &&
      export_as_string == o.export_as_string &&
      export_area == o.export_area &&
      has_header_row == o.has_header_row &&
      save_format == o.save_format &&
      cached_file_folder == o.cached_file_folder &&
      clear_data == o.clear_data &&
      create_directory == o.create_directory &&
      enable_http_compression == o.enable_http_compression &&
      refresh_chart_cache == o.refresh_chart_cache &&
      sort_names == o.sort_names &&
      validate_merged_areas == o.validate_merged_areas 
      std_dev == o.std_dev
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



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/aspose_cells_cloud/models/sql_script_save_options.rb', line 380

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
    temp_model = AsposeCellsCloud.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



446
447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'lib/aspose_cells_cloud/models/sql_script_save_options.rb', line 446

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



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/aspose_cells_cloud/models/sql_script_save_options.rb', line 359

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    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 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


346
347
348
 
# File 'lib/aspose_cells_cloud/models/sql_script_save_options.rb', line 346

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



352
353
354
 
# File 'lib/aspose_cells_cloud/models/sql_script_save_options.rb', line 352

def hash
  [ check_if_table_exists , column_type_map , check_all_data_for_column_type , add_blank_line_between_rows , separator , operator_type , primary_key , create_table , id_name , start_id , table_name , export_as_string , export_area , has_header_row , save_format , cached_file_folder , clear_data , create_directory , enable_http_compression , refresh_chart_cache , sort_names , validate_merged_areas ].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



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
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
277
278
279
280
281
282
283
284
 
# File 'lib/aspose_cells_cloud/models/sql_script_save_options.rb', line 214

def list_invalid_properties
  invalid_properties = Array.new
  if @check_if_table_exists.nil?
      invalid_properties.push("invalid value for 'check_if_table_exists', check_if_table_exists cannot be nil.")
  end
  if @column_type_map.nil?
      invalid_properties.push("invalid value for 'column_type_map', column_type_map cannot be nil.")
  end
  if @check_all_data_for_column_type.nil?
      invalid_properties.push("invalid value for 'check_all_data_for_column_type', check_all_data_for_column_type cannot be nil.")
  end
  if @add_blank_line_between_rows.nil?
      invalid_properties.push("invalid value for 'add_blank_line_between_rows', add_blank_line_between_rows cannot be nil.")
  end
  if @separator.nil?
      invalid_properties.push("invalid value for 'separator', separator cannot be nil.")
  end
  if @operator_type.nil?
      invalid_properties.push("invalid value for 'operator_type', operator_type cannot be nil.")
  end
  if @primary_key.nil?
      invalid_properties.push("invalid value for 'primary_key', primary_key cannot be nil.")
  end
  if @create_table.nil?
      invalid_properties.push("invalid value for 'create_table', create_table cannot be nil.")
  end
  if @id_name.nil?
      invalid_properties.push("invalid value for 'id_name', id_name cannot be nil.")
  end
  if @start_id.nil?
      invalid_properties.push("invalid value for 'start_id', start_id cannot be nil.")
  end
  if @table_name.nil?
      invalid_properties.push("invalid value for 'table_name', table_name cannot be nil.")
  end
  if @export_as_string.nil?
      invalid_properties.push("invalid value for 'export_as_string', export_as_string cannot be nil.")
  end
  if @export_area.nil?
      invalid_properties.push("invalid value for 'export_area', export_area cannot be nil.")
  end
  if @has_header_row.nil?
      invalid_properties.push("invalid value for 'has_header_row', has_header_row cannot be nil.")
  end
  if @save_format.nil?
      invalid_properties.push("invalid value for 'save_format', save_format cannot be nil.")
  end
  if @cached_file_folder.nil?
      invalid_properties.push("invalid value for 'cached_file_folder', cached_file_folder cannot be nil.")
  end
  if @clear_data.nil?
      invalid_properties.push("invalid value for 'clear_data', clear_data cannot be nil.")
  end
  if @create_directory.nil?
      invalid_properties.push("invalid value for 'create_directory', create_directory cannot be nil.")
  end
  if @enable_http_compression.nil?
      invalid_properties.push("invalid value for 'enable_http_compression', enable_http_compression cannot be nil.")
  end
  if @refresh_chart_cache.nil?
      invalid_properties.push("invalid value for 'refresh_chart_cache', refresh_chart_cache cannot be nil.")
  end
  if @sort_names.nil?
      invalid_properties.push("invalid value for 'sort_names', sort_names cannot be nil.")
  end
  if @validate_merged_areas.nil?
      invalid_properties.push("invalid value for 'validate_merged_areas', validate_merged_areas cannot be nil.")
  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



426
427
428
 
# File 'lib/aspose_cells_cloud/models/sql_script_save_options.rb', line 426

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



432
433
434
435
436
437
438
439
440
 
# File 'lib/aspose_cells_cloud/models/sql_script_save_options.rb', line 432

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



420
421
422
 
# File 'lib/aspose_cells_cloud/models/sql_script_save_options.rb', line 420

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



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/aspose_cells_cloud/models/sql_script_save_options.rb', line 288

def valid?
  return false if @check_if_table_exists.nil?
  return false if @column_type_map.nil?
  return false if @check_all_data_for_column_type.nil?
  return false if @add_blank_line_between_rows.nil?
  return false if @separator.nil?
  return false if @operator_type.nil?
  return false if @primary_key.nil?
  return false if @create_table.nil?
  return false if @id_name.nil?
  return false if @start_id.nil?
  return false if @table_name.nil?
  return false if @export_as_string.nil?
  return false if @export_area.nil?
  return false if @has_header_row.nil?
  return false if @save_format.nil?
  return false if @cached_file_folder.nil?
  return false if @clear_data.nil?
  return false if @create_directory.nil?
  return false if @enable_http_compression.nil?
  return false if @refresh_chart_cache.nil?
  return false if @sort_names.nil?
  return false if @validate_merged_areas.nil?
  return true
end