Class: PureCloud::TransformEndpoint

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TransformEndpoint

Returns a new instance of TransformEndpoint.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/purecloud/models/transform_endpoint.rb', line 106

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[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'name']
    self.name = attributes[:'name']
  end
  
  if attributes[:'swaggerUrl']
    self.swagger_url = attributes[:'swaggerUrl']
  end
  
  if attributes[:'route']
    self.route = attributes[:'route']
  end
  
  if attributes[:'entity']
    self.entity = attributes[:'entity']
  end
  
  if attributes[:'apiFunction']
    self.api_function = attributes[:'apiFunction']
  end
  
  if attributes[:'ready']
    self.ready = attributes[:'ready']
  else
    self.ready = false
  end
  
  if attributes[:'active']
    self.active = attributes[:'active']
  else
    self.active = false
  end
  
  if attributes[:'batchSize']
    self.batch_size = attributes[:'batchSize']
  end
  
  if attributes[:'parallelism']
    self.parallelism = attributes[:'parallelism']
  end
  
  if attributes[:'updateProgressEvery']
    self.update_progress_every = attributes[:'updateProgressEvery']
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#active ⇒ Object

Whether this TransformEndpoint is currently active and accepting transformation operations



42
43
44
 
# File 'lib/purecloud/models/transform_endpoint.rb', line 42

def active
  @active
end

#api_function ⇒ Object

The swagger function being called



36
37
38
 
# File 'lib/purecloud/models/transform_endpoint.rb', line 36

def api_function
  @api_function
end

#batch_size ⇒ Object

The number of entities to send in an array for batch POSTs, or 0 for unbatched POSTs



45
46
47
 
# File 'lib/purecloud/models/transform_endpoint.rb', line 45

def batch_size
  @batch_size
end

#entity ⇒ Object

The entity type being posted



33
34
35
 
# File 'lib/purecloud/models/transform_endpoint.rb', line 33

def entity
  @entity
end

#id ⇒ Object

The globally unique identifier for the object.



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

def id
  @id
end

#name ⇒ Object

Returns the value of attribute name.



24
25
26
 
# File 'lib/purecloud/models/transform_endpoint.rb', line 24

def name
  @name
end

#parallelism ⇒ Object

The number of parallel POSTs to allow at once



48
49
50
 
# File 'lib/purecloud/models/transform_endpoint.rb', line 48

def parallelism
  @parallelism
end

#ready ⇒ Object

Whether this TransformEndpoint has been configured to work (security groups, permissions, etc)



39
40
41
 
# File 'lib/purecloud/models/transform_endpoint.rb', line 39

def ready
  @ready
end

#route ⇒ Object

The swagger route to use



30
31
32
 
# File 'lib/purecloud/models/transform_endpoint.rb', line 30

def route
  @route
end

#self_uri ⇒ Object

The URI for this object



54
55
56
 
# File 'lib/purecloud/models/transform_endpoint.rb', line 54

def self_uri
  @self_uri
end

#swagger_url ⇒ Object

The Url to the swagger documentation of the endpoint where parsed entities will be posted



27
28
29
 
# File 'lib/purecloud/models/transform_endpoint.rb', line 27

def swagger_url
  @swagger_url
end

#update_progress_every ⇒ Object

The swagger route to use



51
52
53
 
# File 'lib/purecloud/models/transform_endpoint.rb', line 51

def update_progress_every
  @update_progress_every
end

Class Method Details

.attribute_map ⇒ Object

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



57
58
59
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
 
# File 'lib/purecloud/models/transform_endpoint.rb', line 57

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'swagger_url' => :'swaggerUrl',
    
    :'route' => :'route',
    
    :'entity' => :'entity',
    
    :'api_function' => :'apiFunction',
    
    :'ready' => :'ready',
    
    :'active' => :'active',
    
    :'batch_size' => :'batchSize',
    
    :'parallelism' => :'parallelism',
    
    :'update_progress_every' => :'updateProgressEvery',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/purecloud/models/transform_endpoint.rb', line 88

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'swagger_url' => :'String',
    :'route' => :'String',
    :'entity' => :'String',
    :'api_function' => :'String',
    :'ready' => :'BOOLEAN',
    :'active' => :'BOOLEAN',
    :'batch_size' => :'Integer',
    :'parallelism' => :'Integer',
    :'update_progress_every' => :'Integer',
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/purecloud/models/transform_endpoint.rb', line 168

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      swagger_url == o.swagger_url &&
      route == o.route &&
      entity == o.entity &&
      api_function == o.api_function &&
      ready == o.ready &&
      active == o.active &&
      batch_size == o.batch_size &&
      parallelism == o.parallelism &&
      update_progress_every == o.update_progress_every &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



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
246
247
248
249
250
251
 
# File 'lib/purecloud/models/transform_endpoint.rb', line 215

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



275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/purecloud/models/transform_endpoint.rb', line 275

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



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/purecloud/models/transform_endpoint.rb', line 196

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


186
187
188
 
# File 'lib/purecloud/models/transform_endpoint.rb', line 186

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



191
192
193
 
# File 'lib/purecloud/models/transform_endpoint.rb', line 191

def hash
  [id, name, swagger_url, route, entity, api_function, ready, active, batch_size, parallelism, update_progress_every, self_uri].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



258
259
260
 
# File 'lib/purecloud/models/transform_endpoint.rb', line 258

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



263
264
265
266
267
268
269
270
271
 
# File 'lib/purecloud/models/transform_endpoint.rb', line 263

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 



253
254
255
 
# File 'lib/purecloud/models/transform_endpoint.rb', line 253

def to_s
  to_hash.to_s
end