class OCI::DataCatalog::Models::SearchCriteria
Search Query object that allows complex search predicates that cannot be expressed through simple query params.
Attributes
List of properties of dataObjects that needs to aggregated on for facets. @return [Array<String>]
Query string that a dataObject is to be searched with. Used in the faceted query request @return [String]
@return [OCI::DataCatalog::Models::FacetedSearchFilterRequest]
Search query dsl that defines the query components including fields and predicates. @return [String]
Array of objects having details about sort field and order. @return [Array<OCI::DataCatalog::Models::FacetedSearchSortRequest>]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/data_catalog/models/search_criteria.rb, line 31 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'query': :'query', 'faceted_query': :'facetedQuery', 'dimensions': :'dimensions', 'sort': :'sort', 'filters': :'filters' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :query The value to assign to the {#query} property @option attributes [String] :faceted_query The value to assign to the {#faceted_query} property @option attributes [Array<String>] :dimensions The value to assign to the {#dimensions} property @option attributes [Array<OCI::DataCatalog::Models::FacetedSearchSortRequest>] :sort The value to assign to the {#sort} property @option attributes [OCI::DataCatalog::Models::FacetedSearchFilterRequest] :filters The value to assign to the {#filters} property
# File lib/oci/data_catalog/models/search_criteria.rb, line 67 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 } self.query = attributes[:'query'] if attributes[:'query'] self.faceted_query = attributes[:'facetedQuery'] if attributes[:'facetedQuery'] raise 'You cannot provide both :facetedQuery and :faceted_query' if attributes.key?(:'facetedQuery') && attributes.key?(:'faceted_query') self.faceted_query = attributes[:'faceted_query'] if attributes[:'faceted_query'] self.dimensions = attributes[:'dimensions'] if attributes[:'dimensions'] self.sort = attributes[:'sort'] if attributes[:'sort'] self.filters = attributes[:'filters'] if attributes[:'filters'] end
Attribute type mapping.
# File lib/oci/data_catalog/models/search_criteria.rb, line 44 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'query': :'String', 'faceted_query': :'String', 'dimensions': :'Array<String>', 'sort': :'Array<OCI::DataCatalog::Models::FacetedSearchSortRequest>', 'filters': :'OCI::DataCatalog::Models::FacetedSearchFilterRequest' # rubocop:enable Style/SymbolLiteral } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# File lib/oci/data_catalog/models/search_criteria.rb, line 95 def ==(other) return true if equal?(other) self.class == other.class && query == other.query && faceted_query == other.faceted_query && dimensions == other.dimensions && sort == other.sort && filters == other.filters end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/oci/data_catalog/models/search_criteria.rb, line 129 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 # 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) public_method("#{key}=").call( attributes[self.class.attribute_map[key]] .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) } ) end elsif !attributes[self.class.attribute_map[key]].nil? public_method("#{key}=").call( OCI::Internal::Util.convert_to_type(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] other the other object to be compared
# File lib/oci/data_catalog/models/search_criteria.rb, line 109 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/data_catalog/models/search_criteria.rb, line 118 def hash [query, faceted_query, dimensions, sort, filters].hash end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/data_catalog/models/search_criteria.rb, line 162 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = public_method(attr).call next if value.nil? && !instance_variable_defined?("@#{attr}") hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/data_catalog/models/search_criteria.rb, line 156 def to_s to_hash.to_s end
Private Instance Methods
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/oci/data_catalog/models/search_criteria.rb, line 179 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