class PureCloud::DnclistImportStatusImportStatus
Attributes
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloudplatformclientv2/models/dnclist_import_status_import_status.rb, line 34 def self.attribute_map { :'import_state' => :'importState', :'total_records' => :'totalRecords', :'completed_records' => :'completedRecords', :'percentage_complete' => :'percentageComplete', :'failure_reason' => :'failureReason', :'additional_properties' => :'additionalProperties' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/purecloudplatformclientv2/models/dnclist_import_status_import_status.rb, line 73 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?(:'importState') self.import_state = attributes[:'importState'] end if attributes.has_key?(:'totalRecords') self.total_records = attributes[:'totalRecords'] end if attributes.has_key?(:'completedRecords') self.completed_records = attributes[:'completedRecords'] end if attributes.has_key?(:'percentageComplete') self.percentage_complete = attributes[:'percentageComplete'] end if attributes.has_key?(:'failureReason') self.failure_reason = attributes[:'failureReason'] end if attributes.has_key?(:'additionalProperties') self.additional_properties = attributes[:'additionalProperties'] end end
Attribute
type mapping.
# File lib/purecloudplatformclientv2/models/dnclist_import_status_import_status.rb, line 53 def self.swagger_types { :'import_state' => :'String', :'total_records' => :'Integer', :'completed_records' => :'Integer', :'percentage_complete' => :'Integer', :'failure_reason' => :'String', :'additional_properties' => :'Object' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/dnclist_import_status_import_status.rb, line 222 def ==(o) return true if self.equal?(o) self.class == o.class && import_state == o.import_state && total_records == o.total_records && completed_records == o.completed_records && percentage_complete == o.percentage_complete && failure_reason == o.failure_reason && additional_properties == o.additional_properties end
# File lib/purecloudplatformclientv2/models/dnclist_import_status_import_status.rb, line 265 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 =~ /^(true|t|yes|y|1)$/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 _model = Object.const_get("PureCloud").const_get(type).new _model.build_from_hash(value) end end
Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
# File lib/purecloudplatformclientv2/models/dnclist_import_status_import_status.rb, line 325 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 the object from hash
# File lib/purecloudplatformclientv2/models/dnclist_import_status_import_status.rb, line 246 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /^Array<(.*)>/i if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } ) else #TODO show warning in debug mode end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) else # data not found in attributes(hash), not an issue as the data can be optional end end self end
@see the `==` method @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/dnclist_import_status_import_status.rb, line 235 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/purecloudplatformclientv2/models/dnclist_import_status_import_status.rb, line 241 def hash [import_state, total_records, completed_records, percentage_complete, failure_reason, additional_properties].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] import_state
Object to be assigned
# File lib/purecloudplatformclientv2/models/dnclist_import_status_import_status.rb, line 184 def import_state=(import_state) allowed_values = ["IN_PROGRESS", "FAILED"] if import_state && !allowed_values.include?(import_state) fail ArgumentError, "invalid value for 'import_state', must be one of #{allowed_values}." end @import_state = import_state end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/purecloudplatformclientv2/models/dnclist_import_status_import_status.rb, line 138 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
return the object in the form of hash
# File lib/purecloudplatformclientv2/models/dnclist_import_status_import_status.rb, line 313 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
# File lib/purecloudplatformclientv2/models/dnclist_import_status_import_status.rb, line 303 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/purecloudplatformclientv2/models/dnclist_import_status_import_status.rb, line 147 def valid? allowed_values = ["IN_PROGRESS", "FAILED"] if @import_state && !allowed_values.include?(@import_state) return false end end