Class: OCI::GoldenGate::Models::UpdateRedisConnectionDetails

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

Overview

The information to update a Redis Database 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, #does_use_secret_ids, #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 = {}) ⇒ UpdateRedisConnectionDetails

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

  • :does_use_secret_ids (BOOLEAN) —

    The value to assign to the #does_use_secret_ids proprety

  • :servers (String) —

    The value to assign to the #servers property

  • :security_protocol (String) —

    The value to assign to the #security_protocol property

  • :authentication_type (String) —

    The value to assign to the #authentication_type property

  • :username (String) —

    The value to assign to the #username property

  • :password (String) —

    The value to assign to the #password property

  • :password_secret_id (String) —

    The value to assign to the #password_secret_id property

  • :trust_store (String) —

    The value to assign to the #trust_store property

  • :trust_store_secret_id (String) —

    The value to assign to the #trust_store_secret_id property

  • :trust_store_password (String) —

    The value to assign to the #trust_store_password property

  • :trust_store_password_secret_id (String) —

    The value to assign to the #trust_store_password_secret_id property

  • :key_store (String) —

    The value to assign to the #key_store property

  • :key_store_secret_id (String) —

    The value to assign to the #key_store_secret_id property

  • :key_store_password (String) —

    The value to assign to the #key_store_password property

  • :key_store_password_secret_id (String) —

    The value to assign to the #key_store_password_secret_id property

  • :redis_cluster_id (String) —

    The value to assign to the #redis_cluster_id property



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
241
242
243
244
245
246
247
248
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
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/oci/golden_gate/models/update_redis_connection_details.rb', line 204

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

  attributes['connectionType'] = 'REDIS'

  super(attributes)

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

  self.servers = attributes[:'servers'] if attributes[:'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.authentication_type = attributes[:'authenticationType'] if attributes[:'authenticationType']

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

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

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

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

  self.password_secret_id = attributes[:'passwordSecretId'] if attributes[:'passwordSecretId']

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

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

  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_secret_id = attributes[:'trustStoreSecretId'] if attributes[:'trustStoreSecretId']

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

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

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

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

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

  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_secret_id = attributes[:'keyStoreSecretId'] if attributes[:'keyStoreSecretId']

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

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

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

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

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

  self.redis_cluster_id = attributes[:'redisClusterId'] if attributes[:'redisClusterId']

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

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

Instance Attribute Details

#authentication_type ⇒ String

Authenticationentication type for the Redis database.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/golden_gate/models/update_redis_connection_details.rb', line 27

def authentication_type
  @authentication_type
end

#key_store ⇒ String

The base64 encoded content of the KeyStore file. Deprecated: This field is deprecated and replaced by "keyStoreSecretId". This field will be removed after February 15 2026.

Returns:

  • (String) 


80
81
82
 
# File 'lib/oci/golden_gate/models/update_redis_connection_details.rb', line 80

def key_store
  @key_store
end

#key_store_password ⇒ String

The KeyStore password. Deprecated: This field is deprecated and replaced by "keyStorePasswordSecretId". This field will be removed after February 15 2026.

Returns:

  • (String) 


92
93
94
 
# File 'lib/oci/golden_gate/models/update_redis_connection_details.rb', line 92

def key_store_password
  @key_store_password
end

#key_store_password_secret_id ⇒ String

The OCID of the Secret where the Redis KeyStore password is stored. Note: When provided, 'keyStorePassword' field must not be provided.

Returns:

  • (String) 


98
99
100
 
# File 'lib/oci/golden_gate/models/update_redis_connection_details.rb', line 98

def key_store_password_secret_id
  @key_store_password_secret_id
end

#key_store_secret_id ⇒ String

The OCID of the Secret that stores the content of the KeyStore file. Note: When provided, 'keyStore' field must not be provided.

Returns:

  • (String) 


86
87
88
 
# File 'lib/oci/golden_gate/models/update_redis_connection_details.rb', line 86

def key_store_secret_id
  @key_store_secret_id
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. Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/golden_gate/models/update_redis_connection_details.rb', line 41

def password
  @password
end

#password_secret_id ⇒ String

The OCID of the Secret where the password is stored. 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. If secretId is used plaintext field must not be provided. Note: When provided, 'password' field must not be provided.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/golden_gate/models/update_redis_connection_details.rb', line 50

def password_secret_id
  @password_secret_id
end

#redis_cluster_id ⇒ String

The OCID of the Redis cluster.

Returns:

  • (String) 


103
104
105
 
# File 'lib/oci/golden_gate/models/update_redis_connection_details.rb', line 103

def redis_cluster_id
  @redis_cluster_id
end

#security_protocol ⇒ String

Security protocol for Redis.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/golden_gate/models/update_redis_connection_details.rb', line 23

def security_protocol
  @security_protocol
end

#servers ⇒ String

Comma separated list of Redis server addresses, specified as host:port entries, where :port is optional. If port is not specified, it defaults to 6379. Used for establishing the initial connection to the Redis cluster. Example: \"server1.example.com:6379,server2.example.com:6379\"

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/golden_gate/models/update_redis_connection_details.rb', line 19

def servers
  @servers
end

#trust_store ⇒ String

The base64 encoded content of the TrustStore file. Deprecated: This field is deprecated and replaced by "trustStoreSecretId". This field will be removed after February 15 2026.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/golden_gate/models/update_redis_connection_details.rb', line 56

def trust_store
  @trust_store
end

#trust_store_password ⇒ String

The TrustStore password. Deprecated: This field is deprecated and replaced by "trustStorePasswordSecretId". This field will be removed after February 15 2026.

Returns:

  • (String) 


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

def trust_store_password
  @trust_store_password
end

#trust_store_password_secret_id ⇒ String

The OCID of the Secret where the Redis TrustStore password is stored. Note: When provided, 'trustStorePassword' field must not be provided.

Returns:

  • (String) 


74
75
76
 
# File 'lib/oci/golden_gate/models/update_redis_connection_details.rb', line 74

def trust_store_password_secret_id
  @trust_store_password_secret_id
end

#trust_store_secret_id ⇒ String

The OCID of the Secret that stores the content of the TrustStore file. Note: When provided, 'trustStore' field must not be provided.

Returns:

  • (String) 


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

def trust_store_secret_id
  @trust_store_secret_id
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) 


