Class: PureCloud::JsonNodeSearchResponse

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ JsonNodeSearchResponse

Returns a new instance of JsonNodeSearchResponse.



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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/purecloud/models/json_node_search_response.rb', line 94

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[:'total']
    self.total = attributes[:'total']
  end
  
  if attributes[:'pageCount']
    self.page_count = attributes[:'pageCount']
  end
  
  if attributes[:'pageSize']
    self.page_size = attributes[:'pageSize']
  end
  
  if attributes[:'pageNumber']
    self.page_number = attributes[:'pageNumber']
  end
  
  if attributes[:'previousPage']
    self.previous_page = attributes[:'previousPage']
  end
  
  if attributes[:'currentPage']
    self.current_page = attributes[:'currentPage']
  end
  
  if attributes[:'nextPage']
    self.next_page = attributes[:'nextPage']
  end
  
  if attributes[:'types']
    if (value = attributes[:'types']).is_a?(Array)
      self.types = value
    end
  end
  
  if attributes[:'results']
    self.results = attributes[:'results']
  end
  
  if attributes[:'aggregations']
    self.aggregations = attributes[:'aggregations']
  end
  
end

Instance Attribute Details

#aggregations ⇒ Object

Returns the value of attribute aggregations.



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

def aggregations
  @aggregations
end

#current_page ⇒ Object

Q64 value for the current page of results



37
38
39
 
# File 'lib/purecloud/models/json_node_search_response.rb', line 37

def current_page
  @current_page
end

#next_page ⇒ Object

Q64 value for the next page of results



40
41
42
 
# File 'lib/purecloud/models/json_node_search_response.rb', line 40

def next_page
  @next_page
end

#page_count ⇒ Object

The total number of pages



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

def page_count
  @page_count
end

#page_number ⇒ Object

The current page number



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

def page_number
  @page_number
end

#page_size ⇒ Object

The current page size



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

def page_size
  @page_size
end

#previous_page ⇒ Object

Q64 value for the previous page of results



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

def previous_page
  @previous_page
end

#results ⇒ Object

Search results



46
47
48
 
# File 'lib/purecloud/models/json_node_search_response.rb', line 46

def results
  @results
end

#total ⇒ Object

The total number of results found



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

def total
  @total
end

#types ⇒ Object

Resource types the search was performed against



43
44
45
 
# File 'lib/purecloud/models/json_node_search_response.rb', line 43

def types
  @types
end

Class Method Details

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/purecloud/models/json_node_search_response.rb', line 51

def self.attribute_map
  {
    
    :'total' => :'total',
    
    :'page_count' => :'pageCount',
    
    :'page_size' => :'pageSize',
    
    :'page_number' => :'pageNumber',
    
    :'previous_page' => :'previousPage',
    
    :'current_page' => :'currentPage',
    
    :'next_page' => :'nextPage',
    
    :'types' => :'types',
    
    :'results' => :'results',
    
    :'aggregations' => :'aggregations'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/purecloud/models/json_node_search_response.rb', line 78

def self.swagger_types
  {
    :'total' => :'Integer',
    :'page_count' => :'Integer',
    :'page_size' => :'Integer',
    :'page_number' => :'Integer',
    :'previous_page' => :'String',
    :'current_page' => :'String',
    :'next_page' => :'String',
    :'types' => :'Array<String>',
    :'results' => :'JsonNode',
    :'aggregations' => :'JsonNode'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/purecloud/models/json_node_search_response.rb', line 146

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      total == o.total &&
      page_count == o.page_count &&
      page_size == o.page_size &&
      page_number == o.page_number &&
      previous_page == o.previous_page &&
      current_page == o.current_page &&
      next_page == o.next_page &&
      types == o.types &&
      results == o.results &&
      aggregations == o.aggregations
end

#_deserialize(type, value) ⇒ Object 



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/purecloud/models/json_node_search_response.rb', line 191

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



251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/purecloud/models/json_node_search_response.rb', line 251

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



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/purecloud/models/json_node_search_response.rb', line 172

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


162
163
164
 
# File 'lib/purecloud/models/json_node_search_response.rb', line 162

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



167
168
169
 
# File 'lib/purecloud/models/json_node_search_response.rb', line 167

def hash
  [total, page_count, page_size, page_number, previous_page, current_page, next_page, types, results, aggregations].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



234
235
236
 
# File 'lib/purecloud/models/json_node_search_response.rb', line 234

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



239
240
241
242
243
244
245
246
247
 
# File 'lib/purecloud/models/json_node_search_response.rb', line 239

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 



229
230
231
 
# File 'lib/purecloud/models/json_node_search_response.rb', line 229

def to_s
  to_hash.to_s
end