Class: OCI::Optimizer::Models::ProfileSummary

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

Overview

The metadata associated with the profile summary.

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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ProfileSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/oci/optimizer/models/profile_summary.rb', line 144

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

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

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

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

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

  self.target_compartments = attributes[:'targetCompartments'] if attributes[:'targetCompartments']

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

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

  self.target_tags = attributes[:'targetTags'] if attributes[:'targetTags']

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

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

  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

Instance Attribute Details

#aggregation_interval_in_days ⇒ Integer

The time period over which to collect data for the recommendations, measured in number of days.

Returns:

  • (Integer) 


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

def aggregation_interval_in_days
  @aggregation_interval_in_days
end

#compartment_id ⇒ String

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

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/optimizer/models/profile_summary.rb', line 32

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


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

def defined_tags
  @defined_tags
end

#description ⇒ String

[Required] Text describing the profile.

Returns:

  • (String) 


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

def description
  @description
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair applied without any predefined name, type, or namespace. For more information, see Resource Tags. Exists for cross-compatibility only.

Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


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

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The unique OCID of the profile.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/optimizer/models/profile_summary.rb', line 28

def id
  @id
end

#levels_configuration ⇒ OCI::Optimizer::Models::LevelsConfiguration

Returns:



67
68
69
 
# File 'lib/oci/optimizer/models/profile_summary.rb', line 67

def levels_configuration
  @levels_configuration
end

#lifecycle_state ⇒ String

[Required] The profile's current state.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#name ⇒ String

[Required] The name assigned to the profile.

Returns:

  • (String) 


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

def name
  @name
end

#target_compartments ⇒ OCI::Optimizer::Models::TargetCompartments

Returns:



70
71
72
 
# File 'lib/oci/optimizer/models/profile_summary.rb', line 70

def target_compartments
  @target_compartments
end

#target_tags ⇒ OCI::Optimizer::Models::TargetTags

Returns:



73
74
75
 
# File 'lib/oci/optimizer/models/profile_summary.rb', line 73

def target_tags
  @target_tags
end

#time_created ⇒ DateTime

[Required] The date and time the profile was created, in the format defined by RFC3339.

Returns:

  • (DateTime) 


77
78
79
 
# File 'lib/oci/optimizer/models/profile_summary.rb', line 77

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] The date and time the profile was last updated, in the format defined by RFC3339.

Returns:

  • (DateTime) 


81
82
83
 
# File 'lib/oci/optimizer/models/profile_summary.rb', line 81

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/oci/optimizer/models/profile_summary.rb', line 84

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'name': :'name',
    'description': :'description',
    'aggregation_interval_in_days': :'aggregationIntervalInDays',
    'defined_tags': :'definedTags',
    'freeform_tags': :'freeformTags',
    'lifecycle_state': :'lifecycleState',
    'levels_configuration': :'levelsConfiguration',
    'target_compartments': :'targetCompartments',
    'target_tags': :'targetTags',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/oci/optimizer/models/profile_summary.rb', line 105

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'name': :'String',
    'description': :'String',
    'aggregation_interval_in_days': :'Integer',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'freeform_tags': :'Hash<String, String>',
    'lifecycle_state': :'String',
    'levels_configuration': :'OCI::Optimizer::Models::LevelsConfiguration',
    'target_compartments': :'OCI::Optimizer::Models::TargetCompartments',
    'target_tags': :'OCI::Optimizer::Models::TargetTags',
    'time_created': :'DateTime',
    'time_updated': :'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



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/oci/optimizer/models/profile_summary.rb', line 237

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 &&
    aggregation_interval_in_days == other.aggregation_interval_in_days &&
    defined_tags == other.defined_tags &&
    freeform_tags == other.freeform_tags &&
    lifecycle_state == other.lifecycle_state &&
    levels_configuration == other.levels_configuration &&
    target_compartments == other.target_compartments &&
    target_tags == other.target_tags &&
    time_created == other.time_created &&
    time_updated == other.time_updated
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



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/oci/optimizer/models/profile_summary.rb', line 279

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


259
260
261
 
# File 'lib/oci/optimizer/models/profile_summary.rb', line 259

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



268
269
270
 
# File 'lib/oci/optimizer/models/profile_summary.rb', line 268

def hash
  [id, compartment_id, name, description, aggregation_interval_in_days, defined_tags, freeform_tags, lifecycle_state, levels_configuration, target_compartments, target_tags, time_created, time_updated].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



312
313
314
315
316
317
318
319
320
321
 
# File 'lib/oci/optimizer/models/profile_summary.rb', line 312

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



306
307
308
 
# File 'lib/oci/optimizer/models/profile_summary.rb', line 306

def to_s
  to_hash.to_s
end