Class: OCI::DatabaseTools::Models::CreateDatabaseToolsConnectionOracleDatabaseDetails

Inherits:
CreateDatabaseToolsConnectionDetails show all
Defined in:
lib/oci/database_tools/models/create_database_tools_connection_oracle_database_details.rb

Overview

Details of the new Database Tools connection for an Oracle Database.

Constant Summary collapse

AUTHENTICATION_TYPE_ENUM = 
[
  AUTHENTICATION_TYPE_TOKEN = 'TOKEN'.freeze,
  AUTHENTICATION_TYPE_PASSWORD = 'PASSWORD'.freeze
].freeze

Constants inherited from CreateDatabaseToolsConnectionDetails

OCI::DatabaseTools::Models::CreateDatabaseToolsConnectionDetails::RUNTIME_IDENTITY_ENUM, OCI::DatabaseTools::Models::CreateDatabaseToolsConnectionDetails::RUNTIME_SUPPORT_ENUM, OCI::DatabaseTools::Models::CreateDatabaseToolsConnectionDetails::TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from CreateDatabaseToolsConnectionDetails

#compartment_id, #defined_tags, #display_name, #freeform_tags, #locks, #runtime_identity, #runtime_support, #type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from CreateDatabaseToolsConnectionDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ CreateDatabaseToolsConnectionOracleDatabaseDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



124
125
126
127
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
182
183
184
185
186
187
188
189
 
# File 'lib/oci/database_tools/models/create_database_tools_connection_oracle_database_details.rb', line 124

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

  attributes['type'] = 'ORACLE_DATABASE'

  super(attributes)

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

  self.related_resource = attributes[:'relatedResource'] if attributes[:'relatedResource']

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

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

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

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

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

  self.user_password = attributes[:'userPassword'] if attributes[:'userPassword']

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

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

  self.advanced_properties = attributes[:'advancedProperties'] if attributes[:'advancedProperties']

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

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

  self.key_stores = attributes[:'keyStores'] if attributes[:'keyStores']

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

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

  self.private_endpoint_id = attributes[:'privateEndpointId'] if attributes[:'privateEndpointId']

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

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

  self.proxy_client = attributes[:'proxyClient'] if attributes[:'proxyClient']

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

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

  self.authentication_type = attributes[:'authenticationType'] if attributes[:'authenticationType']
  self.authentication_type = "PASSWORD" if authentication_type.nil? && !attributes.key?(:'authenticationType') # rubocop:disable Style/StringLiterals

  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.authentication_type = "PASSWORD" if authentication_type.nil? && !attributes.key?(:'authenticationType') && !attributes.key?(:'authentication_type') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#advanced_properties ⇒ Hash<String, String>

The advanced connection properties key-value pair (e.g., oracle.net.ssl_server_dn_match).

Returns:

  • (Hash<String, String>) 


33
34
35
 
# File 'lib/oci/database_tools/models/create_database_tools_connection_oracle_database_details.rb', line 33

def advanced_properties
  @advanced_properties
end

#authentication_type ⇒ String

Specifies the authentication type used by the Database Tools service to authenticate with the database.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/database_tools/models/create_database_tools_connection_oracle_database_details.rb', line 50

def authentication_type
  @authentication_type
end

#connection_string ⇒ String

[Required] The connect descriptor or Easy Connect Naming method use to connect to the database.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/database_tools/models/create_database_tools_connection_oracle_database_details.rb', line 22

def connection_string
  @connection_string
end

#key_stores ⇒ Array<OCI::DatabaseTools::Models::DatabaseToolsKeyStoreDetails>

Oracle wallet or Java Keystores containing trusted certificates for authenticating the server's public certificate and the client private key and associated certificates required for client authentication.

Returns:



39
40
41
 
# File 'lib/oci/database_tools/models/create_database_tools_connection_oracle_database_details.rb', line 39

def key_stores
  @key_stores
end

#private_endpoint_id ⇒ String

The OCID of the Database Tools private endpoint used to access the database in the customer VCN.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/database_tools/models/create_database_tools_connection_oracle_database_details.rb', line 43

def private_endpoint_id
  @private_endpoint_id
end

#proxy_client ⇒ OCI::DatabaseTools::Models::DatabaseToolsConnectionOracleDatabaseProxyClientDetails

