class AsposeCellsCloud::BatchConvertRequest

Attributes

format[RW]

Conversion format.

match_condition[RW]

Indicates the match condition that needs to be processed for the file name.

out_folder[RW]

The directory that stores files whose format conversion was successful.

out_storage[RW]

Aspose Cloud storage name.

page_tall_fit_on_per_sheet[RW]
page_wide_fit_on_per_sheet[RW]
region[RW]

The regional settings for workbook.

save_options[RW]

Indicates save options.

source_folder[RW]

The directory stores files that need to format conversion.

source_storage[RW]

Aspose Cloud storage name.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/aspose_cells_cloud/models/batch_convert_request.rb, line 56
def self.attribute_map
  {
    :'source_folder' => :'SourceFolder',
    :'source_storage' => :'SourceStorage',
    :'match_condition' => :'MatchCondition',
    :'format' => :'Format',
    :'out_folder' => :'OutFolder',
    :'out_storage' => :'OutStorage',
    :'region' => :'Region',
    :'page_wide_fit_on_per_sheet' => :'PageWideFitOnPerSheet',
    :'page_tall_fit_on_per_sheet' => :'PageTallFitOnPerSheet',
    :'save_options' => :'SaveOptions'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/aspose_cells_cloud/models/batch_convert_request.rb, line 89
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?(:'SourceFolder')
      self.source_folder = attributes[:'SourceFolder']
  end
  if attributes.has_key?(:'SourceStorage')
      self.source_storage = attributes[:'SourceStorage']
  end
  if attributes.has_key?(:'MatchCondition')
      self.match_condition = attributes[:'MatchCondition']
  end
  if attributes.has_key?(:'Format')
      self.format = attributes[:'Format']
  end
  if attributes.has_key?(:'OutFolder')
      self.out_folder = attributes[:'OutFolder']
  end
  if attributes.has_key?(:'OutStorage')
      self.out_storage = attributes[:'OutStorage']
  end
  if attributes.has_key?(:'Region')
      self.region = attributes[:'Region']
  end
  if attributes.has_key?(:'PageWideFitOnPerSheet')
      self.page_wide_fit_on_per_sheet = attributes[:'PageWideFitOnPerSheet']
  end
  if attributes.has_key?(:'PageTallFitOnPerSheet')
      self.page_tall_fit_on_per_sheet = attributes[:'PageTallFitOnPerSheet']
  end
  if attributes.has_key?(:'SaveOptions')
      self.save_options = attributes[:'SaveOptions']
  end

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/aspose_cells_cloud/models/batch_convert_request.rb, line 72
def self.swagger_types
  {
    :'source_folder' => :'String',
    :'source_storage' => :'String',
    :'match_condition' => :'MatchConditionRequest',
    :'format' => :'String',
    :'out_folder' => :'String',
    :'out_storage' => :'String',
    :'region' => :'String',
    :'page_wide_fit_on_per_sheet' => :'BOOLEAN',
    :'page_tall_fit_on_per_sheet' => :'BOOLEAN',
    :'save_options' => :'SaveOptions'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/aspose_cells_cloud/models/batch_convert_request.rb, line 184
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      source_folder == o.source_folder &&
      source_storage == o.source_storage &&
      match_condition == o.match_condition &&
      format == o.format &&
      out_folder == o.out_folder &&
      out_storage == o.out_storage &&
      region == o.region &&
      page_wide_fit_on_per_sheet == o.page_wide_fit_on_per_sheet &&
      page_tall_fit_on_per_sheet == o.page_tall_fit_on_per_sheet &&
      save_options == o.save_options 
      std_dev == o.std_dev
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/aspose_cells_cloud/models/batch_convert_request.rb, line 236
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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/aspose_cells_cloud/models/batch_convert_request.rb, line 302
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/aspose_cells_cloud/models/batch_convert_request.rb, line 215
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) click to toggle source

@see the ‘==` method @param [Object] Object to be compared

# File lib/aspose_cells_cloud/models/batch_convert_request.rb, line 202
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/aspose_cells_cloud/models/batch_convert_request.rb, line 208
def hash
  [ source_folder , source_storage , match_condition , format , out_folder , out_storage , region , page_wide_fit_on_per_sheet , page_tall_fit_on_per_sheet , save_options ].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons

# File lib/aspose_cells_cloud/models/batch_convert_request.rb, line 130
def list_invalid_properties
  invalid_properties = Array.new
  if @source_folder.nil?
      invalid_properties.push("invalid value for 'source_folder', source_folder cannot be nil.")
  end
  if @source_storage.nil?
      invalid_properties.push("invalid value for 'source_storage', source_storage cannot be nil.")
  end
  if @match_condition.nil?
      invalid_properties.push("invalid value for 'match_condition', match_condition cannot be nil.")
  end
  if @format.nil?
      invalid_properties.push("invalid value for 'format', format cannot be nil.")
  end
  if @out_folder.nil?
      invalid_properties.push("invalid value for 'out_folder', out_folder cannot be nil.")
  end
  if @out_storage.nil?
      invalid_properties.push("invalid value for 'out_storage', out_storage cannot be nil.")
  end
  if @region.nil?
      invalid_properties.push("invalid value for 'region', region cannot be nil.")
  end
  if @page_wide_fit_on_per_sheet.nil?
      invalid_properties.push("invalid value for 'page_wide_fit_on_per_sheet', page_wide_fit_on_per_sheet cannot be nil.")
  end
  if @page_tall_fit_on_per_sheet.nil?
      invalid_properties.push("invalid value for 'page_tall_fit_on_per_sheet', page_tall_fit_on_per_sheet cannot be nil.")
  end
  if @save_options.nil?
      invalid_properties.push("invalid value for 'save_options', save_options cannot be nil.")
  end

  return invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/aspose_cells_cloud/models/batch_convert_request.rb, line 282
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/aspose_cells_cloud/models/batch_convert_request.rb, line 288
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/aspose_cells_cloud/models/batch_convert_request.rb, line 276
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/aspose_cells_cloud/models/batch_convert_request.rb, line 168
def valid?
  return false if @source_folder.nil?
  return false if @source_storage.nil?
  return false if @match_condition.nil?
  return false if @format.nil?
  return false if @out_folder.nil?
  return false if @out_storage.nil?
  return false if @region.nil?
  return false if @page_wide_fit_on_per_sheet.nil?
  return false if @page_tall_fit_on_per_sheet.nil?
  return false if @save_options.nil?
  return true
end