Class: OCI::Database::Models::DbSystemShapeSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database/models/db_system_shape_summary.rb

Overview

The shape of the DB system. The shape determines resources to allocate to the DB system - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes. For a description of shapes, see DB System Launch Options. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DbSystemShapeSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
# File 'lib/oci/database/models/db_system_shape_summary.rb', line 142

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

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

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

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

  self.available_core_count = attributes[:'availableCoreCount'] if attributes[:'availableCoreCount']

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

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

  self.minimum_core_count = attributes[:'minimumCoreCount'] if attributes[:'minimumCoreCount']

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

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

  self.core_count_increment = attributes[:'coreCountIncrement'] if attributes[:'coreCountIncrement']

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

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

  self.min_core_count_per_node = attributes[:'minCoreCountPerNode'] if attributes[:'minCoreCountPerNode']

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

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

  self.available_memory_in_gbs = attributes[:'availableMemoryInGBs'] if attributes[:'availableMemoryInGBs']

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

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

  self.min_memory_per_node_in_g_bs = attributes[:'minMemoryPerNodeInGBs'] if attributes[:'minMemoryPerNodeInGBs']

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

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

  self.available_db_node_storage_in_g_bs = attributes[:'availableDbNodeStorageInGBs'] if attributes[:'availableDbNodeStorageInGBs']

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

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

  self.min_db_node_storage_per_node_in_g_bs = attributes[:'minDbNodeStoragePerNodeInGBs'] if attributes[:'minDbNodeStoragePerNodeInGBs']

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

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

  self.available_data_storage_in_t_bs = attributes[:'availableDataStorageInTBs'] if attributes[:'availableDataStorageInTBs']

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

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

  self.min_data_storage_in_t_bs = attributes[:'minDataStorageInTBs'] if attributes[:'minDataStorageInTBs']

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

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

  self.minimum_node_count = attributes[:'minimumNodeCount'] if attributes[:'minimumNodeCount']

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

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

  self.maximum_node_count = attributes[:'maximumNodeCount'] if attributes[:'maximumNodeCount']

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

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

Instance Attribute Details

#available_core_countInteger

[Required] The maximum number of CPU cores that can be enabled on the DB system for this shape.

Returns:

  • (Integer)


29
30
31
# File 'lib/oci/database/models/db_system_shape_summary.rb', line 29

def available_core_count
  @available_core_count
end

#available_data_storage_in_t_bsInteger

The maximum DATA storage that can be enabled for this shape.

Returns:

  • (Integer)


61
62
63
# File 'lib/oci/database/models/db_system_shape_summary.rb', line 61

def available_data_storage_in_t_bs
  @available_data_storage_in_t_bs
end

#available_db_node_storage_in_g_bsInteger

The maximum Db Node storage that can be enabled for this shape.

Returns:

  • (Integer)


53
54
55
# File 'lib/oci/database/models/db_system_shape_summary.rb', line 53

def available_db_node_storage_in_g_bs
  @available_db_node_storage_in_g_bs
end

#available_memory_in_gbsInteger

The maximum memory that can be enabled for this shape.

Returns:

  • (Integer)


45
46
47
# File 'lib/oci/database/models/db_system_shape_summary.rb', line 45

def available_memory_in_gbs
  @available_memory_in_gbs
end

#core_count_incrementInteger

The discrete number by which the CPU core count for this shape can be increased or decreased.

Returns:

  • (Integer)


37
38
39
# File 'lib/oci/database/models/db_system_shape_summary.rb', line 37

def core_count_increment
  @core_count_increment
end

#maximum_node_countInteger

The maximum number of database nodes available for this shape.

Returns:

  • (Integer)


73
74
75
# File 'lib/oci/database/models/db_system_shape_summary.rb', line 73

def maximum_node_count
  @maximum_node_count
end

#min_core_count_per_nodeInteger

The minimum number of CPU cores that can be enabled per node for this shape.

Returns:

  • (Integer)


41
42
43
# File 'lib/oci/database/models/db_system_shape_summary.rb', line 41

def min_core_count_per_node
  @min_core_count_per_node
end

#min_data_storage_in_t_bsInteger

The minimum data storage that need be allocated for this shape.

Returns:

  • (Integer)


65
66
67
# File 'lib/oci/database/models/db_system_shape_summary.rb', line 65

def min_data_storage_in_t_bs
  @min_data_storage_in_t_bs
end

#min_db_node_storage_per_node_in_g_bsInteger

The minimum Db Node storage that need be allocated per node for this shape.

Returns:

  • (Integer)


57
58
59
# File 'lib/oci/database/models/db_system_shape_summary.rb', line 57

def min_db_node_storage_per_node_in_g_bs
  @min_db_node_storage_per_node_in_g_bs
end

#min_memory_per_node_in_g_bsInteger

The minimum memory that need be allocated per node for this shape.

Returns:

  • (Integer)


49
50
51
# File 'lib/oci/database/models/db_system_shape_summary.rb', line 49

