class PureCloud::UsersSearchResponse
Attributes
current_page[RW]
Q64 value for the current page of results
next_page[RW]
Q64 value for the next page of results
page_count[RW]
The total number of pages
page_number[RW]
The current page number
page_size[RW]
The current page size
previous_page[RW]
Q64 value for the previous page of results
results[RW]
Search results
total[RW]
The total number of results found
types[RW]
Resource types the search was performed against
Public Class Methods
attribute_map()
click to toggle source
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloud/models/users_search_response.rb, line 49 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' } end
new(attributes = {})
click to toggle source
# File lib/purecloud/models/users_search_response.rb, line 89 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'] if (value = attributes[:'results']).is_a?(Array) self.results = value end end end
swagger_types()
click to toggle source
Attribute
type mapping.
# File lib/purecloud/models/users_search_response.rb, line 74 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' => :'Array<User>' } end
Public Instance Methods
==(o)
click to toggle source
Check equality by comparing each attribute.
# File lib/purecloud/models/users_search_response.rb, line 139 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 end
_deserialize(type, value)
click to toggle source
# File lib/purecloud/models/users_search_response.rb, line 183 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)
click to toggle source
Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
# File lib/purecloud/models/users_search_response.rb, line 243 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)
click to toggle source
build the object from hash
# File lib/purecloud/models/users_search_response.rb, line 164 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)
click to toggle source
@see the `==` method
# File lib/purecloud/models/users_search_response.rb, line 154 def eql?(o) self == o end
hash()
click to toggle source
Calculate hash code according to all attributes.
# File lib/purecloud/models/users_search_response.rb, line 159 def hash [total, page_count, page_size, page_number, previous_page, current_page, next_page, types, results].hash end
to_body()
click to toggle source
to_hash()
click to toggle source
return the object in the form of hash
# File lib/purecloud/models/users_search_response.rb, line 231 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()
click to toggle source
# File lib/purecloud/models/users_search_response.rb, line 221 def to_s to_hash.to_s end