Class: OCI::GoldenGate::Models::RedisConnection

Inherits:
Connection
  • Object
show all
Defined in:
lib/oci/golden_gate/models/redis_connection.rb

Overview

Represents the metadata of a Redis Database Connection.

Constant Summary collapse

TECHNOLOGY_TYPE_ENUM = 
[
  TECHNOLOGY_TYPE_REDIS = 'REDIS'.freeze,
  TECHNOLOGY_TYPE_OCI_CACHE_WITH_REDIS = 'OCI_CACHE_WITH_REDIS'.freeze,
  TECHNOLOGY_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
SECURITY_PROTOCOL_ENUM = 
[
  SECURITY_PROTOCOL_PLAIN = 'PLAIN'.freeze,
  SECURITY_PROTOCOL_TLS = 'TLS'.freeze,
  SECURITY_PROTOCOL_MTLS = 'MTLS'.freeze,
  SECURITY_PROTOCOL_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
AUTHENTICATION_TYPE_ENUM = 
[
  AUTHENTICATION_TYPE_NONE = 'NONE'.freeze,
  AUTHENTICATION_TYPE_BASIC = 'BASIC'.freeze,
  AUTHENTICATION_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Constants inherited from Connection

Connection::CONNECTION_TYPE_ENUM, Connection::LIFECYCLE_STATE_ENUM, Connection::ROUTING_METHOD_ENUM

Instance Attribute Summary collapse

Attributes inherited from Connection

#compartment_id, #connection_type, #defined_tags, #description, #display_name, #does_use_secret_ids, #freeform_tags, #id, #ingress_ips, #key_id, #lifecycle_details, #lifecycle_state, #locks, #nsg_ids, #routing_method, #subnet_id, #system_tags, #time_created, #time_updated, #vault_id

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Connection

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ RedisConnection

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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

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

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

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

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

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

Instance Attribute Details

#authentication_type ⇒ String

[Required] Authentication type for Redis.

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/golden_gate/models/redis_connection.rb', line 51

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


96
97
98
 
# File 'lib/oci/golden_gate/models/redis_connection.rb', line 96

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) 


90
91
92
 
# File 'lib/oci/golden_gate/models/redis_connection.rb', line 90

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


72
73
74
 
# File 'lib/oci/golden_gate/models/redis_connection.rb', line 72

def password_secret_id
  @password_secret_id
end

#redis_cluster_id ⇒ String

The OCID of the Redis cluster.

Returns:

  • (String) 


63
64
65
 
# File 'lib/oci/golden_gate/models/redis_connection.rb', line 63

def redis_cluster_id
  @redis_cluster_id
end

#security_protocol ⇒ String

[Required] Security protocol for Redis

Returns:

  • (String) 


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

def security_protocol
  @security_protocol
end

#servers ⇒ String

[Required] 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) 


43
44
45
 
# File 'lib/oci/golden_gate/models/redis_connection.rb', line 43

def servers
  @servers
end

#technology_type ⇒ String

[Required] The Redis technology type.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/golden_gate/models/redis_connection.rb', line 35

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


84
85
86
 
# File 'lib/oci/golden_gate/models/redis_connection.rb', line 84

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) 


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

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) 


58
59
60
 
# File 'lib/oci/golden_gate/models/redis_connection.rb', line 58

def username
  @username
end

Class Method Details

.attribute_map ⇒ Object

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



99
100
101
102
103
104
105
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
 
# File 'lib/oci/golden_gate/models/redis_connection.rb', line 99

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'connection_type': :'connectionType',
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'locks': :'locks',
    'vault_id': :'vaultId',
    'key_id': :'keyId',
    'ingress_ips': :'ingressIps',
    'nsg_ids': :'nsgIds',
    'subnet_id': :'subnetId',
    'routing_method': :'routingMethod',
    'does_use_secret_ids': :'doesUseSecretIds',
    'technology_type': :'technologyType',
    'servers': :'servers',
    'security_protocol': :'securityProtocol',
    'authentication_type': :'authenticationType',
    'username': :'username',
    'redis_cluster_id': :'redisClusterId',
    'password_secret_id': :'passwordSecretId',
    'trust_store_secret_id': :'trustStoreSecretId',
    'trust_store_password_secret_id': :'trustStorePasswordSecretId',
    'key_store_secret_id': :'keyStoreSecretId',
    'key_store_password_secret_id': :'keyStorePasswordSecretId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'connection_type': :'String',
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'locks': :'Array<OCI::GoldenGate::Models::ResourceLock>',
    'vault_id': :'String',
    'key_id': :'String',
    'ingress_ips': :'Array<OCI::GoldenGate::Models::IngressIpDetails>',
    'nsg_ids': :'Array<String>',
    'subnet_id': :'String',
    'routing_method': :'String',
    'does_use_secret_ids': :'BOOLEAN',
    'technology_type': :'String',
    'servers': :'String',
    'security_protocol': :'String',
    'authentication_type': :'String',
    'username': :'String',
    'redis_cluster_id': :'String',
    'password_secret_id': :'String',
    'trust_store_secret_id': :'String',
    'trust_store_password_secret_id': :'String',
    'key_store_secret_id': :'String',
    'key_store_password_secret_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



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/oci/golden_gate/models/redis_connection.rb', line 327

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

  self.class == other.class &&
    connection_type == other.connection_type &&
    id == other.id &&
    display_name == other.display_name &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    locks == other.locks &&
    vault_id == other.vault_id &&
    key_id == other.key_id &&
    ingress_ips == other.ingress_ips &&
    nsg_ids == other.nsg_ids &&
    subnet_id == other.subnet_id &&
    routing_method == other.routing_method &&
    does_use_secret_ids == other.does_use_secret_ids &&
    technology_type == other.technology_type &&
    servers == other.servers &&
    security_protocol == other.security_protocol &&
    authentication_type == other.authentication_type &&
    username == other.username &&
    redis_cluster_id == other.redis_cluster_id &&
    password_secret_id == other.password_secret_id &&
    trust_store_secret_id == other.trust_store_secret_id &&
    trust_store_password_secret_id == other.trust_store_password_secret_id &&
    key_store_secret_id == other.key_store_secret_id &&
    key_store_password_secret_id == other.key_store_password_secret_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



387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'lib/oci/golden_gate/models/redis_connection.rb', line 387

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


367
368
369
 
# File 'lib/oci/golden_gate/models/redis_connection.rb', line 367

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



376
377
378
 
# File 'lib/oci/golden_gate/models/redis_connection.rb', line 376

def hash
  [connection_type, id, display_name, description, compartment_id, freeform_tags, defined_tags, system_tags, lifecycle_state, lifecycle_details, time_created, time_updated, locks, vault_id, key_id, ingress_ips, nsg_ids, subnet_id, routing_method, does_use_secret_ids, technology_type, servers, security_protocol, authentication_type, username, redis_cluster_id, password_secret_id, trust_store_secret_id, trust_store_password_secret_id, key_store_secret_id, key_store_password_secret_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



420
421
422
423
424
425
426
427
428
429
 
# File 'lib/oci/golden_gate/models/redis_connection.rb', line 420

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



414
415
416
 
# File 'lib/oci/golden_gate/models/redis_connection.rb', line 414

def to_s
  to_hash.to_s
end