Class: OCI::Opsi::Models::ChargebackPlanSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/opsi/models/chargeback_plan_summary.rb

Overview

Summary of a Ops Insights chargeback plan.

Constant Summary collapse

PLAN_CATEGORY_ENUM = 
[
  PLAN_CATEGORY_OOB = 'OOB'.freeze,
  PLAN_CATEGORY_CUSTOM = 'CUSTOM'.freeze,
  PLAN_CATEGORY_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
ENTITY_SOURCE_ENUM = 
[
  ENTITY_SOURCE_CHARGEBACK_EXADATA = 'CHARGEBACK_EXADATA'.freeze,
  ENTITY_SOURCE_CHARGEBACK_COMPUTE = 'CHARGEBACK_COMPUTE'.freeze,
  ENTITY_SOURCE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.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 = {}) ⇒ ChargebackPlanSummary

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

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :plan_name (String) —

    The value to assign to the #plan_name property

  • :plan_description (String) —

    The value to assign to the #plan_description property

  • :plan_type (String) —

    The value to assign to the #plan_type property

  • :plan_category (String) —

    The value to assign to the #plan_category property

  • :is_customizable (BOOLEAN) —

    The value to assign to the #is_customizable property

  • :entity_source (String) —

    The value to assign to the #entity_source property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

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

    The value to assign to the #freeform_tags property

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

    The value to assign to the #defined_tags property

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

    The value to assign to the #system_tags property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details property

  • :plan_custom_items (Array<OCI::Opsi::Models::CreatePlanCustomItemDetails>) —

    The value to assign to the #plan_custom_items property



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
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
 
# File 'lib/oci/opsi/models/chargeback_plan_summary.rb', line 176

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

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

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

  self.plan_description = attributes[:'planDescription'] if attributes[:'planDescription']

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

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

  self.plan_type = attributes[:'planType'] if attributes[:'planType']

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

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

  self.plan_category = attributes[:'planCategory'] if attributes[:'planCategory']

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

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

  self.is_customizable = attributes[:'isCustomizable'] unless attributes[:'isCustomizable'].nil?
  self.is_customizable = false if is_customizable.nil? && !attributes.key?(:'isCustomizable') # rubocop:disable Style/StringLiterals

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

  self.is_customizable = attributes[:'is_customizable'] unless attributes[:'is_customizable'].nil?
  self.is_customizable = false if is_customizable.nil? && !attributes.key?(:'isCustomizable') && !attributes.key?(:'is_customizable') # rubocop:disable Style/StringLiterals

  self.entity_source = attributes[:'entitySource'] if attributes[:'entitySource']

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

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

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

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

  self.system_tags = attributes[:'system_tags'] if attributes[:'system_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.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

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

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

  self.plan_custom_items = attributes[:'planCustomItems'] if attributes[:'planCustomItems']

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

  self.plan_custom_items = attributes[:'plan_custom_items'] if attributes[:'plan_custom_items']
end

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/opsi/models/chargeback_plan_summary.rb', line 41

def compartment_id
  @compartment_id
end

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

[Required] Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

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


86
87
88
 
# File 'lib/oci/opsi/models/chargeback_plan_summary.rb', line 86

def defined_tags
  @defined_tags
end

#entity_source ⇒ String

[Required] Source of the chargeback plan.

Returns:

  • (String) 


66
67
68
 
# File 'lib/oci/opsi/models/chargeback_plan_summary.rb', line 66

def entity_source
  @entity_source
end

#freeform_tags ⇒ Hash<String, String>

[Required] Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


80
81
82
 
# File 'lib/oci/opsi/models/chargeback_plan_summary.rb', line 80

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] OCID of OPSI Chargeback plan resource.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/opsi/models/chargeback_plan_summary.rb', line 37

def id
  @id
end

#is_customizable ⇒ BOOLEAN

Indicates whether the chargeback plan can be customized.

Returns:

  • (BOOLEAN) 


62
63
64
 
# File 'lib/oci/opsi/models/chargeback_plan_summary.rb', line 62

def is_customizable
  @is_customizable
end

#lifecycle_details ⇒ String

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Returns:

  • (String) 


100
101
102
 
# File 'lib/oci/opsi/models/chargeback_plan_summary.rb', line 100

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] Chargeback Plan lifecycle states

