class OCI::Nosql::Models::Schema

The table schema information as a JSON object.

Attributes

columns[RW]

[Required] The columns of a table. @return [Array<OCI::Nosql::Models::Column>]

primary_key[RW]

[Required] A list of column names that make up a key. @return [Array<String>]

shard_key[RW]

[Required] A list of column names that make up a key. @return [Array<String>]

ttl[RW]

[Required] The default Time-to-Live for the table, in days. @return [Integer]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/nosql/models/schema.rb, line 27
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'columns': :'columns',
    'primary_key': :'primaryKey',
    'shard_key': :'shardKey',
    'ttl': :'ttl'
    # 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 [Array<OCI::Nosql::Models::Column>] :columns The value to assign to the {#columns} property @option attributes [Array<String>] :primary_key The value to assign to the {#primary_key} property @option attributes [Array<String>] :shard_key The value to assign to the {#shard_key} property @option attributes [Integer] :ttl The value to assign to the {#ttl} property

# File lib/oci/nosql/models/schema.rb, line 60
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.columns = attributes[:'columns'] if attributes[:'columns']

  self.primary_key = attributes[:'primaryKey'] if attributes[:'primaryKey']

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

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

  self.shard_key = attributes[:'shardKey'] if attributes[:'shardKey']

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

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

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

Attribute type mapping.

# File lib/oci/nosql/models/schema.rb, line 39
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'columns': :'Array<OCI::Nosql::Models::Column>',
    'primary_key': :'Array<String>',
    'shard_key': :'Array<String>',
    'ttl': :'Integer'
    # 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/schema.rb, line 90
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    columns == other.columns &&
    primary_key == other.primary_key &&
    shard_key == other.shard_key &&
    ttl == other.ttl
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/schema.rb, line 123
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/schema.rb, line 103
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/schema.rb, line 112
def hash
  [columns, primary_key, shard_key, ttl].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/schema.rb, line 156
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/schema.rb, line 150
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/schema.rb, line 173
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