Class: OCI::Opsi::Models::CreateChargebackPlanDetails

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

Overview

The details used to create a new Ops Insights chargeback plan. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Direct Known Subclasses

CreateChargebackPlanExadataDetails

Constant Summary collapse

ENTITY_SOURCE_ENUM = 
[
  ENTITY_SOURCE_CHARGEBACK_EXADATA = 'CHARGEBACK_EXADATA'.freeze,
  ENTITY_SOURCE_CHARGEBACK_COMPUTE = 'CHARGEBACK_COMPUTE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateChargebackPlanDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
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
 
# File 'lib/oci/opsi/models/create_chargeback_plan_details.rb', line 115

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.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.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.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.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_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) 


23
24
25
 
# File 'lib/oci/opsi/models/create_chargeback_plan_details.rb', line 23

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. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

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


35
36
37
 
# File 'lib/oci/opsi/models/create_chargeback_plan_details.rb', line 35

def defined_tags
  @defined_tags
end

#entity_source ⇒ String

[Required] Source of the chargeback plan.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/opsi/models/create_chargeback_plan_details.rb', line 19

def entity_source
  @entity_source
end

#freeform_tags ⇒ Hash<String, String>

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>) 


29
30
31
 
# File 'lib/oci/opsi/models/create_chargeback_plan_details.rb', line 29

def freeform_tags
  @freeform_tags
end

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

List of chargeback plan customizations.

Returns:



52
53
54
 
# File 'lib/oci/opsi/models/create_chargeback_plan_details.rb', line 52

def plan_custom_items
  @plan_custom_items
end

#plan_description ⇒ String

Description of OPSI Chargeback Plan.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/opsi/models/create_chargeback_plan_details.rb', line 43

def plan_description
  @plan_description
end

#plan_name ⇒ String

[Required] Name for the OPSI Chargeback plan.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/opsi/models/create_chargeback_plan_details.rb', line 39

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) 


48
49
50
 
# File 'lib/oci/opsi/models/create_chargeback_plan_details.rb', line 48

def plan_type
  @plan_type
end

Class Method Details

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/oci/opsi/models/create_chargeback_plan_details.rb', line 55

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'entity_source': :'entitySource',
    'compartment_id': :'compartmentId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'plan_name': :'planName',
    'plan_description': :'planDescription',
    'plan_type': :'planType',
    'plan_custom_items': :'planCustomItems'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



91
92
93
94
95
96
97
98
 
# File 'lib/oci/opsi/models/create_chargeback_plan_details.rb', line 91

def self.get_subtype(object_hash)
  type = object_hash[:'entitySource'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::Opsi::Models::CreateChargebackPlanExadataDetails' if type == 'CHARGEBACK_EXADATA'

  # TODO: Log a warning when the subtype is not found.
  'OCI::Opsi::Models::CreateChargebackPlanDetails'
end

.swagger_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/oci/opsi/models/create_chargeback_plan_details.rb', line 71

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'entity_source': :'String',
    'compartment_id': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'plan_name': :'String',
    'plan_description': :'String',
    'plan_type': :'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



185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/oci/opsi/models/create_chargeback_plan_details.rb', line 185

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

  self.class == other.class &&
    entity_source == other.entity_source &&
    compartment_id == other.compartment_id &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    plan_name == other.plan_name &&
    plan_description == other.plan_description &&
    plan_type == other.plan_type &&
    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



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/oci/opsi/models/create_chargeback_plan_details.rb', line 222

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


202
203
204
 
# File 'lib/oci/opsi/models/create_chargeback_plan_details.rb', line 202

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



211
212
213
 
# File 'lib/oci/opsi/models/create_chargeback_plan_details.rb', line 211

def hash
  [entity_source, compartment_id, freeform_tags, defined_tags, plan_name, plan_description, plan_type, 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



255
256
257
258
259
260
261
262
263
264
 
# File 'lib/oci/opsi/models/create_chargeback_plan_details.rb', line 255

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



249
250
251
 
# File 'lib/oci/opsi/models/create_chargeback_plan_details.rb', line 249

def to_s
  to_hash.to_s
end