Class: OCI::ManagedKafka::Models::PublicConnectivityAddon

Inherits:
KafkaClusterAddon show all
Defined in:
lib/oci/managed_kafka/models/public_connectivity_addon.rb

Overview

The data that represents a Public Connectivity Addon

Constant Summary

Constants inherited from KafkaClusterAddon

KafkaClusterAddon::ADDON_TYPE_ENUM, KafkaClusterAddon::LIFECYCLE_STATE_ENUM

Instance Attribute Summary collapse

Attributes inherited from KafkaClusterAddon

#addon_type, #description, #lifecycle_state, #name, #time_created, #time_updated

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from KafkaClusterAddon

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ PublicConnectivityAddon

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 proprety

  • :description (String) —

    The value to assign to the #description proprety

  • :time_created (DateTime) —

    The value to assign to the #time_created proprety

  • :time_updated (DateTime) —

    The value to assign to the #time_updated proprety

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state proprety

  • :authentication_mechanism (String) —

    The value to assign to the #authentication_mechanism property

  • :bootstrap_url (String) —

    The value to assign to the #bootstrap_url property

  • :network_cidrs (Array<String>) —

    The value to assign to the #network_cidrs property



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/oci/managed_kafka/models/public_connectivity_addon.rb', line 72

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['addonType'] = 'PUBLICCONNECTIVITY'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.authentication_mechanism = attributes[:'authenticationMechanism'] if attributes[:'authenticationMechanism']

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

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

  self.bootstrap_url = attributes[:'bootstrapUrl'] if attributes[:'bootstrapUrl']

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

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

  self.network_cidrs = attributes[:'networkCidrs'] if attributes[:'networkCidrs']

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

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

Instance Attribute Details

#authentication_mechanism ⇒ String

[Required] Authentication mechanism.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/managed_kafka/models/public_connectivity_addon.rb', line 14

def authentication_mechanism
  @authentication_mechanism
end

#bootstrap_url ⇒ String

[Required] The bootstrap url of the kafka cluster.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/managed_kafka/models/public_connectivity_addon.rb', line 18

def bootstrap_url
  @bootstrap_url
end

#network_cidrs ⇒ Array<String>

[Required] A list of CIDR ranges for ingress/egress traffic.

Returns:

  • (Array<String>) 


22
23
24
 
# File 'lib/oci/managed_kafka/models/public_connectivity_addon.rb', line 22

def network_cidrs
  @network_cidrs
end

Class Method Details

.attribute_map ⇒ Object

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



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/oci/managed_kafka/models/public_connectivity_addon.rb', line 25

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'description': :'description',
    'addon_type': :'addonType',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'authentication_mechanism': :'authenticationMechanism',
    'bootstrap_url': :'bootstrapUrl',
    'network_cidrs': :'networkCidrs'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/oci/managed_kafka/models/public_connectivity_addon.rb', line 42

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



108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/oci/managed_kafka/models/public_connectivity_addon.rb', line 108

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 &&
    authentication_mechanism == other.authentication_mechanism &&
    bootstrap_url == other.bootstrap_url &&
    network_cidrs == other.network_cidrs
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



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/managed_kafka/models/public_connectivity_addon.rb', line 146

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


126
127
128
 
# File 'lib/oci/managed_kafka/models/public_connectivity_addon.rb', line 126

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



135
136
137
 
# File 'lib/oci/managed_kafka/models/public_connectivity_addon.rb', line 135

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



179
180
181
182
183
184
185
186
187
188
 
# File 'lib/oci/managed_kafka/models/public_connectivity_addon.rb', line 179

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



173
174
175
 
# File 'lib/oci/managed_kafka/models/public_connectivity_addon.rb', line 173

def to_s
  to_hash.to_s
end