class OCI::Nosql::Models::IndexKey

Specifies a single key in a secondary index.

Attributes

column_name[RW]

[Required] The name of a column to be included as an index key. @return [String]

json_field_type[RW]

If the specified column is of type JSON, jsonFieldType contains the type of the field indicated by jsonPath.

@return [String]

json_path[RW]

If the specified column is of type JSON, jsonPath contains a dotted path indicating the field within the JSON object that will be the index key.

@return [String]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/nosql/models/index_key.rb, line 28
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'column_name': :'columnName',
    'json_path': :'jsonPath',
    'json_field_type': :'jsonFieldType'
    # 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] :column_name The value to assign to the {#column_name} property @option attributes [String] :json_path The value to assign to the {#json_path} property @option attributes [String] :json_field_type The value to assign to the {#json_field_type} property

# File lib/oci/nosql/models/index_key.rb, line 58
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.column_name = attributes[:'columnName'] if attributes[:'columnName']

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

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

  self.json_path = attributes[:'jsonPath'] if attributes[:'jsonPath']

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

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

  self.json_field_type = attributes[:'jsonFieldType'] if attributes[:'jsonFieldType']

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

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

Attribute type mapping.

# File lib/oci/nosql/models/index_key.rb, line 39
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'column_name': :'String',
    'json_path': :'String',
    'json_field_type': :'String'
    # 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/nosql/models/index_key.rb, line 90
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    column_name == other.column_name &&
    json_path == other.json_path &&
    json_field_type == other.json_field_type
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/nosql/models/index_key.rb, line 122
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/nosql/models/index_key.rb, line 102
def eql?(other)
  self == other
end
hash() click to toggle source

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

# File lib/oci/nosql/models/index_key.rb, line 111
def hash
  [column_name, json_path, json_field_type].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/nosql/models/index_key.rb, line 155
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/nosql/models/index_key.rb, line 149
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/nosql/models/index_key.rb, line 172
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