Class: OCI::Optimizer::Models::HistorySummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/optimizer/models/history_summary.rb

Overview

The metadata associated with the recommendation history and its related resources.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_ATTACHING = 'ATTACHING'.freeze,
  LIFECYCLE_STATE_DETACHING = 'DETACHING'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
STATUS_ENUM = 
[
  STATUS_PENDING = 'PENDING'.freeze,
  STATUS_DISMISSED = 'DISMISSED'.freeze,
  STATUS_POSTPONED = 'POSTPONED'.freeze,
  STATUS_IMPLEMENTED = 'IMPLEMENTED'.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 = {}) ⇒ HistorySummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :name (String) —

    The value to assign to the #name property

  • :resource_type (String) —

    The value to assign to the #resource_type property

  • :category_id (String) —

    The value to assign to the #category_id property

  • :recommendation_id (String) —

    The value to assign to the #recommendation_id property

  • :recommendation_name (String) —

    The value to assign to the #recommendation_name property

  • :resource_id (String) —

    The value to assign to the #resource_id property

  • :resource_action_id (String) —

    The value to assign to the #resource_action_id property

  • :action (OCI::Optimizer::Models::Action) —

    The value to assign to the #action property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :compartment_name (String) —

    The value to assign to the #compartment_name property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :estimated_cost_saving (Float) —

    The value to assign to the #estimated_cost_saving property

  • :status (String) —

    The value to assign to the #status property

  • :metadata (Hash<String, String>) —

    The value to assign to the #metadata property

  • :extended_metadata (Hash<String, Object>) —

    The value to assign to the #extended_metadata property

  • :time_created (DateTime) —

    The value to assign to the #time_created property



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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/oci/optimizer/models/history_summary.rb', line 195

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

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

  self.resource_type = attributes[:'resourceType'] if attributes[:'resourceType']

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

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

  self.category_id = attributes[:'categoryId'] if attributes[:'categoryId']

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

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

  self.recommendation_id = attributes[:'recommendationId'] if attributes[:'recommendationId']

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

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

  self.recommendation_name = attributes[:'recommendationName'] if attributes[:'recommendationName']

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

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

  self.resource_id = attributes[:'resourceId'] if attributes[:'resourceId']

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

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

  self.resource_action_id = attributes[:'resourceActionId'] if attributes[:'resourceActionId']

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

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

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

  self.compartment_name = attributes[:'compartmentName'] if attributes[:'compartmentName']

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.estimated_cost_saving = attributes[:'estimatedCostSaving'] if attributes[:'estimatedCostSaving']

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

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

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

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

  self.extended_metadata = attributes[:'extendedMetadata'] if attributes[:'extendedMetadata']

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

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

  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']
end

Instance Attribute Details

#action ⇒ OCI::Optimizer::Models::Action

This attribute is required.

Returns:



68
69
70
 
# File 'lib/oci/optimizer/models/history_summary.rb', line 68

def action
  @action
end

#category_id ⇒ String

[Required] The unique OCID associated with the category.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/optimizer/models/history_summary.rb', line 48

def category_id
  @category_id
end

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


72
73
74
 
# File 'lib/oci/optimizer/models/history_summary.rb', line 72

def compartment_id
  @compartment_id
end

#compartment_name ⇒ String

[Required] The name assigned to the compartment.

Returns:

  • (String) 


76
77
78
 
# File 'lib/oci/optimizer/models/history_summary.rb', line 76

def compartment_name
  @compartment_name
end

#estimated_cost_saving ⇒ Float

[Required] The estimated cost savings, in dollars, for the resource action.

Returns:

  • (Float) 


84
85
86
 
# File 'lib/oci/optimizer/models/history_summary.rb', line 84

def estimated_cost_saving
  @estimated_cost_saving
end

#extended_metadata ⇒ Hash<String, Object>

Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the metadata object.

They are distinguished from metadata fields in that these can be nested JSON objects (whereas metadata fields are string/string maps only).

For example:

{\"CurrentShape\": {\"name\":\"VM.Standard2.16\"}, \"RecommendedShape\": {\"name\":\"VM.Standard2.8\"}}

Returns:

  • (Hash<String, Object>) 


116
117
118
 
# File 'lib/oci/optimizer/models/history_summary.rb', line 116

def extended_metadata
  @extended_metadata
end

#id ⇒ String

[Required] The unique OCID associated with the recommendation history.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/optimizer/models/history_summary.rb', line 36

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The recommendation history's current state.

Returns:

  • (String) 


80
81
82
 
# File 'lib/oci/optimizer/models/history_summary.rb', line 80

def lifecycle_state
  @lifecycle_state
end

#metadata ⇒ Hash<String, String>

Custom metadata key/value pairs for the resource action.

Metadata Example

  \"metadata\" : {
     \"cpuRecommendedShape\": \"VM.Standard1.1\",
     \"computeMemoryUtilization\": \"26.05734124418388\",
     \"currentShape\": \"VM.Standard1.2\",
     \"instanceRecommendedShape\": \"VM.Standard1.1\",
     \"computeCpuUtilization\": \"7.930035319720132\",
     \"memoryRecommendedShape\": \"None\"
  }

