class OCI::DataCatalog::Models::FacetedSearchAggregation
Aggregation/facets on properties of data object.
Constants
- PROPERTY_TYPE_ENUM
Attributes
Count of number of data objects having property. @return [Hash<String, Integer>]
Data type of object property. @return [String]
Type of property that indicates if it was defined by the user or system. CUSTOM_PROPERTY is defined by the user on a data object. DEFAULT_PROPERTY is defined by the system on a data object.
@return [String]
Name of data object property @return [String]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/data_catalog/models/faceted_search_aggregation.rb, line 37 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'type': :'type', 'aggregation': :'aggregation', 'data_type': :'dataType', 'property_type': :'propertyType' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :type The value to assign to the {#type} property @option attributes [Hash<String, Integer>] :aggregation The value to assign to the {#aggregation} property @option attributes [String] :data_type The value to assign to the {#data_type} property @option attributes [String] :property_type The value to assign to the {#property_type} property
# File lib/oci/data_catalog/models/faceted_search_aggregation.rb, line 70 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.type = attributes[:'type'] if attributes[:'type'] self.aggregation = attributes[:'aggregation'] if attributes[:'aggregation'] self.data_type = attributes[:'dataType'] if attributes[:'dataType'] raise 'You cannot provide both :dataType and :data_type' if attributes.key?(:'dataType') && attributes.key?(:'data_type') self.data_type = attributes[:'data_type'] if attributes[:'data_type'] self.property_type = attributes[:'propertyType'] if attributes[:'propertyType'] raise 'You cannot provide both :propertyType and :property_type' if attributes.key?(:'propertyType') && attributes.key?(:'property_type') self.property_type = attributes[:'property_type'] if attributes[:'property_type'] end
Attribute type mapping.
# File lib/oci/data_catalog/models/faceted_search_aggregation.rb, line 49 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'type': :'String', 'aggregation': :'Hash<String, Integer>', 'data_type': :'String', 'property_type': :'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_aggregation.rb, line 113 def ==(other) return true if equal?(other) self.class == other.class && type == other.type && aggregation == other.aggregation && data_type == other.data_type && property_type == other.property_type 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_aggregation.rb, line 146 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_aggregation.rb, line 126 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_aggregation.rb, line 135 def hash [type, aggregation, data_type, property_type].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] property_type
Object
to be assigned
# File lib/oci/data_catalog/models/faceted_search_aggregation.rb, line 97 def property_type=(property_type) # rubocop:disable Style/ConditionalAssignment if property_type && !PROPERTY_TYPE_ENUM.include?(property_type) OCI.logger.debug("Unknown value for 'property_type' [" + property_type + "]. Mapping to 'PROPERTY_TYPE_UNKNOWN_ENUM_VALUE'") if OCI.logger @property_type = PROPERTY_TYPE_UNKNOWN_ENUM_VALUE else @property_type = property_type end # rubocop:enable Style/ConditionalAssignment 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_aggregation.rb, line 179 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_aggregation.rb, line 173 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_aggregation.rb, line 196 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