def min_memory_per_node_in_g_bs
  @min_memory_per_node_in_g_bs
end

#minimum_core_countInteger

The minimum number of CPU cores that can be enabled on the DB system for this shape.

Returns:

  • (Integer)


33
34
35
# File 'lib/oci/database/models/db_system_shape_summary.rb', line 33

def minimum_core_count
  @minimum_core_count
end

#minimum_node_countInteger

The minimum number of database nodes available for this shape.

Returns:

  • (Integer)


69
70
71
# File 'lib/oci/database/models/db_system_shape_summary.rb', line 69

def minimum_node_count
  @minimum_node_count
end

#nameString

[Required] The name of the shape used for the DB system.

Returns:

  • (String)


17
18
19
# File 'lib/oci/database/models/db_system_shape_summary.rb', line 17

def name
  @name
end

#shapeString

Deprecated. Use name instead of shape.

Returns:

  • (String)


25
26
27
# File 'lib/oci/database/models/db_system_shape_summary.rb', line 25

def shape
  @shape
end

#shape_familyString

The family of the shape used for the DB system.

Returns:

  • (String)


21
22
23
# File 'lib/oci/database/models/db_system_shape_summary.rb', line 21

def shape_family
  @shape_family
end

Class Method Details

.attribute_mapObject

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



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
# File 'lib/oci/database/models/db_system_shape_summary.rb', line 76

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'shape_family': :'shapeFamily',
    'shape': :'shape',
    'available_core_count': :'availableCoreCount',
    'minimum_core_count': :'minimumCoreCount',
    'core_count_increment': :'coreCountIncrement',
    'min_core_count_per_node': :'minCoreCountPerNode',
    'available_memory_in_gbs': :'availableMemoryInGBs',
    'min_memory_per_node_in_g_bs': :'minMemoryPerNodeInGBs',
    'available_db_node_storage_in_g_bs': :'availableDbNodeStorageInGBs',
    'min_db_node_storage_per_node_in_g_bs': :'minDbNodeStoragePerNodeInGBs',
    'available_data_storage_in_t_bs': :'availableDataStorageInTBs',
    'min_data_storage_in_t_bs': :'minDataStorageInTBs',
    'minimum_node_count': :'minimumNodeCount',
    'maximum_node_count': :'maximumNodeCount'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
# File 'lib/oci/database/models/db_system_shape_summary.rb', line 99

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'shape_family': :'String',
    'shape': :'String',
    'available_core_count': :'Integer',
    'minimum_core_count': :'Integer',
    'core_count_increment': :'Integer',
    'min_core_count_per_node': :'Integer',
    'available_memory_in_gbs': :'Integer',
    'min_memory_per_node_in_g_bs': :'Integer',
    'available_db_node_storage_in_g_bs': :'Integer',
    'min_db_node_storage_per_node_in_g_bs': :'Integer',
    'available_data_storage_in_t_bs': :'Integer',
    'min_data_storage_in_t_bs': :'Integer',
    'minimum_node_count': :'Integer',
    'maximum_node_count': :'Integer'
    # 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



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
# File 'lib/oci/database/models/db_system_shape_summary.rb', line 238

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

  self.class == other.class &&
    name == other.name &&
    shape_family == other.shape_family &&
    shape == other.shape &&
    available_core_count == other.available_core_count &&
    minimum_core_count == other.minimum_core_count &&
    core_count_increment == other.core_count_increment &&
    min_core_count_per_node == other.min_core_count_per_node &&
    available_memory_in_gbs == other.available_memory_in_gbs &&
    min_memory_per_node_in_g_bs == other.min_memory_per_node_in_g_bs &&
    available_db_node_storage_in_g_bs == other.available_db_node_storage_in_g_bs &&
    min_db_node_storage_per_node_in_g_bs == other.min_db_node_storage_per_node_in_g_bs &&
    available_data_storage_in_t_bs == other.available_data_storage_in_t_bs &&
    min_data_storage_in_t_bs == other.min_data_storage_in_t_bs &&
    minimum_node_count == other.minimum_node_count &&
    maximum_node_count == other.maximum_node_count
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



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
# File 'lib/oci/database/models/db_system_shape_summary.rb', line 282

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


262
263
264
# File 'lib/oci/database/models/db_system_shape_summary.rb', line 262

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



271
272
273
# File 'lib/oci/database/models/db_system_shape_summary.rb', line 271

def hash
  [name, shape_family, shape, available_core_count, minimum_core_count, core_count_increment, min_core_count_per_node, available_memory_in_gbs, min_memory_per_node_in_g_bs, available_db_node_storage_in_g_bs, min_db_node_storage_per_node_in_g_bs, available_data_storage_in_t_bs, min_data_storage_in_t_bs, minimum_node_count, maximum_node_count].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



315
316
317
318
319
320
321
322
323
324
# File 'lib/oci/database/models/db_system_shape_summary.rb', line 315

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



309
310
311
# File 'lib/oci/database/models/db_system_shape_summary.rb', line 309

def to_s
  to_hash.to_s
end