Class: PureCloud::Operation

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Operation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/purecloudplatformclientv2/models/operation.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?(:'id')
    self.id = attributes[:'id']
  end

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

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

  if attributes.has_key?(:'errorMessage')
    self.error_message = attributes[:'errorMessage']
  end

  if attributes.has_key?(:'errorCode')
    self.error_code = attributes[:'errorCode']
  end

  if attributes.has_key?(:'errorDetails')
    if (value = attributes[:'errorDetails']).is_a?(Array)
      self.error_details = value
    end
  end

  if attributes.has_key?(:'errorMessageParams')
    if (value = attributes[:'errorMessageParams']).is_a?(Array)
      self.error_message_params = value
    end
  end

  if attributes.has_key?(:'actionName')
    self.action_name = attributes[:'actionName']
  end

  if attributes.has_key?(:'actionStatus')
    self.action_status = attributes[:'actionStatus']
  end

end

Instance Attribute Details

#action_name ⇒ Object

Action name



36
37
38
 
# File 'lib/purecloudplatformclientv2/models/operation.rb', line 36

def action_name
  @action_name
end

#action_status ⇒ Object

Action status



39
40
41
 
# File 'lib/purecloudplatformclientv2/models/operation.rb', line 39

def action_status
  @action_status
end

#complete ⇒ Object

Returns the value of attribute complete.



23
24
25
 
# File 'lib/purecloudplatformclientv2/models/operation.rb', line 23

def complete
  @complete
end

#error_code ⇒ Object

Returns the value of attribute error_code.



29
30
31
 
# File 'lib/purecloudplatformclientv2/models/operation.rb', line 29

def error_code
  @error_code
end

#error_details ⇒ Object

Returns the value of attribute error_details.



31
32
33
 
# File 'lib/purecloudplatformclientv2/models/operation.rb', line 31

def error_details
  @error_details
end

#error_message ⇒ Object

Returns the value of attribute error_message.



27
28
29
 
# File 'lib/purecloudplatformclientv2/models/operation.rb', line 27

def error_message
  @error_message
end

#error_message_params ⇒ Object

Returns the value of attribute error_message_params.



33
34
35
 
# File 'lib/purecloudplatformclientv2/models/operation.rb', line 33

def error_message_params
  @error_message_params
end

#id ⇒ Object

Returns the value of attribute id.



21
22
23
 
# File 'lib/purecloudplatformclientv2/models/operation.rb', line 21

def id
  @id
end

#user ⇒ Object

Returns the value of attribute user.



25
26
27
 
# File 'lib/purecloudplatformclientv2/models/operation.rb', line 25

def user
  @user
end

Class Method Details

.attribute_map ⇒ Object

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



42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/purecloudplatformclientv2/models/operation.rb', line 42

def self.attribute_map
  {
    :'id' => :'id',
    :'complete' => :'complete',
    :'user' => :'user',
    :'error_message' => :'errorMessage',
    :'error_code' => :'errorCode',
    :'error_details' => :'errorDetails',
    :'error_message_params' => :'errorMessageParams',
    :'action_name' => :'actionName',
    :'action_status' => :'actionStatus'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/purecloudplatformclientv2/models/operation.rb', line 57

def self.swagger_types
  {
    :'id' => :'String',
    :'complete' => :'BOOLEAN',
    :'user' => :'User',
    :'error_message' => :'String',
    :'error_code' => :'String',
    :'error_details' => :'Array<Detail>',
    :'error_message_params' => :'Hash<String, String>',
    :'action_name' => :'String',
    :'action_status' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/purecloudplatformclientv2/models/operation.rb', line 163

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      complete == o.complete &&
      user == o.user &&
      error_message == o.error_message &&
      error_code == o.error_code &&
      error_details == o.error_details &&
      error_message_params == o.error_message_params &&
      action_name == o.action_name &&
      action_status == o.action_status
end

#_deserialize(type, value) ⇒ Object 



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/purecloudplatformclientv2/models/operation.rb', line 209

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



269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/purecloudplatformclientv2/models/operation.rb', line 269

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



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/purecloudplatformclientv2/models/operation.rb', line 190

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


179
180
181
 
# File 'lib/purecloudplatformclientv2/models/operation.rb', line 179

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



185
186
187
 
# File 'lib/purecloudplatformclientv2/models/operation.rb', line 185

def hash
  [id, complete, user, error_message, error_code, error_details, error_message_params, action_name, action_status].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



123
124
125
126
 
# File 'lib/purecloudplatformclientv2/models/operation.rb', line 123

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))



252
253
254
 
# File 'lib/purecloudplatformclientv2/models/operation.rb', line 252

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



257
258
259
260
261
262
263
264
265
 
# File 'lib/purecloudplatformclientv2/models/operation.rb', line 257

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 



247
248
249
 
# File 'lib/purecloudplatformclientv2/models/operation.rb', line 247

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



130
131
132
133
134
135
136
137
138
139
 
# File 'lib/purecloudplatformclientv2/models/operation.rb', line 130

def valid?
  allowed_values = ["CHECKIN", "DEBUG", "DELETE", "PUBLISH", "STATE_CHANGE", "VALIDATE"]
  if @action_name && !allowed_values.include?(@action_name)
    return false
  end
  allowed_values = ["LOCKED", "UNLOCKED", "STARTED", "PENDING_GENERATION", "PENDING_BACKEND_NOTIFICATION", "SUCCESS", "FAILURE"]
  if @action_status && !allowed_values.include?(@action_status)
    return false
  end
end