class OCI::Optimizer::Models::HistorySummary

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

Constants

LIFECYCLE_STATE_ENUM
STATUS_ENUM

Attributes

action[RW]

This attribute is required. @return [OCI::Optimizer::Models::Action]

category_id[RW]

[Required] The unique OCID associated with the category. @return [String]

compartment_id[RW]

[Required] The OCID of the compartment. @return [String]

compartment_name[RW]

[Required] The name assigned to the compartment. @return [String]

estimated_cost_saving[RW]

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

extended_metadata[RW]

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"}}`

@return [Hash<String, Object>]

id[RW]

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

lifecycle_state[R]

[Required] The recommendation history's current state. @return [String]

metadata[RW]

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\"
     }

@return [Hash<String, String>]

name[RW]

[Required] The name assigned to the resource. @return [String]

recommendation_id[RW]

[Required] The unique OCID associated with the recommendation. @return [String]

recommendation_name[RW]

[Required] The name assigned to the recommendation. @return [String]

resource_action_id[RW]

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

resource_id[RW]

[Required] The unique OCID associated with the resource. @return [String]

resource_type[RW]

[Required] The kind of resource. @return [String]

status[R]

[Required] The current status of the resource action. @return [String]

time_created[RW]

The date and time the recommendation history was created, in the format defined by RFC3339. @return [DateTime]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/optimizer/models/history_summary.rb, line 122
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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :id The value to assign to the {#id} property @option attributes [String] :name The value to assign to the {#name} property @option attributes [String] :resource_type The value to assign to the {#resource_type} property @option attributes [String] :category_id The value to assign to the {#category_id} property @option attributes [String] :recommendation_id The value to assign to the {#recommendation_id} property @option attributes [String] :recommendation_name The value to assign to the {#recommendation_name} property @option attributes [String] :resource_id The value to assign to the {#resource_id} property @option attributes [String] :resource_action_id The value to assign to the {#resource_action_id} property @option attributes [OCI::Optimizer::Models::Action] :action The value to assign to the {#action} property @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property @option attributes [String] :compartment_name The value to assign to the {#compartment_name} property @option attributes [String] :lifecycle_state The value to assign to the {#lifecycle_state} property @option attributes [Float] :estimated_cost_saving The value to assign to the {#estimated_cost_saving} property @option attributes [String] :status The value to assign to the {#status} property @option attributes [Hash<String, String>] :metadata The value to assign to the {#metadata} property @option attributes [Hash<String, Object>] :extended_metadata The value to assign to the {#extended_metadata} property @option attributes [DateTime] :time_created The value to assign to the {#time_created} property

# File lib/oci/optimizer/models/history_summary.rb, line 194
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
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/optimizer/models/history_summary.rb, line 147
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

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/optimizer/models/history_summary.rb, line 316
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/optimizer/models/history_summary.rb, line 362
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) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/optimizer/models/history_summary.rb, line 342
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/optimizer/models/history_summary.rb, line 351
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
lifecycle_state=(lifecycle_state) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] lifecycle_state Object to be assigned

# File lib/oci/optimizer/models/history_summary.rb, line 287
def lifecycle_state=(lifecycle_state)
  # rubocop:disable Style/ConditionalAssignment
  if lifecycle_state && !LIFECYCLE_STATE_ENUM.include?(lifecycle_state)
    OCI.logger.debug("Unknown value for 'lifecycle_state' [" + lifecycle_state + "]. Mapping to 'LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @lifecycle_state = LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE
  else
    @lifecycle_state = lifecycle_state
  end
  # rubocop:enable Style/ConditionalAssignment
end
status=(status) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned

# File lib/oci/optimizer/models/history_summary.rb, line 300
def status=(status)
  # rubocop:disable Style/ConditionalAssignment
  if status && !STATUS_ENUM.include?(status)
    OCI.logger.debug("Unknown value for 'status' [" + status + "]. Mapping to 'STATUS_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @status = STATUS_UNKNOWN_ENUM_VALUE
  else
    @status = status
  end
  # rubocop:enable Style/ConditionalAssignment
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/optimizer/models/history_summary.rb, line 395
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/optimizer/models/history_summary.rb, line 389
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/oci/optimizer/models/history_summary.rb, line 412
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end