class AsposeEmailCloud::DiscoverEmailConfigRequest

Discover email configuration request.

Attributes

address[RW]

Email address to discover.

@return [String]

fast_processing[RW]

Turns on fast processing. All discover systems will run in parallel. First discovered result will be returned.

@return [BOOLEAN]

login[RW]

Email account login. If not specified, address used as a login.

@return [String]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/aspose-email-cloud/models/discover_email_config_request.rb, line 41
def self.attribute_map
  {
    :'address' => :'address',
    :'fast_processing' => :'fastProcessing',
    :'login' => :'login'
  }
end
new( address: nil, fast_processing: nil, login: nil) click to toggle source

Initializes the object @param [String] address Email address to discover.

@param [BOOLEAN] fast_processing Turns on fast processing. All discover systems will run in parallel. First discovered result will be returned.

@param [String] login Email account login. If not specified, address used as a login.

# File lib/aspose-email-cloud/models/discover_email_config_request.rb, line 62
def initialize(
  address: nil,
  fast_processing: nil,
  login: nil)
  self.address = address if address
  self.fast_processing = fast_processing if fast_processing
  self.login = login if login
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/aspose-email-cloud/models/discover_email_config_request.rb, line 50
def self.swagger_types
  {
    :'address' => :'String',
    :'fast_processing' => :'BOOLEAN',
    :'login' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/aspose-email-cloud/models/discover_email_config_request.rb, line 115
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      address == o.address &&
      fast_processing == o.fast_processing &&
      login == o.login
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-email-cloud/models/discover_email_config_request.rb, line 161
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
    sub_type = value[:type] || value[:discriminator] || type
    if AsposeEmailCloud.const_defined?(sub_type)
      type = sub_type
    end
    temp_model = AsposeEmailCloud.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-email-cloud/models/discover_email_config_request.rb, line 231
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
address=(address) click to toggle source

Custom attribute writer method with validation @param [Object] address Value to be assigned

# File lib/aspose-email-cloud/models/discover_email_config_request.rb, line 101
def address=(address)
  if address.nil?
    fail ArgumentError, 'address cannot be nil'
  end

  if address.to_s.length < 1
    fail ArgumentError, 'invalid value for "address", the character length must be great than or equal to 1.'
  end

  @address = address
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-email-cloud/models/discover_email_config_request.rb, line 138
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    attribute_key = self.class.attribute_map[key]
    attribute_key = (attribute_key[0, 1].downcase + attribute_key[1..-1]).to_sym
    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[attribute_key].is_a?(Array)
        self.send("#{key}=", attributes[attribute_key].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[attribute_key].nil?
      self.send("#{key}=", _deserialize(type, attributes[attribute_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-email-cloud/models/discover_email_config_request.rb, line 125
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-email-cloud/models/discover_email_config_request.rb, line 131
def hash
  [address, fast_processing, login].hash
end
list_invalid_properties() click to toggle source

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

# File lib/aspose-email-cloud/models/discover_email_config_request.rb, line 73
def list_invalid_properties
  invalid_properties = Array.new
  if @address.nil?
    invalid_properties.push('invalid value for "address", address cannot be nil.')
  end

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

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

  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-email-cloud/models/discover_email_config_request.rb, line 211
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-email-cloud/models/discover_email_config_request.rb, line 217
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-email-cloud/models/discover_email_config_request.rb, line 205
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-email-cloud/models/discover_email_config_request.rb, line 92
def valid?
  return false if @address.nil?
  return false if @address.to_s.length < 1
  return false if @fast_processing.nil?
  true
end