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](docs.cloud.oracle.com/Content/Database/References/launchoptions.htm). 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](docs.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).

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):

  • :name (String)

    The value to assign to the #name property

  • :shape_family (String)

    The value to assign to the #shape_family property

  • :shape (String)

    The value to assign to the #shape property

  • :available_core_count (Integer)

    The value to assign to the #available_core_count property

  • :minimum_core_count (Integer)

    The value to assign to the #minimum_core_count property

  • :core_count_increment (Integer)

    The value to assign to the #core_count_increment property

  • :minimum_node_count (Integer)

    The value to assign to the #minimum_node_count property

  • :maximum_node_count (Integer)

    The value to assign to the #maximum_node_count property



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
# File 'lib/oci/database/models/db_system_shape_summary.rb', line 92

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.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)


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

def available_core_count
  @available_core_count
end

#core_count_incrementInteger

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

Returns:

  • (Integer)


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

def core_count_increment
  @core_count_increment
end

#maximum_node_countInteger

The maximum number of database nodes available for this shape.

Returns:

  • (Integer)


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

def maximum_node_count
  @maximum_node_count
end

#minimum_core_countInteger

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

Returns:

  • (Integer)


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

def minimum_core_count
  @minimum_core_count
end

#minimum_node_countInteger

The minimum number of database nodes available for this shape.

Returns:

  • (Integer)


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

def minimum_node_count
  @minimum_node_count
end

#nameString

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

Returns:

  • (String)


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

def name
  @name
end

#shapeString

Deprecated. Use ‘name` instead of `shape`.

Returns:

  • (String)


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

def shape
  @shape
end

#shape_familyString

The family of the shape used for the DB system.

Returns:

  • (String)


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

def shape_family
  @shape_family
end

Class Method Details

.attribute_mapObject

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



47
48
49
50
51
52
53
54
55
56
57
58
59
60
# File 'lib/oci/database/models/db_system_shape_summary.rb', line 47

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',
    'minimum_node_count': :'minimumNodeCount',
    'maximum_node_count': :'maximumNodeCount'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
74
75
76
# File 'lib/oci/database/models/db_system_shape_summary.rb', line 63

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',
    '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



146
147
148
149
150
151
152
153
154
155
156
157
158
# File 'lib/oci/database/models/db_system_shape_summary.rb', line 146

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 &&
    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



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
# File 'lib/oci/database/models/db_system_shape_summary.rb', line 183

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


163
164
165
# File 'lib/oci/database/models/db_system_shape_summary.rb', line 163

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



172
173
174
# File 'lib/oci/database/models/db_system_shape_summary.rb', line 172

def hash
  [name, shape_family, shape, available_core_count, minimum_core_count, core_count_increment, 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



216
217
218
219
220
221
222
223
224
225
# File 'lib/oci/database/models/db_system_shape_summary.rb', line 216

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



210
211
212
# File 'lib/oci/database/models/db_system_shape_summary.rb', line 210

def to_s
  to_hash.to_s
end