Class: OCI::DatabaseManagement::Models::ExternalDatabaseConnectionInfo

Inherits:
ExternalDbSystemConnectionInfo show all
Defined in:
lib/oci/database_management/models/external_database_connection_info.rb

Overview

The details required to connect to an external Oracle Database. It takes either connectionCredentials or databaseCredential. It's recommended to provide databaseCredential

Constant Summary

Constants inherited from ExternalDbSystemConnectionInfo

OCI::DatabaseManagement::Models::ExternalDbSystemConnectionInfo::COMPONENT_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from ExternalDbSystemConnectionInfo

#component_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ExternalDbSystemConnectionInfo

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ ExternalDatabaseConnectionInfo

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
# File 'lib/oci/database_management/models/external_database_connection_info.rb', line 57

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

  attributes['componentType'] = 'DATABASE'

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

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

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

  self.database_credential = attributes[:'databaseCredential'] if attributes[:'databaseCredential']

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

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

Instance Attribute Details

#connection_credentialsOCI::DatabaseManagement::Models::DatabaseConnectionCredentials



19
20
21
# File 'lib/oci/database_management/models/external_database_connection_info.rb', line 19

def connection_credentials
  @connection_credentials
end

#connection_stringOCI::DatabaseManagement::Models::DatabaseConnectionString

This attribute is required.



16
17
18
# File 'lib/oci/database_management/models/external_database_connection_info.rb', line 16

def connection_string
  @connection_string
end

#database_credentialOCI::DatabaseManagement::Models::DatabaseCredentialDetails



22
23
24
# File 'lib/oci/database_management/models/external_database_connection_info.rb', line 22

def database_credential
  @database_credential
end

Class Method Details

.attribute_mapObject

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



25
26
27
28
29
30
31
32
33
34
# File 'lib/oci/database_management/models/external_database_connection_info.rb', line 25

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'component_type': :'componentType',
    'connection_string': :'connectionString',
    'connection_credentials': :'connectionCredentials',
    'database_credential': :'databaseCredential'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



37
38
39
40
41
42
43
44
45
46
# File 'lib/oci/database_management/models/external_database_connection_info.rb', line 37

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'component_type': :'String',
    'connection_string': :'OCI::DatabaseManagement::Models::DatabaseConnectionString',
    'connection_credentials': :'OCI::DatabaseManagement::Models::DatabaseConnectionCredentials',
    'database_credential': :'OCI::DatabaseManagement::Models::DatabaseCredentialDetails'
    # 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



93
94
95
96
97
98
99
100
101
# File 'lib/oci/database_management/models/external_database_connection_info.rb', line 93

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

  self.class == other.class &&
    component_type == other.component_type &&
    connection_string == other.connection_string &&
    connection_credentials == other.connection_credentials &&
    database_credential == other.database_credential
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



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
# File 'lib/oci/database_management/models/external_database_connection_info.rb', line 126

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


106
107
108
# File 'lib/oci/database_management/models/external_database_connection_info.rb', line 106

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



115
116
117
# File 'lib/oci/database_management/models/external_database_connection_info.rb', line 115

def hash
  [component_type, connection_string, connection_credentials, database_credential].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



159
160
161
162
163
164
165
166
167
168
# File 'lib/oci/database_management/models/external_database_connection_info.rb', line 159

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



153
154
155
# File 'lib/oci/database_management/models/external_database_connection_info.rb', line 153

def to_s
  to_hash.to_s
end