Class: OCI::DatabaseMigration::Models::UpdateConnectionDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database_migration/models/update_connection_details.rb

Overview

The information to update a Connection. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Constant Summary collapse

CONNECTION_TYPE_ENUM = 
[
  CONNECTION_TYPE_MYSQL = 'MYSQL'.freeze,
  CONNECTION_TYPE_ORACLE = 'ORACLE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateConnectionDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :connection_type (String) —

    The value to assign to the #connection_type property

  • :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

  • :vault_id (String) —

    The value to assign to the #vault_id property

  • :key_id (String) —

    The value to assign to the #key_id property

  • :subnet_id (String) —

    The value to assign to the #subnet_id property

  • :nsg_ids (Array<String>) —

    The value to assign to the #nsg_ids property

  • :username (String) —

    The value to assign to the #username property

  • :password (String) —

    The value to assign to the #password property

  • :replication_username (String) —

    The value to assign to the #replication_username property

  • :replication_password (String) —

    The value to assign to the #replication_password property



159
160
161
162
163
164
165
166
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
 
# File 'lib/oci/database_migration/models/update_connection_details.rb', line 159

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

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

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

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

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

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

  self.key_id = attributes[:'keyId'] if attributes[:'keyId']

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

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

  self.subnet_id = attributes[:'subnetId'] if attributes[:'subnetId']

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

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

  self.nsg_ids = attributes[:'nsgIds'] if attributes[:'nsgIds']

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

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

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

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

  self.replication_username = attributes[:'replicationUsername'] if attributes[:'replicationUsername']

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

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

  self.replication_password = attributes[:'replicationPassword'] if attributes[:'replicationPassword']

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

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

Instance Attribute Details

#connection_type ⇒ String

Defines the type of connection. For example, ORACLE.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/database_migration/models/update_connection_details.rb', line 19

def connection_type
  @connection_type
end

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

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


43
44
45
 
# File 'lib/oci/database_migration/models/update_connection_details.rb', line 43

def defined_tags
  @defined_tags
end

#description ⇒ String

A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/database_migration/models/update_connection_details.rb', line 31

def description
  @description
end

#display_name ⇒ String

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/database_migration/models/update_connection_details.rb', line 25

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: "Finance"

Returns:

  • (Hash<String, String>) 


37
38
39
 
# File 'lib/oci/database_migration/models/update_connection_details.rb', line 37

def freeform_tags
  @freeform_tags
end

#key_id ⇒ String

The OCID of the key used in cryptographic operations.

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/database_migration/models/update_connection_details.rb', line 51

def key_id
  @key_id
end

#nsg_ids ⇒ Array<String>

An array of Network Security Group OCIDs used to define network access for Connections.

Returns:

  • (Array<String>) 


60
61
62
 
# File 'lib/oci/database_migration/models/update_connection_details.rb', line 60

def nsg_ids
  @nsg_ids
end

#password ⇒ String

The password (credential) used when creating or updating this resource.

Returns:

  • (String) 


70
71
72
 
# File 'lib/oci/database_migration/models/update_connection_details.rb', line 70

def password
  @password
end

#replication_password ⇒ String

The password (credential) used when creating or updating this resource.

Returns:

  • (String) 


80
81
82
 
# File 'lib/oci/database_migration/models/update_connection_details.rb', line 80

def replication_password
  @replication_password
end

#replication_username ⇒ String

The username (credential) used when creating or updating this resource.

Returns:

  • (String) 


75
76
77
 
# File 'lib/oci/database_migration/models/update_connection_details.rb', line 75

def replication_username
  @replication_username
end

#subnet_id ⇒ String

OCI resource ID.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/database_migration/models/update_connection_details.rb', line 55

def subnet_id
  @subnet_id
end

#username ⇒ String

The username (credential) used when creating or updating this resource.

Returns:

  • (String) 


65
66
67
 
# File 'lib/oci/database_migration/models/update_connection_details.rb', line 65

def username
  @username
end

#vault_id ⇒ String

OCI resource ID.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/database_migration/models/update_connection_details.rb', line 47

def vault_id
  @vault_id
end

Class Method Details

.attribute_map ⇒ Object

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



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/oci/database_migration/models/update_connection_details.rb', line 83

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',
    'subnet_id': :'subnetId',
    'nsg_ids': :'nsgIds',
    'username': :'username',
    'password': :'password',
    'replication_username': :'replicationUsername',
    'replication_password': :'replicationPassword'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



129
130
131
132
133
134
135
136
137
 
# File 'lib/oci/database_migration/models/update_connection_details.rb', line 129

def self.get_subtype(object_hash)
  type = object_hash[:'connectionType'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::DatabaseMigration::Models::UpdateOracleConnectionDetails' if type == 'ORACLE'
  return 'OCI::DatabaseMigration::Models::UpdateMysqlConnectionDetails' if type == 'MYSQL'

  # TODO: Log a warning when the subtype is not found.
  'OCI::DatabaseMigration::Models::UpdateConnectionDetails'
end

.swagger_types ⇒ Object

Attribute type mapping.



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/oci/database_migration/models/update_connection_details.rb', line 104

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',
    'subnet_id': :'String',
    'nsg_ids': :'Array<String>',
    'username': :'String',
    'password': :'String',
    'replication_username': :'String',
    'replication_password': :'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



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/oci/database_migration/models/update_connection_details.rb', line 247

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 &&
    subnet_id == other.subnet_id &&
    nsg_ids == other.nsg_ids &&
    username == other.username &&
    password == other.password &&
    replication_username == other.replication_username &&
    replication_password == other.replication_password
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



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/oci/database_migration/models/update_connection_details.rb', line 289

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


269
270
271
 
# File 'lib/oci/database_migration/models/update_connection_details.rb', line 269

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



278
279
280
 
# File 'lib/oci/database_migration/models/update_connection_details.rb', line 278

def hash
  [connection_type, display_name, description, freeform_tags, defined_tags, vault_id, key_id, subnet_id, nsg_ids, username, password, replication_username, replication_password].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



322
323
324
325
326
327
328
329
330
331
 
# File 'lib/oci/database_migration/models/update_connection_details.rb', line 322

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



316
317
318
 
# File 'lib/oci/database_migration/models/update_connection_details.rb', line 316

def to_s
  to_hash.to_s
end