Class: OCI::DatabaseMigration::Models::UpdateOracleConnectionDetails

Inherits:
UpdateConnectionDetails show all
Defined in:
lib/oci/database_migration/models/update_oracle_connection_details.rb

Overview

The information to update an Oracle Database Connection.

Constant Summary

Constants inherited from UpdateConnectionDetails

OCI::DatabaseMigration::Models::UpdateConnectionDetails::CONNECTION_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from UpdateConnectionDetails

#connection_type, #defined_tags, #description, #display_name, #freeform_tags, #key_id, #nsg_ids, #password, #replication_password, #replication_username, #subnet_id, #username, #vault_id

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from UpdateConnectionDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ UpdateOracleConnectionDetails

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

  • :subnet_id (String) —

    The value to assign to the #subnet_id proprety

  • :nsg_ids (Array<String>) —

    The value to assign to the #nsg_ids proprety

  • :username (String) —

    The value to assign to the #username proprety

  • :password (String) —

    The value to assign to the #password proprety

  • :replication_username (String) —

    The value to assign to the #replication_username proprety

  • :replication_password (String) —

    The value to assign to the #replication_password proprety

  • :connection_string (String) —

    The value to assign to the #connection_string property

  • :wallet (String) —

    The value to assign to the #wallet property

  • :database_id (String) —

    The value to assign to the #database_id property

  • :ssh_host (String) —

    The value to assign to the #ssh_host property

  • :ssh_key (String) —

    The value to assign to the #ssh_key property

  • :ssh_user (String) —

    The value to assign to the #ssh_user property

  • :ssh_sudo_location (String) —

    The value to assign to the #ssh_sudo_location property



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
 
# File 'lib/oci/database_migration/models/update_oracle_connection_details.rb', line 129

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

  attributes['connectionType'] = 'ORACLE'

  super(attributes)

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

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

  self.database_id = attributes[:'databaseId'] if attributes[:'databaseId']

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

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

  self.ssh_host = attributes[:'sshHost'] if attributes[:'sshHost']

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

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

  self.ssh_key = attributes[:'sshKey'] if attributes[:'sshKey']

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

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

  self.ssh_user = attributes[:'sshUser'] if attributes[:'sshUser']

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

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

  self.ssh_sudo_location = attributes[:'sshSudoLocation'] if attributes[:'sshSudoLocation']

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

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

Instance Attribute Details

#connection_string ⇒ String

Connect descriptor or Easy Connect Naming method used to connect to a database.

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/database_migration/models/update_oracle_connection_details.rb', line 15

def connection_string
  @connection_string
end

#database_id ⇒ String

The OCID of the database being referenced.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/database_migration/models/update_oracle_connection_details.rb', line 26

def database_id
  @database_id
end

#ssh_host ⇒ String

Name of the host the SSH key is valid for.

Returns:

  • (String) 


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

def ssh_host
  @ssh_host
end

#ssh_key ⇒ String

Private SSH key string.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/database_migration/models/update_oracle_connection_details.rb', line 36

def ssh_key
  @ssh_key
end

#ssh_sudo_location ⇒ String

Sudo location

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/database_migration/models/update_oracle_connection_details.rb', line 46

def ssh_sudo_location
  @ssh_sudo_location
end

#ssh_user ⇒ String

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

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/database_migration/models/update_oracle_connection_details.rb', line 41

def ssh_user
  @ssh_user
end

#wallet ⇒ String

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

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/database_migration/models/update_oracle_connection_details.rb', line 21

def wallet
  @wallet
end

Class Method Details

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/oci/database_migration/models/update_oracle_connection_details.rb', line 49

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',
    'connection_string': :'connectionString',
    'wallet': :'wallet',
    'database_id': :'databaseId',
    'ssh_host': :'sshHost',
    'ssh_key': :'sshKey',
    'ssh_user': :'sshUser',
    'ssh_sudo_location': :'sshSudoLocation'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/oci/database_migration/models/update_oracle_connection_details.rb', line 77

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',
    'connection_string': :'String',
    'wallet': :'String',
    'database_id': :'String',
    'ssh_host': :'String',
    'ssh_key': :'String',
    'ssh_user': :'String',
    'ssh_sudo_location': :'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



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
 
# File 'lib/oci/database_migration/models/update_oracle_connection_details.rb', line 185

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 &&
    connection_string == other.connection_string &&
    wallet == other.wallet &&
    database_id == other.database_id &&
    ssh_host == other.ssh_host &&
    ssh_key == other.ssh_key &&
    ssh_user == other.ssh_user &&
    ssh_sudo_location == other.ssh_sudo_location
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



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/oci/database_migration/models/update_oracle_connection_details.rb', line 234

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


214
215
216
 
# File 'lib/oci/database_migration/models/update_oracle_connection_details.rb', line 214

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



223
224
225
 
# File 'lib/oci/database_migration/models/update_oracle_connection_details.rb', line 223

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, connection_string, wallet, database_id, ssh_host, ssh_key, ssh_user, ssh_sudo_location].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



267
268
269
270
271
272
273
274
275
276
 
# File 'lib/oci/database_migration/models/update_oracle_connection_details.rb', line 267

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



261
262
263
 
# File 'lib/oci/database_migration/models/update_oracle_connection_details.rb', line 261

def to_s
  to_hash.to_s
end