Returns:

  • (Hash<String, String>) 


104
105
106
 
# File 'lib/oci/optimizer/models/history_summary.rb', line 104

def metadata
  @metadata
end

#name ⇒ String

[Required] The name assigned to the resource.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/optimizer/models/history_summary.rb', line 40

def name
  @name
end

#recommendation_id ⇒ String

[Required] The unique OCID associated with the recommendation.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/optimizer/models/history_summary.rb', line 52

def recommendation_id
  @recommendation_id
end

#recommendation_name ⇒ String

[Required] The name assigned to the recommendation.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/optimizer/models/history_summary.rb', line 56

def recommendation_name
  @recommendation_name
end

#resource_action_id ⇒ String

[Required] The unique OCID associated with the resource action.

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/optimizer/models/history_summary.rb', line 64

def resource_action_id
  @resource_action_id
end

#resource_id ⇒ String

[Required] The unique OCID associated with the resource.

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/optimizer/models/history_summary.rb', line 60

def resource_id
  @resource_id
end

#resource_type ⇒ String

[Required] The kind of resource.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/optimizer/models/history_summary.rb', line 44

def resource_type
  @resource_type
end

#status ⇒ String

[Required] The current status of the resource action.

Returns:

  • (String) 


88
89
90
 
# File 'lib/oci/optimizer/models/history_summary.rb', line 88

def status
  @status
end

#time_created ⇒ DateTime

The date and time the recommendation history was created, in the format defined by RFC3339.

Returns:

  • (DateTime) 


120
121
122
 
# File 'lib/oci/optimizer/models/history_summary.rb', line 120

def time_created
  @time_created
end

Class Method Details

.attribute_map ⇒ Object

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



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/oci/optimizer/models/history_summary.rb', line 123

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'name': :'name',
    'resource_type': :'resourceType',
    'category_id': :'categoryId',
    'recommendation_id': :'recommendationId',
    'recommendation_name': :'recommendationName',
    'resource_id': :'resourceId',
    'resource_action_id': :'resourceActionId',
    'action': :'action',
    'compartment_id': :'compartmentId',
    'compartment_name': :'compartmentName',
    'lifecycle_state': :'lifecycleState',
    'estimated_cost_saving': :'estimatedCostSaving',
    'status': :'status',
    'metadata': :'metadata',
    'extended_metadata': :'extendedMetadata',
    'time_created': :'timeCreated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/oci/optimizer/models/history_summary.rb', line 148

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'name': :'String',
    'resource_type': :'String',
    'category_id': :'String',
    'recommendation_id': :'String',
    'recommendation_name': :'String',
    'resource_id': :'String',
    'resource_action_id': :'String',
    'action': :'OCI::Optimizer::Models::Action',
    'compartment_id': :'String',
    'compartment_name': :'String',
    'lifecycle_state': :'String',
    'estimated_cost_saving': :'Float',
    'status': :'String',
    'metadata': :'Hash<String, String>',
    'extended_metadata': :'Hash<String, Object>',
    'time_created': :'DateTime'
    # 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



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/oci/optimizer/models/history_summary.rb', line 317

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

  self.class == other.class &&
    id == other.id &&
    name == other.name &&
    resource_type == other.resource_type &&
    category_id == other.category_id &&
    recommendation_id == other.recommendation_id &&
    recommendation_name == other.recommendation_name &&
    resource_id == other.resource_id &&
    resource_action_id == other.resource_action_id &&
    action == other.action &&
    compartment_id == other.compartment_id &&
    compartment_name == other.compartment_name &&
    lifecycle_state == other.lifecycle_state &&
    estimated_cost_saving == other.estimated_cost_saving &&
    status == other.status &&
    metadata == other.metadata &&
    extended_metadata == other.extended_metadata &&
    time_created == other.time_created
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



363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/oci/optimizer/models/history_summary.rb', line 363

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


343
344
345
 
# File 'lib/oci/optimizer/models/history_summary.rb', line 343

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



352
353
354
 
# File 'lib/oci/optimizer/models/history_summary.rb', line 352

def hash
  [id, name, resource_type, category_id, recommendation_id, recommendation_name, resource_id, resource_action_id, action, compartment_id, compartment_name, lifecycle_state, estimated_cost_saving, status, metadata, extended_metadata, time_created].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



396
397
398
399
400
401
402
403
404
405
 
# File 'lib/oci/optimizer/models/history_summary.rb', line 396

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



390
391
392
 
# File 'lib/oci/optimizer/models/history_summary.rb', line 390

def to_s
  to_hash.to_s
end