Returns:

  • (String) 


96
97
98
 
# File 'lib/oci/opsi/models/chargeback_plan_summary.rb', line 96

def lifecycle_state
  @lifecycle_state
end

#plan_category ⇒ String

Chargeback Plan category of the chargeback entity. It can be OOB, or CUSTOM.

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/opsi/models/chargeback_plan_summary.rb', line 58

def plan_category
  @plan_category
end

#plan_custom_items ⇒ Array<OCI::Opsi::Models::CreatePlanCustomItemDetails>

[Required] List of chargeback plan customizations.

Returns:



104
105
106
 
# File 'lib/oci/opsi/models/chargeback_plan_summary.rb', line 104

def plan_custom_items
  @plan_custom_items
end

#plan_description ⇒ String

Description of OPSI Chargeback Plan.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/opsi/models/chargeback_plan_summary.rb', line 49

def plan_description
  @plan_description
end

#plan_name ⇒ String

[Required] Name for the OPSI Chargeback plan.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/opsi/models/chargeback_plan_summary.rb', line 45

def plan_name
  @plan_name
end

#plan_type ⇒ String

[Required] Chargeback Plan type of the chargeback entity. For an Exadata it can be WEIGHTED_ALLOCATION, EQUAL_ALLOCATION, UNUSED_ALLOCATION.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/opsi/models/chargeback_plan_summary.rb', line 54

def plan_type
  @plan_type
end

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

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


92
93
94
 
# File 'lib/oci/opsi/models/chargeback_plan_summary.rb', line 92

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


70
71
72
 
# File 'lib/oci/opsi/models/chargeback_plan_summary.rb', line 70

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] The time chargeback plan was updated. An RFC3339 formatted datetime string

Returns:

  • (DateTime) 


74
75
76
 
# File 'lib/oci/opsi/models/chargeback_plan_summary.rb', line 74

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/oci/opsi/models/chargeback_plan_summary.rb', line 107

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'plan_name': :'planName',
    'plan_description': :'planDescription',
    'plan_type': :'planType',
    'plan_category': :'planCategory',
    'is_customizable': :'isCustomizable',
    'entity_source': :'entitySource',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'plan_custom_items': :'planCustomItems'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/oci/opsi/models/chargeback_plan_summary.rb', line 131

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'plan_name': :'String',
    'plan_description': :'String',
    'plan_type': :'String',
    'plan_category': :'String',
    'is_customizable': :'BOOLEAN',
    'entity_source': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'plan_custom_items': :'Array<OCI::Opsi::Models::CreatePlanCustomItemDetails>'
    # 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



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/oci/opsi/models/chargeback_plan_summary.rb', line 323

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    plan_name == other.plan_name &&
    plan_description == other.plan_description &&
    plan_type == other.plan_type &&
    plan_category == other.plan_category &&
    is_customizable == other.is_customizable &&
    entity_source == other.entity_source &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    plan_custom_items == other.plan_custom_items
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



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/oci/opsi/models/chargeback_plan_summary.rb', line 368

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


348
349
350
 
# File 'lib/oci/opsi/models/chargeback_plan_summary.rb', line 348

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



357
358
359
 
# File 'lib/oci/opsi/models/chargeback_plan_summary.rb', line 357

def hash
  [id, compartment_id, plan_name, plan_description, plan_type, plan_category, is_customizable, entity_source, time_created, time_updated, freeform_tags, defined_tags, system_tags, lifecycle_state, lifecycle_details, plan_custom_items].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



401
402
403
404
405
406
407
408
409
410
 
# File 'lib/oci/opsi/models/chargeback_plan_summary.rb', line 401

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



395
396
397
 
# File 'lib/oci/opsi/models/chargeback_plan_summary.rb', line 395

def to_s
  to_hash.to_s
end