class OCI::Optimizer::Models::Category

The metadata associated with the category.

Constants

LIFECYCLE_STATE_ENUM

Attributes

compartment_id[RW]

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

description[RW]

[Required] Text describing the category. Avoid entering confidential information. @return [String]

estimated_cost_saving[RW]

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

id[RW]

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

lifecycle_state[R]

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

name[RW]

[Required] The name assigned to the category. Avoid entering confidential information. @return [String]

recommendation_counts[RW]

[Required] An array of `RecommendationCount` objects grouped by the level of importance assigned to the recommendation. @return [Array<OCI::Optimizer::Models::RecommendationCount>]

resource_counts[RW]

[Required] An array of `ResourceCount` objects grouped by the status of the recommendation. @return [Array<OCI::Optimizer::Models::ResourceCount>]

time_created[RW]

[Required] The date and time the category details were created, in the format defined by RFC3339. @return [DateTime]

time_updated[RW]

[Required] The date and time the category details were last updated, 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/category.rb, line 66
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'name': :'name',
    'description': :'description',
    'recommendation_counts': :'recommendationCounts',
    'resource_counts': :'resourceCounts',
    'lifecycle_state': :'lifecycleState',
    'estimated_cost_saving': :'estimatedCostSaving',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated'
    # 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] :compartment_id The value to assign to the {#compartment_id} property @option attributes [String] :name The value to assign to the {#name} property @option attributes [String] :description The value to assign to the {#description} property @option attributes [Array<OCI::Optimizer::Models::RecommendationCount>] :recommendation_counts The value to assign to the {#recommendation_counts} property @option attributes [Array<OCI::Optimizer::Models::ResourceCount>] :resource_counts The value to assign to the {#resource_counts} 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 [DateTime] :time_created The value to assign to the {#time_created} property @option attributes [DateTime] :time_updated The value to assign to the {#time_updated} property

# File lib/oci/optimizer/models/category.rb, line 117
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.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.name = attributes[:'name'] if attributes[:'name']

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

  self.recommendation_counts = attributes[:'recommendationCounts'] if attributes[:'recommendationCounts']

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

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

  self.resource_counts = attributes[:'resourceCounts'] if attributes[:'resourceCounts']

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

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

  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.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']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/optimizer/models/category.rb, line 84
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'name': :'String',
    'description': :'String',
    'recommendation_counts': :'Array<OCI::Optimizer::Models::RecommendationCount>',
    'resource_counts': :'Array<OCI::Optimizer::Models::ResourceCount>',
    'lifecycle_state': :'String',
    'estimated_cost_saving': :'Float',
    'time_created': :'DateTime',
    'time_updated': :'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/category.rb, line 192
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    name == other.name &&
    description == other.description &&
    recommendation_counts == other.recommendation_counts &&
    resource_counts == other.resource_counts &&
    lifecycle_state == other.lifecycle_state &&
    estimated_cost_saving == other.estimated_cost_saving &&
    time_created == other.time_created &&
    time_updated == other.time_updated
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/category.rb, line 231
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/category.rb, line 211
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/category.rb, line 220
def hash
  [id, compartment_id, name, description, recommendation_counts, resource_counts, lifecycle_state, estimated_cost_saving, time_created, time_updated].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/category.rb, line 176
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
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/category.rb, line 264
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/category.rb, line 258
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/category.rb, line 281
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