Class: OCI::Optimizer::Models::Category
- Inherits:
-
Object
- Object
- OCI::Optimizer::Models::Category
- Defined in:
- lib/oci/optimizer/models/category.rb
Overview
The metadata associated with the category.
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
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
[Required] The OCID of the tenancy.
-
#compartment_name ⇒ String
[Required] The name associated with the compartment.
-
#description ⇒ String
[Required] Text describing the category.
-
#estimated_cost_saving ⇒ Float
[Required] The estimated cost savings, in dollars, for the category.
-
#extended_metadata ⇒ Hash<String, String>
Additional metadata key/value pairs for the category.
-
#id ⇒ String
[Required] The unique OCID of the category.
-
#lifecycle_state ⇒ String
[Required] The category's current state.
-
#name ⇒ String
[Required] The name assigned to the category.
-
#recommendation_counts ⇒ Array<OCI::Optimizer::Models::RecommendationCount>
[Required] An array of
RecommendationCount
objects grouped by the level of importance assigned to the recommendation. -
#resource_counts ⇒ Array<OCI::Optimizer::Models::ResourceCount>
[Required] An array of
ResourceCount
objects grouped by the status of the recommendation. -
#time_created ⇒ DateTime
[Required] The date and time the category details were created, in the format defined by RFC3339.
-
#time_updated ⇒ DateTime
[Required] The date and time the category details were last updated, in the format defined by RFC3339.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Category
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ Category
Initializes the object
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 |
# File 'lib/oci/optimizer/models/category.rb', line 137 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.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.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'] self. = attributes[:'extendedMetadata'] if attributes[:'extendedMetadata'] raise 'You cannot provide both :extendedMetadata and :extended_metadata' if attributes.key?(:'extendedMetadata') && attributes.key?(:'extended_metadata') self. = attributes[:'extended_metadata'] if attributes[:'extended_metadata'] end |
Instance Attribute Details
#compartment_id ⇒ String
[Required] The OCID of the tenancy. The tenancy is the root compartment.
32 33 34 |
# File 'lib/oci/optimizer/models/category.rb', line 32 def compartment_id @compartment_id end |
#compartment_name ⇒ String
[Required] The name associated with the compartment.
36 37 38 |
# File 'lib/oci/optimizer/models/category.rb', line 36 def compartment_name @compartment_name end |
#description ⇒ String
[Required] Text describing the category.
44 45 46 |
# File 'lib/oci/optimizer/models/category.rb', line 44 def description @description end |
#estimated_cost_saving ⇒ Float
[Required] The estimated cost savings, in dollars, for the category.
60 61 62 |
# File 'lib/oci/optimizer/models/category.rb', line 60 def estimated_cost_saving @estimated_cost_saving end |
#extended_metadata ⇒ Hash<String, String>
Additional metadata key/value pairs for the category.
For example:
{\"EstimatedSaving\": \"200\"}
77 78 79 |
# File 'lib/oci/optimizer/models/category.rb', line 77 def @extended_metadata end |
#id ⇒ String
[Required] The unique OCID of the category.
28 29 30 |
# File 'lib/oci/optimizer/models/category.rb', line 28 def id @id end |
#lifecycle_state ⇒ String
[Required] The category's current state.
56 57 58 |
# File 'lib/oci/optimizer/models/category.rb', line 56 def lifecycle_state @lifecycle_state end |
#name ⇒ String
[Required] The name assigned to the category.
40 41 42 |
# File 'lib/oci/optimizer/models/category.rb', line 40 def name @name end |
#recommendation_counts ⇒ Array<OCI::Optimizer::Models::RecommendationCount>
[Required] An array of RecommendationCount
objects grouped by the level of importance assigned to the recommendation.
48 49 50 |
# File 'lib/oci/optimizer/models/category.rb', line 48 def recommendation_counts @recommendation_counts end |
#resource_counts ⇒ Array<OCI::Optimizer::Models::ResourceCount>
[Required] An array of ResourceCount
objects grouped by the status of the recommendation.
52 53 54 |
# File 'lib/oci/optimizer/models/category.rb', line 52 def resource_counts @resource_counts end |
#time_created ⇒ DateTime
[Required] The date and time the category details were created, in the format defined by RFC3339.
64 65 66 |
# File 'lib/oci/optimizer/models/category.rb', line 64 def time_created @time_created end |
#time_updated ⇒ DateTime
[Required] The date and time the category details were last updated, in the format defined by RFC3339.
68 69 70 |
# File 'lib/oci/optimizer/models/category.rb', line 68 def time_updated @time_updated end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 |
# File 'lib/oci/optimizer/models/category.rb', line 80 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'compartment_id': :'compartmentId', 'compartment_name': :'compartmentName', 'name': :'name', 'description': :'description', 'recommendation_counts': :'recommendationCounts', 'resource_counts': :'resourceCounts', 'lifecycle_state': :'lifecycleState', 'estimated_cost_saving': :'estimatedCostSaving', 'time_created': :'timeCreated', 'time_updated': :'timeUpdated', 'extended_metadata': :'extendedMetadata' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 |
# File 'lib/oci/optimizer/models/category.rb', line 100 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'compartment_id': :'String', 'compartment_name': :'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', 'extended_metadata': :'Hash<String, String>' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 |
# File 'lib/oci/optimizer/models/category.rb', line 224 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && compartment_id == other.compartment_id && compartment_name == other.compartment_name && 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 && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 |
# File 'lib/oci/optimizer/models/category.rb', line 265 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
245 246 247 |
# File 'lib/oci/optimizer/models/category.rb', line 245 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
254 255 256 |
# File 'lib/oci/optimizer/models/category.rb', line 254 def hash [id, compartment_id, compartment_name, name, description, recommendation_counts, resource_counts, lifecycle_state, estimated_cost_saving, time_created, time_updated, ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
298 299 300 301 302 303 304 305 306 307 |
# File 'lib/oci/optimizer/models/category.rb', line 298 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
292 293 294 |
# File 'lib/oci/optimizer/models/category.rb', line 292 def to_s to_hash.to_s end |