Class: OCI::Nosql::Models::TableLimits

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

Overview

Throughput and storage limits configuration of a table.

Constant Summary collapse

CAPACITY_MODE_ENUM = 
[
  CAPACITY_MODE_PROVISIONED = 'PROVISIONED'.freeze,
  CAPACITY_MODE_ON_DEMAND = 'ON_DEMAND'.freeze,
  CAPACITY_MODE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TableLimits

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :max_read_units (Integer) —

    The value to assign to the #max_read_units property

  • :max_write_units (Integer) —

    The value to assign to the #max_write_units property

  • :max_storage_in_g_bs (Integer) —

    The value to assign to the #max_storage_in_g_bs property

  • :capacity_mode (String) —

    The value to assign to the #capacity_mode property



71
72
73
74
75
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
 
# File 'lib/oci/nosql/models/table_limits.rb', line 71

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

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

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

  self.max_write_units = attributes[:'maxWriteUnits'] if attributes[:'maxWriteUnits']

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

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

  self.max_storage_in_g_bs = attributes[:'maxStorageInGBs'] if attributes[:'maxStorageInGBs']

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

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

  self.capacity_mode = attributes[:'capacityMode'] if attributes[:'capacityMode']

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

  self.capacity_mode = attributes[:'capacity_mode'] if attributes[:'capacity_mode']
end

Instance Attribute Details

#capacity_mode ⇒ String

The capacity mode of the table. If capacityMode = ON_DEMAND, maxReadUnits and maxWriteUnits are not used, and both will have the value of zero.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/nosql/models/table_limits.rb', line 35

def capacity_mode
  @capacity_mode
end

#max_read_units ⇒ Integer

[Required] Maximum sustained read throughput limit for the table.

Returns:

  • (Integer) 


20
21
22
 
# File 'lib/oci/nosql/models/table_limits.rb', line 20

def max_read_units
  @max_read_units
end

#max_storage_in_g_bs ⇒ Integer

[Required] Maximum size of storage used by the table.

Returns:

  • (Integer) 


28
29
30
 
# File 'lib/oci/nosql/models/table_limits.rb', line 28

def max_storage_in_g_bs
  @max_storage_in_g_bs
end

#max_write_units ⇒ Integer

[Required] Maximum sustained write throughput limit for the table.

Returns:

  • (Integer) 


24
25
26
 
# File 'lib/oci/nosql/models/table_limits.rb', line 24

def max_write_units
  @max_write_units
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'max_read_units': :'maxReadUnits',
    'max_write_units': :'maxWriteUnits',
    'max_storage_in_g_bs': :'maxStorageInGBs',
    'capacity_mode': :'capacityMode'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



50
51
52
53
54
55
56
57
58
59
 
# File 'lib/oci/nosql/models/table_limits.rb', line 50

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'max_read_units': :'Integer',
    'max_write_units': :'Integer',
    'max_storage_in_g_bs': :'Integer',
    'capacity_mode': :'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



122
123
124
125
126
127
128
129
130
 
# File 'lib/oci/nosql/models/table_limits.rb', line 122

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

  self.class == other.class &&
    max_read_units == other.max_read_units &&
    max_write_units == other.max_write_units &&
    max_storage_in_g_bs == other.max_storage_in_g_bs &&
    capacity_mode == other.capacity_mode
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



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

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


135
136
137
 
# File 'lib/oci/nosql/models/table_limits.rb', line 135

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



144
145
146
 
# File 'lib/oci/nosql/models/table_limits.rb', line 144

def hash
  [max_read_units, max_write_units, max_storage_in_g_bs, capacity_mode].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



188
189
190
191
192
193
194
195
196
197
 
# File 'lib/oci/nosql/models/table_limits.rb', line 188

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



182
183
184
 
# File 'lib/oci/nosql/models/table_limits.rb', line 182

def to_s
  to_hash.to_s
end