class CloudmersiveValidateApiClient::ValidateIdentifierRequest

Identifier validation request, including the input identifier as well as various identifier rules

Attributes

allow_hyphens[RW]

True if hyphens are allowd in the identifier, false otherwise

allow_numbers[RW]

True if numbers are allowed in the identifier, false otherwise

allow_periods[RW]

True if periods are allowed in the identifier, false otherwise

allow_underscore[RW]

True if underscores are allowed in the identifier, false otherwise

allow_whitespace[RW]

True if whitespace is allowed in the identifier, false otherwise

input[RW]

Text string identifier input

max_length[RW]

Optional; maximum length, if any, of the identifier

min_length[RW]

Optional; minimum length, if any, of the identifier

Public Class Methods

attribute_map() click to toggle source

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

# File lib/cloudmersive-validate-api-client/models/validate_identifier_request.rb, line 43
def self.attribute_map
  {
    :'input' => :'Input',
    :'allow_whitespace' => :'AllowWhitespace',
    :'allow_hyphens' => :'AllowHyphens',
    :'allow_underscore' => :'AllowUnderscore',
    :'allow_numbers' => :'AllowNumbers',
    :'allow_periods' => :'AllowPeriods',
    :'max_length' => :'MaxLength',
    :'min_length' => :'MinLength'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/cloudmersive-validate-api-client/models/validate_identifier_request.rb, line 72
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?(:'Input')
    self.input = attributes[:'Input']
  end

  if attributes.has_key?(:'AllowWhitespace')
    self.allow_whitespace = attributes[:'AllowWhitespace']
  end

  if attributes.has_key?(:'AllowHyphens')
    self.allow_hyphens = attributes[:'AllowHyphens']
  end

  if attributes.has_key?(:'AllowUnderscore')
    self.allow_underscore = attributes[:'AllowUnderscore']
  end

  if attributes.has_key?(:'AllowNumbers')
    self.allow_numbers = attributes[:'AllowNumbers']
  end

  if attributes.has_key?(:'AllowPeriods')
    self.allow_periods = attributes[:'AllowPeriods']
  end

  if attributes.has_key?(:'MaxLength')
    self.max_length = attributes[:'MaxLength']
  end

  if attributes.has_key?(:'MinLength')
    self.min_length = attributes[:'MinLength']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/cloudmersive-validate-api-client/models/validate_identifier_request.rb, line 57
def self.swagger_types
  {
    :'input' => :'String',
    :'allow_whitespace' => :'BOOLEAN',
    :'allow_hyphens' => :'BOOLEAN',
    :'allow_underscore' => :'BOOLEAN',
    :'allow_numbers' => :'BOOLEAN',
    :'allow_periods' => :'BOOLEAN',
    :'max_length' => :'Integer',
    :'min_length' => :'Integer'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/cloudmersive-validate-api-client/models/validate_identifier_request.rb, line 126
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      input == o.input &&
      allow_whitespace == o.allow_whitespace &&
      allow_hyphens == o.allow_hyphens &&
      allow_underscore == o.allow_underscore &&
      allow_numbers == o.allow_numbers &&
      allow_periods == o.allow_periods &&
      max_length == o.max_length &&
      min_length == o.min_length
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/cloudmersive-validate-api-client/models/validate_identifier_request.rb, line 175
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 = CloudmersiveValidateApiClient.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/cloudmersive-validate-api-client/models/validate_identifier_request.rb, line 241
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/cloudmersive-validate-api-client/models/validate_identifier_request.rb, line 154
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 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/cloudmersive-validate-api-client/models/validate_identifier_request.rb, line 141
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/cloudmersive-validate-api-client/models/validate_identifier_request.rb, line 147
def hash
  [input, allow_whitespace, allow_hyphens, allow_underscore, allow_numbers, allow_periods, max_length, min_length].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/cloudmersive-validate-api-client/models/validate_identifier_request.rb, line 113
def list_invalid_properties
  invalid_properties = Array.new
  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/cloudmersive-validate-api-client/models/validate_identifier_request.rb, line 221
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/cloudmersive-validate-api-client/models/validate_identifier_request.rb, line 227
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/cloudmersive-validate-api-client/models/validate_identifier_request.rb, line 215
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/cloudmersive-validate-api-client/models/validate_identifier_request.rb, line 120
def valid?
  true
end