Class: OCI::GoldenGate::Models::UpdateDatabaseRegistrationDetails

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

Overview

The information to update for a DatabaseRegistration.

Constant Summary collapse

SESSION_MODE_ENUM = 
[
  SESSION_MODE_DIRECT = 'DIRECT'.freeze,
  SESSION_MODE_REDIRECT = 'REDIRECT'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateDatabaseRegistrationDetails

Initializes the object

Options Hash (attributes):

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

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

    The value to assign to the #freeform_tags property

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

    The value to assign to the #defined_tags property

  • :fqdn (String) —

    The value to assign to the #fqdn property

  • :username (String) —

    The value to assign to the #username property

  • :password (String) —

    The value to assign to the #password property

  • :connection_string (String) —

    The value to assign to the #connection_string property

  • :session_mode (String) —

    The value to assign to the #session_mode property

  • :wallet (String) —

    The value to assign to the #wallet property

  • :alias_name (String) —

    The value to assign to the #alias_name property



128
129
130
131
132
133
134
135
136
137
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
175
176
177
178
179
180
181
 
# File 'lib/oci/golden_gate/models/update_database_registration_details.rb', line 128

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

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

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

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

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

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

  self.connection_string = attributes[:'connectionString'] if attributes[:'connectionString']

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

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

  self.session_mode = attributes[:'sessionMode'] if attributes[:'sessionMode']
  self.session_mode = "DIRECT" if session_mode.nil? && !attributes.key?(:'sessionMode') # rubocop:disable Style/StringLiterals

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

  self.session_mode = attributes[:'session_mode'] if attributes[:'session_mode']
  self.session_mode = "DIRECT" if session_mode.nil? && !attributes.key?(:'sessionMode') && !attributes.key?(:'session_mode') # rubocop:disable Style/StringLiterals

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

  self.alias_name = attributes[:'aliasName'] if attributes[:'aliasName']

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

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

Instance Attribute Details

#alias_name ⇒ String

Credential store alias.



71
72
73
 
# File 'lib/oci/golden_gate/models/update_database_registration_details.rb', line 71

def alias_name
  @alias_name
end

#connection_string ⇒ String

Connect descriptor or Easy Connect Naming method that Oracle GoldenGate uses to connect to a database.



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

def connection_string
  @connection_string
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: ‘{"bar-key": "value"}`



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

def defined_tags
  @defined_tags
end

#description ⇒ String

Metadata about this specific object.



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

def description
  @description
end

#display_name ⇒ String

An object’s Display Name.



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

def display_name
  @display_name
end

#fqdn ⇒ String

A three-label Fully Qualified Domain Name (FQDN) for a resource.



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

def fqdn
  @fqdn
end

#freeform_tags ⇒ Hash<String, String>

A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: ‘"value"`



30
31
32
 
# File 'lib/oci/golden_gate/models/update_database_registration_details.rb', line 30

def freeform_tags
  @freeform_tags
end

#password ⇒ String

The password Oracle GoldenGate uses to connect the associated RDBMS. It must conform to the specific security requirements implemented by the database including length, case sensitivity, and so on.



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

def password
  @password
end

#session_mode ⇒ String

The mode of the database connection session to be established by the data client. REDIRECT - for a RAC database, DIRECT - for a non-RAC database. Connection to a RAC database involves a redirection received from the SCAN listeners to the database node to connect to. By default the mode would be DIRECT.



61
62
63
 
# File 'lib/oci/golden_gate/models/update_database_registration_details.rb', line 61

def session_mode
  @session_mode
end

#username ⇒ String

The username Oracle GoldenGate uses to connect the associated RDBMS. This username must already exist and be available for use by the database. It must conform to the security requirements implemented by the database including length, case sensitivity, and so on.



46
47
48
 
# File 'lib/oci/golden_gate/models/update_database_registration_details.rb', line 46

def username
  @username
end

#wallet ⇒ String

The wallet contents Oracle GoldenGate uses to make connections to a database. This attribute is expected to be base64 encoded.



66
67
68
 
# File 'lib/oci/golden_gate/models/update_database_registration_details.rb', line 66

def wallet
  @wallet
end

Class Method Details

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/oci/golden_gate/models/update_database_registration_details.rb', line 74

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'description': :'description',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'fqdn': :'fqdn',
    'username': :'username',
    'password': :'password',
    'connection_string': :'connectionString',
    'session_mode': :'sessionMode',
    'wallet': :'wallet',
    'alias_name': :'aliasName'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/oci/golden_gate/models/update_database_registration_details.rb', line 93

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'description': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'fqdn': :'String',
    'username': :'String',
    'password': :'String',
    'connection_string': :'String',
    'session_mode': :'String',
    'wallet': :'String',
    'alias_name': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/oci/golden_gate/models/update_database_registration_details.rb', line 198

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

  self.class == other.class &&
    display_name == other.display_name &&
    description == other.description &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    fqdn == other.fqdn &&
    username == other.username &&
    password == other.password &&
    connection_string == other.connection_string &&
    session_mode == other.session_mode &&
    wallet == other.wallet &&
    alias_name == other.alias_name
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/oci/golden_gate/models/update_database_registration_details.rb', line 238

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

See Also:

  • `==` method


218
219
220
 
# File 'lib/oci/golden_gate/models/update_database_registration_details.rb', line 218

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



227
228
229
 
# File 'lib/oci/golden_gate/models/update_database_registration_details.rb', line 227

def hash
  [display_name, description, freeform_tags, defined_tags, fqdn, username, password, connection_string, session_mode, wallet, alias_name].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



271
272
273
274
275
276
277
278
279
280
 
# File 'lib/oci/golden_gate/models/update_database_registration_details.rb', line 271

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



265
266
267
 
# File 'lib/oci/golden_gate/models/update_database_registration_details.rb', line 265

def to_s
  to_hash.to_s
end