class OCI::DataCatalog::Models::FacetedSearchSortRequest
Object
with sort criteria details
Constants
- SORT_ORDER_ENUM
Attributes
Filed name that needs to be sorted by. @return [String]
Sort order for search results. @return [String]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/data_catalog/models/faceted_search_sort_request.rb, line 24 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'sort_by': :'sortBy', 'sort_order': :'sortOrder' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :sort_by The value to assign to the {#sort_by} property @option attributes [String] :sort_order The value to assign to the {#sort_order} property
# File lib/oci/data_catalog/models/faceted_search_sort_request.rb, line 51 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.sort_by = attributes[:'sortBy'] if attributes[:'sortBy'] raise 'You cannot provide both :sortBy and :sort_by' if attributes.key?(:'sortBy') && attributes.key?(:'sort_by') self.sort_by = attributes[:'sort_by'] if attributes[:'sort_by'] self.sort_order = attributes[:'sortOrder'] if attributes[:'sortOrder'] raise 'You cannot provide both :sortOrder and :sort_order' if attributes.key?(:'sortOrder') && attributes.key?(:'sort_order') self.sort_order = attributes[:'sort_order'] if attributes[:'sort_order'] end
Attribute type mapping.
# File lib/oci/data_catalog/models/faceted_search_sort_request.rb, line 34 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'sort_by': :'String', 'sort_order': :'String' # 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/faceted_search_sort_request.rb, line 85 def ==(other) return true if equal?(other) self.class == other.class && sort_by == other.sort_by && sort_order == other.sort_order 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/faceted_search_sort_request.rb, line 116 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/faceted_search_sort_request.rb, line 96 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/data_catalog/models/faceted_search_sort_request.rb, line 105 def hash [sort_by, sort_order].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] sort_order
Object
to be assigned
# File lib/oci/data_catalog/models/faceted_search_sort_request.rb, line 74 def sort_order=(sort_order) raise "Invalid value for 'sort_order': this must be one of the values in SORT_ORDER_ENUM." if sort_order && !SORT_ORDER_ENUM.include?(sort_order) @sort_order = sort_order 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/faceted_search_sort_request.rb, line 149 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/faceted_search_sort_request.rb, line 143 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/faceted_search_sort_request.rb, line 166 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