Class: OCI::ContainerEngine::Models::AddonOptionSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/container_engine/models/addon_option_summary.rb

Overview

The properties that define addon summary.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.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 = {}) ⇒ AddonOptionSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :name (String) —

    The value to assign to the #name property

  • :addon_schema_version (String) —

    The value to assign to the #addon_schema_version property

  • :addon_group (String) —

    The value to assign to the #addon_group property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :description (String) —

    The value to assign to the #description property

  • :is_essential (BOOLEAN) —

    The value to assign to the #is_essential property

  • :versions (Array<OCI::ContainerEngine::Models::AddonVersions>) —

    The value to assign to the #versions 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

  • :time_created (DateTime) —

    The value to assign to the #time_created property



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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/oci/container_engine/models/addon_option_summary.rb', line 125

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

  self.addon_schema_version = attributes[:'addonSchemaVersion'] if attributes[:'addonSchemaVersion']

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

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

  self.addon_group = attributes[:'addonGroup'] if attributes[:'addonGroup']

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

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

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

  self.is_essential = attributes[:'isEssential'] unless attributes[:'isEssential'].nil?

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

  self.is_essential = attributes[:'is_essential'] unless attributes[:'is_essential'].nil?

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

  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.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']
end

Instance Attribute Details

#addon_group ⇒ String

Addon group info, a namespace concept that groups addons with similar functionalities.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/container_engine/models/addon_option_summary.rb', line 28

def addon_group
  @addon_group
end

#addon_schema_version ⇒ String

Addon definition schema version to validate addon.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/container_engine/models/addon_option_summary.rb', line 24

def addon_schema_version
  @addon_schema_version
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: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

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


58
59
60
 
# File 'lib/oci/container_engine/models/addon_option_summary.rb', line 58

def defined_tags
  @defined_tags
end

#description ⇒ String

Description on the addon.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/container_engine/models/addon_option_summary.rb', line 36

def description
  @description
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


51
52
53
 
# File 'lib/oci/container_engine/models/addon_option_summary.rb', line 51

def freeform_tags
  @freeform_tags
end

#is_essential ⇒ BOOLEAN

[Required] Is it an essential addon for cluster operation or not.

Returns:

  • (BOOLEAN) 


40
41
42
 
# File 'lib/oci/container_engine/models/addon_option_summary.rb', line 40

def is_essential
  @is_essential
end

#lifecycle_state ⇒ String

[Required] The life cycle state of the addon.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/container_engine/models/addon_option_summary.rb', line 32

def lifecycle_state
  @lifecycle_state
end

#name ⇒ String

[Required] Name of the addon and it would be unique.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/container_engine/models/addon_option_summary.rb', line 20

def name
  @name
end

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

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


64
65
66
 
# File 'lib/oci/container_engine/models/addon_option_summary.rb', line 64

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

The time the work request was created.

Returns:

  • (DateTime) 


68
69
70
 
# File 'lib/oci/container_engine/models/addon_option_summary.rb', line 68

def time_created
  @time_created
end

#versions ⇒ Array<OCI::ContainerEngine::Models::AddonVersions>

[Required] The resources this work request affects.

Returns:



44
45
46
 
# File 'lib/oci/container_engine/models/addon_option_summary.rb', line 44

def versions
  @versions
end

Class Method Details

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/oci/container_engine/models/addon_option_summary.rb', line 71

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'addon_schema_version': :'addonSchemaVersion',
    'addon_group': :'addonGroup',
    'lifecycle_state': :'lifecycleState',
    'description': :'description',
    'is_essential': :'isEssential',
    'versions': :'versions',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'time_created': :'timeCreated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/oci/container_engine/models/addon_option_summary.rb', line 90

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'addon_schema_version': :'String',
    'addon_group': :'String',
    'lifecycle_state': :'String',
    'description': :'String',
    'is_essential': :'BOOLEAN',
    'versions': :'Array<OCI::ContainerEngine::Models::AddonVersions>',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'time_created': :'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



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/oci/container_engine/models/addon_option_summary.rb', line 206

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

  self.class == other.class &&
    name == other.name &&
    addon_schema_version == other.addon_schema_version &&
    addon_group == other.addon_group &&
    lifecycle_state == other.lifecycle_state &&
    description == other.description &&
    is_essential == other.is_essential &&
    versions == other.versions &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags &&
    time_created == other.time_created
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



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/oci/container_engine/models/addon_option_summary.rb', line 246

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


226
227
228
 
# File 'lib/oci/container_engine/models/addon_option_summary.rb', line 226

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



235
236
237
 
# File 'lib/oci/container_engine/models/addon_option_summary.rb', line 235

def hash
  [name, addon_schema_version, addon_group, lifecycle_state, description, is_essential, versions, freeform_tags, defined_tags, system_tags, time_created].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



279
280
281
282
283
284
285
286
287
288
 
# File 'lib/oci/container_engine/models/addon_option_summary.rb', line 279

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



273
274
275
 
# File 'lib/oci/container_engine/models/addon_option_summary.rb', line 273

def to_s
  to_hash.to_s
end