34
35
36
 
# File 'lib/oci/golden_gate/models/update_redis_connection_details.rb', line 34

def username
  @username
end

Class Method Details

.attribute_map ⇒ Object

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



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

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',
    'does_use_secret_ids': :'doesUseSecretIds',
    'servers': :'servers',
    'security_protocol': :'securityProtocol',
    'authentication_type': :'authenticationType',
    'username': :'username',
    'password': :'password',
    'password_secret_id': :'passwordSecretId',
    'trust_store': :'trustStore',
    'trust_store_secret_id': :'trustStoreSecretId',
    'trust_store_password': :'trustStorePassword',
    'trust_store_password_secret_id': :'trustStorePasswordSecretId',
    'key_store': :'keyStore',
    'key_store_secret_id': :'keyStoreSecretId',
    'key_store_password': :'keyStorePassword',
    'key_store_password_secret_id': :'keyStorePasswordSecretId',
    'redis_cluster_id': :'redisClusterId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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',
    'does_use_secret_ids': :'BOOLEAN',
    'servers': :'String',
    'security_protocol': :'String',
    'authentication_type': :'String',
    'username': :'String',
    'password': :'String',
    'password_secret_id': :'String',
    'trust_store': :'String',
    'trust_store_secret_id': :'String',
    'trust_store_password': :'String',
    'trust_store_password_secret_id': :'String',
    'key_store': :'String',
    'key_store_secret_id': :'String',
    'key_store_password': :'String',
    'key_store_password_secret_id': :'String',
    'redis_cluster_id': :'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



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/oci/golden_gate/models/update_redis_connection_details.rb', line 300

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 &&
    does_use_secret_ids == other.does_use_secret_ids &&
    servers == other.servers &&
    security_protocol == other.security_protocol &&
    authentication_type == other.authentication_type &&
    username == other.username &&
    password == other.password &&
    password_secret_id == other.password_secret_id &&
    trust_store == other.trust_store &&
    trust_store_secret_id == other.trust_store_secret_id &&
    trust_store_password == other.trust_store_password &&
    trust_store_password_secret_id == other.trust_store_password_secret_id &&
    key_store == other.key_store &&
    key_store_secret_id == other.key_store_secret_id &&
    key_store_password == other.key_store_password &&
    key_store_password_secret_id == other.key_store_password_secret_id &&
    redis_cluster_id == other.redis_cluster_id
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



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/oci/golden_gate/models/update_redis_connection_details.rb', line 355

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


335
336
337
 
# File 'lib/oci/golden_gate/models/update_redis_connection_details.rb', line 335

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



344
345
346
 
# File 'lib/oci/golden_gate/models/update_redis_connection_details.rb', line 344

def hash
  [connection_type, display_name, description, freeform_tags, defined_tags, vault_id, key_id, nsg_ids, subnet_id, routing_method, does_use_secret_ids, servers, security_protocol, authentication_type, username, password, password_secret_id, trust_store, trust_store_secret_id, trust_store_password, trust_store_password_secret_id, key_store, key_store_secret_id, key_store_password, key_store_password_secret_id, redis_cluster_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



388
389
390
391
392
393
394
395
396
397
 
# File 'lib/oci/golden_gate/models/update_redis_connection_details.rb', line 388

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



382
383
384
 
# File 'lib/oci/golden_gate/models/update_redis_connection_details.rb', line 382

def to_s
  to_hash.to_s
end