Class: OCI::GoldenGate::Models::UpdateKafkaConnectionDetails

Inherits:
UpdateConnectionDetails show all
Defined in:
lib/oci/golden_gate/models/update_kafka_connection_details.rb

Overview

The information to update a Kafka Connection.

Constant Summary

Constants inherited from UpdateConnectionDetails

OCI::GoldenGate::Models::UpdateConnectionDetails::CONNECTION_TYPE_ENUM, OCI::GoldenGate::Models::UpdateConnectionDetails::ROUTING_METHOD_ENUM

Instance Attribute Summary collapse

Attributes inherited from UpdateConnectionDetails

#connection_type, #defined_tags, #description, #display_name, #freeform_tags, #key_id, #nsg_ids, #routing_method, #subnet_id, #vault_id

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from UpdateConnectionDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ UpdateKafkaConnectionDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :display_name (String) —

    The value to assign to the #display_name proprety

  • :description (String) —

    The value to assign to the #description proprety

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

    The value to assign to the #freeform_tags proprety

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

    The value to assign to the #defined_tags proprety

  • :vault_id (String) —

    The value to assign to the #vault_id proprety

  • :key_id (String) —

    The value to assign to the #key_id proprety

  • :nsg_ids (Array<String>) —

    The value to assign to the #nsg_ids proprety

  • :subnet_id (String) —

    The value to assign to the #subnet_id proprety

  • :routing_method (String) —

    The value to assign to the #routing_method proprety

  • :stream_pool_id (String) —

    The value to assign to the #stream_pool_id property

  • :bootstrap_servers (Array<OCI::GoldenGate::Models::KafkaBootstrapServer>) —

    The value to assign to the #bootstrap_servers property

  • :security_protocol (String) —

    The value to assign to the #security_protocol property

  • :username (String) —

    The value to assign to the #username property

  • :password (String) —

    The value to assign to the #password property

  • :trust_store (String) —

    The value to assign to the #trust_store property

  • :trust_store_password (String) —

    The value to assign to the #trust_store_password property

  • :key_store (String) —

    The value to assign to the #key_store property

  • :key_store_password (String) —

    The value to assign to the #key_store_password property

  • :ssl_key_password (String) —

    The value to assign to the #ssl_key_password property

  • :consumer_properties (String) —

    The value to assign to the #consumer_properties property

  • :producer_properties (String) —

    The value to assign to the #producer_properties property



167
168
169
170
171
172
173
174
175
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
 
# File 'lib/oci/golden_gate/models/update_kafka_connection_details.rb', line 167

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

  attributes['connectionType'] = 'KAFKA'

  super(attributes)

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

  self.stream_pool_id = attributes[:'streamPoolId'] if attributes[:'streamPoolId']

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

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

  self.bootstrap_servers = attributes[:'bootstrapServers'] if attributes[:'bootstrapServers']

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

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

  self.security_protocol = attributes[:'securityProtocol'] if attributes[:'securityProtocol']

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

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

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

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

  self.trust_store = attributes[:'trustStore'] if attributes[:'trustStore']

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

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

  self.trust_store_password = attributes[:'trustStorePassword'] if attributes[:'trustStorePassword']

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

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

  self.key_store = attributes[:'keyStore'] if attributes[:'keyStore']

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

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

  self.key_store_password = attributes[:'keyStorePassword'] if attributes[:'keyStorePassword']

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

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

  self.ssl_key_password = attributes[:'sslKeyPassword'] if attributes[:'sslKeyPassword']

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

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

  self.consumer_properties = attributes[:'consumerProperties'] if attributes[:'consumerProperties']

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

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

  self.producer_properties = attributes[:'producerProperties'] if attributes[:'producerProperties']

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

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

Instance Attribute Details

#bootstrap_servers ⇒ Array<OCI::GoldenGate::Models::KafkaBootstrapServer>

Kafka bootstrap. Equivalent of bootstrap.servers configuration property in Kafka: list of KafkaBootstrapServer objects specified by host/port. Used for establishing the initial connection to the Kafka cluster. Example: \"server1.example.com:9092,server2.example.com:9092\"

Returns:



24
25
26
 
# File 'lib/oci/golden_gate/models/update_kafka_connection_details.rb', line 24

def bootstrap_servers
  @bootstrap_servers
end

#consumer_properties ⇒ String

The base64 encoded content of the consumer.properties file.

Returns:

  • (String) 


73
74
75
 
# File 'lib/oci/golden_gate/models/update_kafka_connection_details.rb', line 73

def consumer_properties
  @consumer_properties
end

#key_store ⇒ String

The base64 encoded content of the KeyStore file.

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/golden_gate/models/update_kafka_connection_details.rb', line 57

def key_store
  @key_store
end

#key_store_password ⇒ String

The KeyStore password.

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/golden_gate/models/update_kafka_connection_details.rb', line 62

def key_store_password
  @key_store_password
end

#password ⇒ String

The password Oracle GoldenGate uses to connect the associated system of the given technology. It must conform to the specific security requirements including length, case sensitivity, and so on.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/golden_gate/models/update_kafka_connection_details.rb', line 42

def password
  @password
end

#producer_properties ⇒ String

