Class: PureCloud::ImportStatus

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ImportStatus

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/purecloudplatformclientv2/models/import_status.rb', line 60

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?(:'state')
    self.state = attributes[:'state']
  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?(:'percentComplete')
    self.percent_complete = attributes[:'percentComplete']
  end

  if attributes.has_key?(:'failureReason')
    self.failure_reason = attributes[:'failureReason']
  end

end

Instance Attribute Details

#completed_records ⇒ Object

number of records finished importing



28
29
30
 
# File 'lib/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/models/import_status.rb', line 31

def percent_complete
  @percent_complete
end

#state ⇒ Object

current status of the import



22
23
24
 
# File 'lib/purecloudplatformclientv2/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/purecloudplatformclientv2/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
 
# File 'lib/purecloudplatformclientv2/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.



48
49
50
51
52
53
54
55
56
 
# File 'lib/purecloudplatformclientv2/models/import_status.rb', line 48

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



132
133
134
135
136
137
138
139
140
 
# File 'lib/purecloudplatformclientv2/models/import_status.rb', line 132

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 



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/purecloudplatformclientv2/models/import_status.rb', line 174

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



234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/purecloudplatformclientv2/models/import_status.rb', line 234

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



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/purecloudplatformclientv2/models/import_status.rb', line 155

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


144
145
146
 
# File 'lib/purecloudplatformclientv2/models/import_status.rb', line 144

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



150
151
152
 
# File 'lib/purecloudplatformclientv2/models/import_status.rb', line 150

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

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



90
91
92
93
 
# File 'lib/purecloudplatformclientv2/models/import_status.rb', line 90

def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



217
218
219
 
# File 'lib/purecloudplatformclientv2/models/import_status.rb', line 217

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



222
223
224
225
226
227
228
229
230
 
# File 'lib/purecloudplatformclientv2/models/import_status.rb', line 222

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 



212
213
214
 
# File 'lib/purecloudplatformclientv2/models/import_status.rb', line 212

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/purecloudplatformclientv2/models/import_status.rb', line 97

def valid?
  if @state.nil?
    return false
  end

  allowed_values = ["IN_PROGRESS", "FAILED"]
  if @state && !allowed_values.include?(@state)
    return false
  end
  if @total_records.nil?
    return false
  end

  if @completed_records.nil?
    return false
  end

  if @percent_complete.nil?
    return false
  end

end