Returns:



46
47
48
 
# File 'lib/oci/database_tools/models/create_database_tools_connection_oracle_database_details.rb', line 46

def proxy_client
  @proxy_client
end

#related_resource ⇒ OCI::DatabaseTools::Models::CreateDatabaseToolsRelatedResourceDetails

Returns:



18
19
20
 
# File 'lib/oci/database_tools/models/create_database_tools_connection_oracle_database_details.rb', line 18

def related_resource
  @related_resource
end

#user_name ⇒ String

The database user name.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/database_tools/models/create_database_tools_connection_oracle_database_details.rb', line 26

def user_name
  @user_name
end

#user_password ⇒ OCI::DatabaseTools::Models::DatabaseToolsUserPasswordDetails

Returns:



29
30
31
 
# File 'lib/oci/database_tools/models/create_database_tools_connection_oracle_database_details.rb', line 29

def user_password
  @user_password
end

Class Method Details

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/oci/database_tools/models/create_database_tools_connection_oracle_database_details.rb', line 53

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'defined_tags': :'definedTags',
    'freeform_tags': :'freeformTags',
    'locks': :'locks',
    'type': :'type',
    'runtime_support': :'runtimeSupport',
    'runtime_identity': :'runtimeIdentity',
    'related_resource': :'relatedResource',
    'connection_string': :'connectionString',
    'user_name': :'userName',
    'user_password': :'userPassword',
    'advanced_properties': :'advancedProperties',
    'key_stores': :'keyStores',
    'private_endpoint_id': :'privateEndpointId',
    'proxy_client': :'proxyClient',
    'authentication_type': :'authenticationType'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'compartment_id': :'String',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'freeform_tags': :'Hash<String, String>',
    'locks': :'Array<OCI::DatabaseTools::Models::ResourceLock>',
    'type': :'String',
    'runtime_support': :'String',
    'runtime_identity': :'String',
    'related_resource': :'OCI::DatabaseTools::Models::CreateDatabaseToolsRelatedResourceDetails',
    'connection_string': :'String',
    'user_name': :'String',
    'user_password': :'OCI::DatabaseTools::Models::DatabaseToolsUserPasswordDetails',
    'advanced_properties': :'Hash<String, String>',
    'key_stores': :'Array<OCI::DatabaseTools::Models::DatabaseToolsKeyStoreDetails>',
    'private_endpoint_id': :'String',
    'proxy_client': :'OCI::DatabaseTools::Models::DatabaseToolsConnectionOracleDatabaseProxyClientDetails',
    'authentication_type': :'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



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/oci/database_tools/models/create_database_tools_connection_oracle_database_details.rb', line 206

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

  self.class == other.class &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    defined_tags == other.defined_tags &&
    freeform_tags == other.freeform_tags &&
    locks == other.locks &&
    type == other.type &&
    runtime_support == other.runtime_support &&
    runtime_identity == other.runtime_identity &&
    related_resource == other.related_resource &&
    connection_string == other.connection_string &&
    user_name == other.user_name &&
    user_password == other.user_password &&
    advanced_properties == other.advanced_properties &&
    key_stores == other.key_stores &&
    private_endpoint_id == other.private_endpoint_id &&
    proxy_client == other.proxy_client &&
    authentication_type == other.authentication_type
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



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/oci/database_tools/models/create_database_tools_connection_oracle_database_details.rb', line 252

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


232
233
234
 
# File 'lib/oci/database_tools/models/create_database_tools_connection_oracle_database_details.rb', line 232

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



241
242
243
 
# File 'lib/oci/database_tools/models/create_database_tools_connection_oracle_database_details.rb', line 241

def hash
  [display_name, compartment_id, defined_tags, freeform_tags, locks, type, runtime_support, runtime_identity, related_resource, connection_string, user_name, user_password, advanced_properties, key_stores, private_endpoint_id, proxy_client, authentication_type].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



285
286
287
288
289
290
291
292
293
294
 
# File 'lib/oci/database_tools/models/create_database_tools_connection_oracle_database_details.rb', line 285

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



279
280
281
 
# File 'lib/oci/database_tools/models/create_database_tools_connection_oracle_database_details.rb', line 279

def to_s
  to_hash.to_s
end