class Alfresco::SearchRequest
Attributes
When true, include the original request in the response
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/alfresco/models/search_request.rb, line 61 def self.attribute_map { :'query' => :'query', :'paging' => :'paging', :'include' => :'include', :'include_request' => :'includeRequest', :'fields' => :'fields', :'sort' => :'sort', :'templates' => :'templates', :'defaults' => :'defaults', :'localization' => :'localization', :'filter_queries' => :'filterQueries', :'facet_queries' => :'facetQueries', :'facet_fields' => :'facetFields', :'facet_intervals' => :'facetIntervals', :'pivots' => :'pivots', :'stats' => :'stats', :'spellcheck' => :'spellcheck', :'scope' => :'scope', :'limits' => :'limits', :'highlight' => :'highlight', :'ranges' => :'ranges' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/alfresco/models/search_request.rb, line 114 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?(:'query') self.query = attributes[:'query'] end if attributes.has_key?(:'paging') self.paging = attributes[:'paging'] end if attributes.has_key?(:'include') self.include = attributes[:'include'] end if attributes.has_key?(:'includeRequest') self.include_request = attributes[:'includeRequest'] else self.include_request = false end if attributes.has_key?(:'fields') self.fields = attributes[:'fields'] end if attributes.has_key?(:'sort') self.sort = attributes[:'sort'] end if attributes.has_key?(:'templates') self.templates = attributes[:'templates'] end if attributes.has_key?(:'defaults') self.defaults = attributes[:'defaults'] end if attributes.has_key?(:'localization') self.localization = attributes[:'localization'] end if attributes.has_key?(:'filterQueries') self.filter_queries = attributes[:'filterQueries'] end if attributes.has_key?(:'facetQueries') self.facet_queries = attributes[:'facetQueries'] end if attributes.has_key?(:'facetFields') self.facet_fields = attributes[:'facetFields'] end if attributes.has_key?(:'facetIntervals') self.facet_intervals = attributes[:'facetIntervals'] end if attributes.has_key?(:'pivots') if (value = attributes[:'pivots']).is_a?(Array) self.pivots = value end end if attributes.has_key?(:'stats') if (value = attributes[:'stats']).is_a?(Array) self.stats = value end end if attributes.has_key?(:'spellcheck') self.spellcheck = attributes[:'spellcheck'] end if attributes.has_key?(:'scope') self.scope = attributes[:'scope'] end if attributes.has_key?(:'limits') self.limits = attributes[:'limits'] end if attributes.has_key?(:'highlight') self.highlight = attributes[:'highlight'] end if attributes.has_key?(:'ranges') if (value = attributes[:'ranges']).is_a?(Array) self.ranges = value end end end
Attribute type mapping.
# File lib/alfresco/models/search_request.rb, line 87 def self.swagger_types { :'query' => :'RequestQuery', :'paging' => :'RequestPagination', :'include' => :'RequestInclude', :'include_request' => :'BOOLEAN', :'fields' => :'RequestFields', :'sort' => :'RequestSortDefinition', :'templates' => :'RequestTemplates', :'defaults' => :'RequestDefaults', :'localization' => :'RequestLocalization', :'filter_queries' => :'RequestFilterQueries', :'facet_queries' => :'RequestFacetQueries', :'facet_fields' => :'RequestFacetFields', :'facet_intervals' => :'RequestFacetIntervals', :'pivots' => :'Array<RequestPivot>', :'stats' => :'Array<RequestStats>', :'spellcheck' => :'RequestSpellcheck', :'scope' => :'RequestScope', :'limits' => :'RequestLimits', :'highlight' => :'RequestHighlight', :'ranges' => :'Array<RequestRange>' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/alfresco/models/search_request.rb, line 230 def ==(o) return true if self.equal?(o) self.class == o.class && query == o.query && paging == o.paging && include == o.include && include_request == o.include_request && fields == o.fields && sort == o.sort && templates == o.templates && defaults == o.defaults && localization == o.localization && filter_queries == o.filter_queries && facet_queries == o.facet_queries && facet_fields == o.facet_fields && facet_intervals == o.facet_intervals && pivots == o.pivots && stats == o.stats && spellcheck == o.spellcheck && scope == o.scope && limits == o.limits && highlight == o.highlight && ranges == o.ranges end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/alfresco/models/search_request.rb, line 291 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 =~ /\A(true|t|yes|y|1)\z/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 temp_model = Alfresco.const_get(type).new temp_model.build_from_hash(value) end end
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/alfresco/models/search_request.rb, line 357 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/alfresco/models/search_request.rb, line 270 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } ) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end
@see the `==` method @param [Object] Object to be compared
# File lib/alfresco/models/search_request.rb, line 257 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/alfresco/models/search_request.rb, line 263 def hash [query, paging, include, include_request, fields, sort, templates, defaults, localization, filter_queries, facet_queries, facet_fields, facet_intervals, pivots, stats, spellcheck, scope, limits, highlight, ranges].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/alfresco/models/search_request.rb, line 212 def list_invalid_properties invalid_properties = Array.new if @query.nil? invalid_properties.push("invalid value for 'query', query cannot be nil.") end return invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/alfresco/models/search_request.rb, line 343 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/alfresco/models/search_request.rb, line 331 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/alfresco/models/search_request.rb, line 223 def valid? return false if @query.nil? return true end