The base64 encoded content of the producer.properties file.

Returns:

  • (String) 


78
79
80
 
# File 'lib/oci/golden_gate/models/update_kafka_connection_details.rb', line 78

def producer_properties
  @producer_properties
end

#security_protocol ⇒ String

Security Type for Kafka.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/golden_gate/models/update_kafka_connection_details.rb', line 29

def security_protocol
  @security_protocol
end

#ssl_key_password ⇒ String

The password for the cert inside of the KeyStore. In case it differs from the KeyStore password, it should be provided.

Returns:

  • (String) 


68
69
70
 
# File 'lib/oci/golden_gate/models/update_kafka_connection_details.rb', line 68

def ssl_key_password
  @ssl_key_password
end

#stream_pool_id ⇒ String

The OCID of the stream pool being referenced.

Returns:

  • (String) 


16
17
18
 
# File 'lib/oci/golden_gate/models/update_kafka_connection_details.rb', line 16

def stream_pool_id
  @stream_pool_id
end

#trust_store ⇒ String

The base64 encoded content of the TrustStore file.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/golden_gate/models/update_kafka_connection_details.rb', line 47

def trust_store
  @trust_store
end

#trust_store_password ⇒ String

The TrustStore password.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/golden_gate/models/update_kafka_connection_details.rb', line 52

def trust_store_password
  @trust_store_password
end

#username ⇒ String

The username Oracle GoldenGate uses to connect the associated system of the given technology. This username must already exist and be available by the system/application to be connected to and must conform to the case sensitivty requirments defined in it.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/golden_gate/models/update_kafka_connection_details.rb', line 36

def username
  @username
end

Class Method Details

.attribute_map ⇒ Object

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



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/oci/golden_gate/models/update_kafka_connection_details.rb', line 81

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'connection_type': :'connectionType',
    'display_name': :'displayName',
    'description': :'description',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'vault_id': :'vaultId',
    'key_id': :'keyId',
    'nsg_ids': :'nsgIds',
    'subnet_id': :'subnetId',
    'routing_method': :'routingMethod',
    'stream_pool_id': :'streamPoolId',
    'bootstrap_servers': :'bootstrapServers',
    'security_protocol': :'securityProtocol',
    'username': :'username',
    'password': :'password',
    'trust_store': :'trustStore',
    'trust_store_password': :'trustStorePassword',
    'key_store': :'keyStore',
    'key_store_password': :'keyStorePassword',
    'ssl_key_password': :'sslKeyPassword',
    'consumer_properties': :'consumerProperties',
    'producer_properties': :'producerProperties'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/oci/golden_gate/models/update_kafka_connection_details.rb', line 111

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'connection_type': :'String',
    'display_name': :'String',
    'description': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'vault_id': :'String',
    'key_id': :'String',
    'nsg_ids': :'Array<String>',
    'subnet_id': :'String',
    'routing_method': :'String',
    'stream_pool_id': :'String',
    'bootstrap_servers': :'Array<OCI::GoldenGate::Models::KafkaBootstrapServer>',
    'security_protocol': :'String',
    'username': :'String',
    'password': :'String',
    'trust_store': :'String',
    'trust_store_password': :'String',
    'key_store': :'String',
    'key_store_password': :'String',
    'ssl_key_password': :'String',
    'consumer_properties': :'String',
    'producer_properties': :'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



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/golden_gate/models/update_kafka_connection_details.rb', line 249

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

  self.class == other.class &&
    connection_type == other.connection_type &&
    display_name == other.display_name &&
    description == other.description &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    vault_id == other.vault_id &&
    key_id == other.key_id &&
    nsg_ids == other.nsg_ids &&
    subnet_id == other.subnet_id &&
    routing_method == other.routing_method &&
    stream_pool_id == other.stream_pool_id &&
    bootstrap_servers == other.bootstrap_servers &&
    security_protocol == other.security_protocol &&
    username == other.username &&
    password == other.password &&
    trust_store == other.trust_store &&
    trust_store_password == other.trust_store_password &&
    key_store == other.key_store &&
    key_store_password == other.key_store_password &&
    ssl_key_password == other.ssl_key_password &&
    consumer_properties == other.consumer_properties &&
    producer_properties == other.producer_properties
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



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/oci/golden_gate/models/update_kafka_connection_details.rb', line 300

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


280
281
282
 
# File 'lib/oci/golden_gate/models/update_kafka_connection_details.rb', line 280

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



289
290
291
 
# File 'lib/oci/golden_gate/models/update_kafka_connection_details.rb', line 289

def hash
  [connection_type, display_name, description, freeform_tags, defined_tags, vault_id, key_id, nsg_ids, subnet_id, routing_method, stream_pool_id, bootstrap_servers, security_protocol, username, password, trust_store, trust_store_password, key_store, key_store_password, ssl_key_password, consumer_properties, producer_properties].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



333
334
335
336
337
338
339
340
341
342
 
# File 'lib/oci/golden_gate/models/update_kafka_connection_details.rb', line 333

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



327
328
329
 
# File 'lib/oci/golden_gate/models/update_kafka_connection_details.rb', line 327

def to_s
  to_hash.to_s
end