class OCI::ResourceSearch::Models::QueryableFieldDescription

An individual field that can be used as part of a query filter.

Constants

FIELD_TYPE_ENUM

Attributes

field_name[RW]

[Required] The name of the field to use when constructing the query. Field names are present for all types except `OBJECT`.

@return [String]

field_type[R]

[Required] The type of the field, which dictates what semantics and query constraints you can use when searching or querying.

@return [String]

is_array[RW]

Indicates that this field is actually an array of the specified field type.

@return [BOOLEAN]

object_properties[RW]

If the field type is `OBJECT`, then this property will provide all the individual properties of the object that can be queried.

@return [Array<OCI::ResourceSearch::Models::QueryableFieldDescription>]

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/oci/resource_search/models/queryable_field_description.rb, line 45
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'field_type': :'fieldType',
    'field_name': :'fieldName',
    'is_array': :'isArray',
    'object_properties': :'objectProperties'
    # rubocop:enable Style/SymbolLiteral
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :field_type The value to assign to the {#field_type} property @option attributes [String] :field_name The value to assign to the {#field_name} property @option attributes [BOOLEAN] :is_array The value to assign to the {#is_array} property @option attributes [Array<OCI::ResourceSearch::Models::QueryableFieldDescription>] :object_properties The value to assign to the {#object_properties} property

# File lib/oci/resource_search/models/queryable_field_description.rb, line 78
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.field_type = attributes[:'fieldType'] if attributes[:'fieldType']

  raise 'You cannot provide both :fieldType and :field_type' if attributes.key?(:'fieldType') && attributes.key?(:'field_type')

  self.field_type = attributes[:'field_type'] if attributes[:'field_type']

  self.field_name = attributes[:'fieldName'] if attributes[:'fieldName']

  raise 'You cannot provide both :fieldName and :field_name' if attributes.key?(:'fieldName') && attributes.key?(:'field_name')

  self.field_name = attributes[:'field_name'] if attributes[:'field_name']

  self.is_array = attributes[:'isArray'] unless attributes[:'isArray'].nil?

  raise 'You cannot provide both :isArray and :is_array' if attributes.key?(:'isArray') && attributes.key?(:'is_array')

  self.is_array = attributes[:'is_array'] unless attributes[:'is_array'].nil?

  self.object_properties = attributes[:'objectProperties'] if attributes[:'objectProperties']

  raise 'You cannot provide both :objectProperties and :object_properties' if attributes.key?(:'objectProperties') && attributes.key?(:'object_properties')

  self.object_properties = attributes[:'object_properties'] if attributes[:'object_properties']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/resource_search/models/queryable_field_description.rb, line 57
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'field_type': :'String',
    'field_name': :'String',
    'is_array': :'BOOLEAN',
    'object_properties': :'Array<OCI::ResourceSearch::Models::QueryableFieldDescription>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/resource_search/models/queryable_field_description.rb, line 129
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    field_type == other.field_type &&
    field_name == other.field_name &&
    is_array == other.is_array &&
    object_properties == other.object_properties
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/resource_search/models/queryable_field_description.rb, line 162
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
eql?(other) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/resource_search/models/queryable_field_description.rb, line 142
def eql?(other)
  self == other
end
field_type=(field_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] field_type Object to be assigned

# File lib/oci/resource_search/models/queryable_field_description.rb, line 113
def field_type=(field_type)
  # rubocop:disable Style/ConditionalAssignment
  if field_type && !FIELD_TYPE_ENUM.include?(field_type)
    OCI.logger.debug("Unknown value for 'field_type' [" + field_type + "]. Mapping to 'FIELD_TYPE_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @field_type = FIELD_TYPE_UNKNOWN_ENUM_VALUE
  else
    @field_type = field_type
  end
  # rubocop:enable Style/ConditionalAssignment
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/resource_search/models/queryable_field_description.rb, line 151
def hash
  [field_type, field_name, is_array, object_properties].hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/resource_search/models/queryable_field_description.rb, line 195
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
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/resource_search/models/queryable_field_description.rb, line 189
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

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/resource_search/models/queryable_field_description.rb, line 212
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