Class: OCI::Nosql::Models::Column

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

Overview

A column of a table.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Column

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :name (String) —

    The value to assign to the #name property

  • :type (String) —

    The value to assign to the #type property

  • :is_nullable (BOOLEAN) —

    The value to assign to the #is_nullable property

  • :default_value (String) —

    The value to assign to the #default_value property

  • :is_as_uuid (BOOLEAN) —

    The value to assign to the #is_as_uuid property

  • :is_generated (BOOLEAN) —

    The value to assign to the #is_generated property



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/oci/nosql/models/column.rb', line 76

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.name = attributes[:'name'] if attributes[:'name']

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

  self.is_nullable = attributes[:'isNullable'] unless attributes[:'isNullable'].nil?

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

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

  self.default_value = attributes[:'defaultValue'] if attributes[:'defaultValue']

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

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

  self.is_as_uuid = attributes[:'isAsUuid'] unless attributes[:'isAsUuid'].nil?

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

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

  self.is_generated = attributes[:'isGenerated'] unless attributes[:'isGenerated'].nil?

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

  self.is_generated = attributes[:'is_generated'] unless attributes[:'is_generated'].nil?
end

Instance Attribute Details

#default_value ⇒ String

The column default value.

Returns:

  • (String) 


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

def default_value
  @default_value
end

#is_as_uuid ⇒ BOOLEAN

True if the STRING column was declared AS UUID.

Returns:

  • (BOOLEAN) 


29
30
31
 
# File 'lib/oci/nosql/models/column.rb', line 29

def is_as_uuid
  @is_as_uuid
end

#is_generated ⇒ BOOLEAN

True if the STRING AS UUID column is also GENERATED BY DEFAULT.

Returns:

  • (BOOLEAN) 


34
35
36
 
# File 'lib/oci/nosql/models/column.rb', line 34

def is_generated
  @is_generated
end

#is_nullable ⇒ BOOLEAN

The column nullable flag.

Returns:

  • (BOOLEAN) 


21
22
23
 
# File 'lib/oci/nosql/models/column.rb', line 21

def is_nullable
  @is_nullable
end

#name ⇒ String

The column name.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/nosql/models/column.rb', line 13

def name
  @name
end

#type ⇒ String

The column type.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/nosql/models/column.rb', line 17

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/oci/nosql/models/column.rb', line 37

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'type': :'type',
    'is_nullable': :'isNullable',
    'default_value': :'defaultValue',
    'is_as_uuid': :'isAsUuid',
    'is_generated': :'isGenerated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/oci/nosql/models/column.rb', line 51

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'type': :'String',
    'is_nullable': :'BOOLEAN',
    'default_value': :'String',
    'is_as_uuid': :'BOOLEAN',
    'is_generated': :'BOOLEAN'
    # 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



118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/oci/nosql/models/column.rb', line 118

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    name == other.name &&
    type == other.type &&
    is_nullable == other.is_nullable &&
    default_value == other.default_value &&
    is_as_uuid == other.is_as_uuid &&
    is_generated == other.is_generated
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



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/oci/nosql/models/column.rb', line 153

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


133
134
135
 
# File 'lib/oci/nosql/models/column.rb', line 133

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



142
143
144
 
# File 'lib/oci/nosql/models/column.rb', line 142

def hash
  [name, type, is_nullable, default_value, is_as_uuid, is_generated].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



186
187
188
189
190
191
192
193
194
195
 
# File 'lib/oci/nosql/models/column.rb', line 186

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



180
181
182
 
# File 'lib/oci/nosql/models/column.rb', line 180

def to_s
  to_hash.to_s
end