Class: OCI::Nosql::Models::IndexKey

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/nosql/models/index_key.rb

Overview

Specifies a single key in a secondary index.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IndexKey

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash

Options Hash (attributes):

  • :column_name (String)

    The value to assign to the #column_name property

  • :json_path (String)

    The value to assign to the #json_path property

  • :json_field_type (String)

    The value to assign to the #json_field_type property



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
# 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

Instance Attribute Details

#column_nameString

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

Returns:

  • (String)


12
13
14
# File 'lib/oci/nosql/models/index_key.rb', line 12

def column_name
  @column_name
end

#json_field_typeString

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

Returns:

  • (String)


25
26
27
# File 'lib/oci/nosql/models/index_key.rb', line 25

def json_field_type
  @json_field_type
end

#json_pathString

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.

Returns:

  • (String)


19
20
21
# File 'lib/oci/nosql/models/index_key.rb', line 19

def json_path
  @json_path
end

Class Method Details

.attribute_mapObject

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



28
29
30
31
32
33
34
35
36
# 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

.swagger_typesObject

Attribute type mapping.



39
40
41
42
43
44
45
46
47
# 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

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object)

    the other object to be compared



90
91
92
93
94
95
96
97
# 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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
# 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) ⇒ Boolean

Parameters:

  • other (Object)

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


102
103
104
# File 'lib/oci/nosql/models/index_key.rb', line 102

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



111
112
113
# File 'lib/oci/nosql/models/index_key.rb', line 111

def hash
  [column_name, json_path, json_field_type].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



155
156
157
158
159
160
161
162
163
164
# 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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



149
150
151
# File 'lib/oci/nosql/models/index_key.rb', line 149

def to_s
  to_hash.to_s
end