Class: OCI::ManagedKafka::Models::KafkaClusterAddon

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/managed_kafka/models/kafka_cluster_addon.rb

Overview

The base data object to represent a KafkaClusterAddon. 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

PublicConnectivityAddon

Constant Summary collapse

ADDON_TYPE_ENUM = 
[
  ADDON_TYPE_PUBLICCONNECTIVITY = 'PUBLICCONNECTIVITY'.freeze,
  ADDON_TYPE_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_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ KafkaClusterAddon

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

  • :description (String) —

    The value to assign to the #description property

  • :addon_type (String) —

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

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property



107
108
109
110
111
112
113
114
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
 
# File 'lib/oci/managed_kafka/models/kafka_cluster_addon.rb', line 107

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

  self.addon_type = attributes[:'addonType'] if attributes[:'addonType']

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

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

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

Instance Attribute Details

#addon_type ⇒ String

[Required] The type of addon

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/managed_kafka/models/kafka_cluster_addon.rb', line 38

def addon_type
  @addon_type
end

#description ⇒ String

Description of the add on

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/managed_kafka/models/kafka_cluster_addon.rb', line 34

def description
  @description
end

#lifecycle_state ⇒ String

[Required] The current state of the KafkaCluster.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/managed_kafka/models/kafka_cluster_addon.rb', line 50

def lifecycle_state
  @lifecycle_state
end

#name ⇒ String

[Required] A unique user-friendly name.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/managed_kafka/models/kafka_cluster_addon.rb', line 30

def name
  @name
end

#time_created ⇒ DateTime

The time the addon was created.

Returns:

  • (DateTime) 


42
43
44
 
# File 'lib/oci/managed_kafka/models/kafka_cluster_addon.rb', line 42

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The time the addon was updated.

Returns:

  • (DateTime) 


46
47
48
 
# File 'lib/oci/managed_kafka/models/kafka_cluster_addon.rb', line 46

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/oci/managed_kafka/models/kafka_cluster_addon.rb', line 53

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'description': :'description',
    'addon_type': :'addonType',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState'
    # 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.



85
86
87
88
89
90
91
92
 
# File 'lib/oci/managed_kafka/models/kafka_cluster_addon.rb', line 85

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

  return 'OCI::ManagedKafka::Models::PublicConnectivityAddon' if type == 'PUBLICCONNECTIVITY'

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

.swagger_types ⇒ Object

Attribute type mapping.



67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/oci/managed_kafka/models/kafka_cluster_addon.rb', line 67

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'description': :'String',
    'addon_type': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String'
    # 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



175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/oci/managed_kafka/models/kafka_cluster_addon.rb', line 175

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

  self.class == other.class &&
    name == other.name &&
    description == other.description &&
    addon_type == other.addon_type &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state
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



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/oci/managed_kafka/models/kafka_cluster_addon.rb', line 210

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


190
191
192
 
# File 'lib/oci/managed_kafka/models/kafka_cluster_addon.rb', line 190

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



199
200
201
 
# File 'lib/oci/managed_kafka/models/kafka_cluster_addon.rb', line 199

def hash
  [name, description, addon_type, time_created, time_updated, lifecycle_state].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



243
244
245
246
247
248
249
250
251
252
 
# File 'lib/oci/managed_kafka/models/kafka_cluster_addon.rb', line 243

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



237
238
239
 
# File 'lib/oci/managed_kafka/models/kafka_cluster_addon.rb', line 237

def to_s
  to_hash.to_s
end