Class: PureCloud::ImportStatus

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/models/import_status.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ImportStatus

Returns a new instance of ImportStatus.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/purecloud/models/import_status.rb', line 65

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}

  
  if attributes[:'state']
    self.state = attributes[:'state']
  end
  
  if attributes[:'totalRecords']
    self.total_records = attributes[:'totalRecords']
  end
  
  if attributes[:'completedRecords']
    self.completed_records = attributes[:'completedRecords']
  end
  
  if attributes[:'percentComplete']
    self.percent_complete = attributes[:'percentComplete']
  end
  
  if attributes[:'failureReason']
    self.failure_reason = attributes[:'failureReason']
  end
  
end

Instance Attribute Details

#completed_records ⇒ Object

number of records finished importing



28
29
30
 
# File 'lib/purecloud/models/import_status.rb', line 28

def completed_records
  @completed_records
end

#failure_reason ⇒ Object

if the import has failed, the reason for the failure



34
35
36
 
# File 'lib/purecloud/models/import_status.rb', line 34

def failure_reason
  @failure_reason
end

#percent_complete ⇒ Object

percentage of records finished importing



31
32
33
 
# File 'lib/purecloud/models/import_status.rb', line 31

def percent_complete
  @percent_complete
end

#state ⇒ Object

current status of the import



22
23
24
 
# File 'lib/purecloud/models/import_status.rb', line 22

def state
  @state
end

#total_records ⇒ Object

total number of records to be imported



25
26
27
 
# File 'lib/purecloud/models/import_status.rb', line 25

def total_records
  @total_records
end

Class Method Details

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/purecloud/models/import_status.rb', line 37

def self.attribute_map
  {
    
    :'state' => :'state',
    
    :'total_records' => :'totalRecords',
    
    :'completed_records' => :'completedRecords',
    
    :'percent_complete' => :'percentComplete',
    
    :'failure_reason' => :'failureReason'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
63
 
# File 'lib/purecloud/models/import_status.rb', line 54

def self.swagger_types
  {
    :'state' => :'String',
    :'total_records' => :'Integer',
    :'completed_records' => :'Integer',
    :'percent_complete' => :'Integer',
    :'failure_reason' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



104
105
106
107
108
109
110
111
112
 
# File 'lib/purecloud/models/import_status.rb', line 104

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      state == o.state &&
      total_records == o.total_records &&
      completed_records == o.completed_records &&
      percent_complete == o.percent_complete &&
      failure_reason == o.failure_reason
end

#_deserialize(type, value) ⇒ Object 



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
 
# File 'lib/purecloud/models/import_status.rb', line 144

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

#_to_hash(value) ⇒ Object

Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/purecloud/models/import_status.rb', line 204

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

build the object from hash



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/purecloud/models/import_status.rb', line 125

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

#eql?(o) ⇒ Boolean

Returns:

  • (Boolean)

See Also:

  • `==` method


115
116
117
 
# File 'lib/purecloud/models/import_status.rb', line 115

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



120
121
122
 
# File 'lib/purecloud/models/import_status.rb', line 120

def hash
  [state, total_records, completed_records, percent_complete, failure_reason].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



187
188
189
 
# File 'lib/purecloud/models/import_status.rb', line 187

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



192
193
194
195
196
197
198
199
200
 
# File 'lib/purecloud/models/import_status.rb', line 192

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 ⇒ Object 



182
183
184
 
# File 'lib/purecloud/models/import_status.rb', line 182

def to_s
  to_hash.to_s
end