class PureCloud::QueryRequest
Attributes
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloudplatformclientv2/models/query_request.rb, line 38 def self.attribute_map { :'query_phrase' => :'queryPhrase', :'page_number' => :'pageNumber', :'page_size' => :'pageSize', :'facet_name_requests' => :'facetNameRequests', :'sort' => :'sort', :'filters' => :'filters', :'attribute_filters' => :'attributeFilters', :'include_shares' => :'includeShares' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/purecloudplatformclientv2/models/query_request.rb, line 85 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?(:'queryPhrase') self.query_phrase = attributes[:'queryPhrase'] end if attributes.has_key?(:'pageNumber') self.page_number = attributes[:'pageNumber'] end if attributes.has_key?(:'pageSize') self.page_size = attributes[:'pageSize'] end if attributes.has_key?(:'facetNameRequests') if (value = attributes[:'facetNameRequests']).is_a?(Array) self.facet_name_requests = value end end if attributes.has_key?(:'sort') if (value = attributes[:'sort']).is_a?(Array) self.sort = value end end if attributes.has_key?(:'filters') if (value = attributes[:'filters']).is_a?(Array) self.filters = value end end if attributes.has_key?(:'attributeFilters') if (value = attributes[:'attributeFilters']).is_a?(Array) self.attribute_filters = value end end if attributes.has_key?(:'includeShares') self.include_shares = attributes[:'includeShares'] end end
Attribute
type mapping.
# File lib/purecloudplatformclientv2/models/query_request.rb, line 61 def self.swagger_types { :'query_phrase' => :'String', :'page_number' => :'Integer', :'page_size' => :'Integer', :'facet_name_requests' => :'Array<String>', :'sort' => :'Array<SortItem>', :'filters' => :'Array<ContentFilterItem>', :'attribute_filters' => :'Array<AttributeFilterItem>', :'include_shares' => :'BOOLEAN' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/query_request.rb, line 264 def ==(o) return true if self.equal?(o) self.class == o.class && query_phrase == o.query_phrase && page_number == o.page_number && page_size == o.page_size && facet_name_requests == o.facet_name_requests && sort == o.sort && filters == o.filters && attribute_filters == o.attribute_filters && include_shares == o.include_shares end
# File lib/purecloudplatformclientv2/models/query_request.rb, line 309 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/purecloudplatformclientv2/models/query_request.rb, line 369 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/purecloudplatformclientv2/models/query_request.rb, line 290 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 @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/query_request.rb, line 279 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/purecloudplatformclientv2/models/query_request.rb, line 285 def hash [query_phrase, page_number, page_size, facet_name_requests, sort, filters, attribute_filters, include_shares].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/purecloudplatformclientv2/models/query_request.rb, line 176 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
return the object in the form of hash
# File lib/purecloudplatformclientv2/models/query_request.rb, line 357 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/purecloudplatformclientv2/models/query_request.rb, line 347 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/purecloudplatformclientv2/models/query_request.rb, line 185 def valid? end