Class: OCI::Mysql::Models::HeatWaveClusterMemoryEstimate

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/mysql/models/heat_wave_cluster_memory_estimate.rb

Overview

HeatWave cluster memory estimate that can be used to determine a suitable HeatWave cluster size. For each MySQL user table the estimated memory footprint when the table is loaded to the HeatWave cluster memory is returned.

Constant Summary collapse

STATUS_ENUM =
[
  STATUS_ACCEPTED = 'ACCEPTED'.freeze,
  STATUS_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  STATUS_FAILED = 'FAILED'.freeze,
  STATUS_SUCCEEDED = 'SUCCEEDED'.freeze,
  STATUS_CANCELING = 'CANCELING'.freeze,
  STATUS_CANCELED = 'CANCELED'.freeze,
  STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ HeatWaveClusterMemoryEstimate

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
110
111
112
113
114
115
116
# File 'lib/oci/mysql/models/heat_wave_cluster_memory_estimate.rb', line 85

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

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

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

  self.table_schemas = attributes[:'tableSchemas'] if attributes[:'tableSchemas']

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

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

Instance Attribute Details

#db_system_idString

[Required] The OCID of the DB System the HeatWave cluster memory estimate is associated with.

Returns:

  • (String)


28
29
30
# File 'lib/oci/mysql/models/heat_wave_cluster_memory_estimate.rb', line 28

def db_system_id
  @db_system_id
end

#statusString

[Required] Current status of the Work Request generating the HeatWave cluster memory estimate.

Returns:

  • (String)


32
33
34
# File 'lib/oci/mysql/models/heat_wave_cluster_memory_estimate.rb', line 32

def status
  @status
end

#table_schemasArray<OCI::Mysql::Models::HeatWaveClusterSchemaMemoryEstimate>

[Required] Collection of schemas with estimated memory footprints for MySQL user tables of each schema when loaded to HeatWave cluster memory.



46
47
48
# File 'lib/oci/mysql/models/heat_wave_cluster_memory_estimate.rb', line 46

def table_schemas
  @table_schemas
end

#time_createdDateTime

[Required] The date and time that the Work Request to generate the HeatWave cluster memory estimate was issued, as described by RFC 3339.

Returns:

  • (DateTime)


36
37
38
# File 'lib/oci/mysql/models/heat_wave_cluster_memory_estimate.rb', line 36

def time_created
  @time_created
end

#time_updatedDateTime

[Required] The date and time that the HeatWave cluster memory estimate was generated, as described by RFC 3339.

Returns:

  • (DateTime)


40
41
42
# File 'lib/oci/mysql/models/heat_wave_cluster_memory_estimate.rb', line 40

def time_updated
  @time_updated
end

Class Method Details

.attribute_mapObject

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'db_system_id': :'dbSystemId',
    'status': :'status',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'table_schemas': :'tableSchemas'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



62
63
64
65
66
67
68
69
70
71
72
# File 'lib/oci/mysql/models/heat_wave_cluster_memory_estimate.rb', line 62

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'db_system_id': :'String',
    'status': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'table_schemas': :'Array<OCI::Mysql::Models::HeatWaveClusterSchemaMemoryEstimate>'
    # 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



138
139
140
141
142
143
144
145
146
147
# File 'lib/oci/mysql/models/heat_wave_cluster_memory_estimate.rb', line 138

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

  self.class == other.class &&
    db_system_id == other.db_system_id &&
    status == other.status &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    table_schemas == other.table_schemas
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



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
# File 'lib/oci/mysql/models/heat_wave_cluster_memory_estimate.rb', line 172

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


152
153
154
# File 'lib/oci/mysql/models/heat_wave_cluster_memory_estimate.rb', line 152

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



161
162
163
# File 'lib/oci/mysql/models/heat_wave_cluster_memory_estimate.rb', line 161

def hash
  [db_system_id, status, time_created, time_updated, table_schemas].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



205
206
207
208
209
210
211
212
213
214
# File 'lib/oci/mysql/models/heat_wave_cluster_memory_estimate.rb', line 205

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



199
200
201
# File 'lib/oci/mysql/models/heat_wave_cluster_memory_estimate.rb', line 199

def to_s
  to_hash.to_s
end