class PureCloud::SearchRequest
Attributes
Aggregation criteria
Provides more details about a specified resource
The page of resources you want to retrieve
The number of results per page
The search criteria
A List of strings. Possible values are any field in the resource you are searching on. The other option is to use ALL_FIELDS, when this is provided all fields in the resource will be returned in the search results.
The field in the resource that you want to sort the results by
The sort order for results
Resource domain type to search
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloud/models/search_request.rb, line 49 def self.attribute_map { :'sort_order' => :'sortOrder', :'sort_by' => :'sortBy', :'page_size' => :'pageSize', :'page_number' => :'pageNumber', :'return_fields' => :'returnFields', :'expand' => :'expand', :'types' => :'types', :'query' => :'query', :'aggregations' => :'aggregations' } end
# File lib/purecloud/models/search_request.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[:'sortOrder'] self.sort_order = attributes[:'sortOrder'] end if attributes[:'sortBy'] self.sort_by = attributes[:'sortBy'] end if attributes[:'pageSize'] self.page_size = attributes[:'pageSize'] end if attributes[:'pageNumber'] self.page_number = attributes[:'pageNumber'] end if attributes[:'returnFields'] if (value = attributes[:'returnFields']).is_a?(Array) self.return_fields = value end end if attributes[:'expand'] if (value = attributes[:'expand']).is_a?(Array) self.expand = value end end if attributes[:'types'] if (value = attributes[:'types']).is_a?(Array) self.types = value end end if attributes[:'query'] if (value = attributes[:'query']).is_a?(Array) self.query = value end end if attributes[:'aggregations'] if (value = attributes[:'aggregations']).is_a?(Array) self.aggregations = value end end end
Attribute
type mapping.
# File lib/purecloud/models/search_request.rb, line 74 def self.swagger_types { :'sort_order' => :'String', :'sort_by' => :'String', :'page_size' => :'Integer', :'page_number' => :'Integer', :'return_fields' => :'Array<String>', :'expand' => :'Array<String>', :'types' => :'Array<String>', :'query' => :'Array<SearchCriteria>', :'aggregations' => :'Array<SearchAggregation>' } end
Public Instance Methods
Check equality by comparing each attribute.
# File lib/purecloud/models/search_request.rb, line 154 def ==(o) return true if self.equal?(o) self.class == o.class && sort_order == o.sort_order && sort_by == o.sort_by && page_size == o.page_size && page_number == o.page_number && return_fields == o.return_fields && expand == o.expand && types == o.types && query == o.query && aggregations == o.aggregations end
# File lib/purecloud/models/search_request.rb, line 198 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
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/search_request.rb, line 258 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 the object from hash
# File lib/purecloud/models/search_request.rb, line 179 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
@see the `==` method
# File lib/purecloud/models/search_request.rb, line 169 def eql?(o) self == o end
Calculate hash code according to all attributes.
# File lib/purecloud/models/search_request.rb, line 174 def hash [sort_order, sort_by, page_size, page_number, return_fields, expand, types, query, aggregations].hash end
Custom attribute writer method checking allowed values (enum).
# File lib/purecloud/models/search_request.rb, line 145 def sort_order=(sort_order) allowed_values = ["ASC", "DESC", "SCORE"] if sort_order && !allowed_values.include?(sort_order) fail "invalid value for 'sort_order', must be one of #{allowed_values}" end @sort_order = sort_order end
return the object in the form of hash
# File lib/purecloud/models/search_request.rb, line 246 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
# File lib/purecloud/models/search_request.rb, line 236 def to_s to_hash.to_s end