Class: OCI::Database::Models::AutonomousDatabaseConnectionStrings

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database/models/autonomous_database_connection_strings.rb

Overview

Connection strings to connect to an Oracle Autonomous Database.

Example output for connection strings. See database_connection_string_profile for additional details:

  \"connectionStrings\": {
    \"allConnectionStrings\": {
      \"HIGH\": \"adb.region.oraclecloud.com:1522/unique_id_databasename_high.adwc.oraclecloud.com\",
      \"LOW\": \"adb.region.oraclecloud.com:1522/unique_id_databasename_low.adwc.oraclecloud.com\",
      \"MEDIUM\": \"adb.region.oraclecloud.com:1522/unique_id_databasename_medium.adwc.oraclecloud.com\"
    },
    \"profiles\": [
      {
        \"displayName\": \"databasename_high\",
        \"value\": \"(description= (retry_count=20)(retry_delay=3)(address=(protocol=tcps)(port=1522)(host=adb.region.oraclecloud.com))(connect_data=(service_name=unique_id_databasename_high.adwc.oraclecloud.com))(security=(ssl_server_cert_dn=\"CN=adwc.uscom-east-1.oraclecloud.com,OU=Oracle BMCS US,O=Oracle Corporation,L=Redwood City,ST=California,C=US\")))\",
        \"consumerGroup\": \"HIGH\",
        \"protocol\": \"TCPS\",
        \"tlsAuthentication\": \"MUTUAL\",
        \"hostFormat\": \"FQDN\",
        \"sessionMode\": \"DIRECT\",
        \"syntaxFormat\": \"LONG\"
      },
      {
        \"displayName\": \"databasename_low\",
        \"value\": \"(description= (retry_count=20)(retry_delay=3)(address=(protocol=tcps)(port=1522)(host=adb.region.oraclecloud.com))(connect_data=(service_name=unique_id_databasename_low.adwc.oraclecloud.com))(security=(ssl_server_cert_dn=\"CN=adwc.uscom-east-1.oraclecloud.com,OU=Oracle BMCS US,O=Oracle Corporation,L=Redwood City,ST=California,C=US\")))\",
        \"consumerGroup\": \"LOW\",
        \"protocol\": \"TCPS\",
        \"tlsAuthentication\": \"MUTUAL\",
        \"hostFormat\": \"FQDN\",
        \"sessionMode\": \"DIRECT\",
        \"syntaxFormat\": \"LONG\"
      },
      {
        \"displayName\": \"databasename_medium\",
        \"value\": \"(description= (retry_count=20)(retry_delay=3)(address=(protocol=tcps)(port=1522)(host=adb.region.oraclecloud.com))(connect_data=(service_name=unique_id_databasename_medium.adwc.oraclecloud.com))(security=(ssl_server_cert_dn=\"CN=adwc.uscom-east-1.oraclecloud.com,OU=Oracle BMCS US,O=Oracle Corporation,L=Redwood City,ST=California,C=US\")))\",
        \"consumerGroup\": \"MEDIUM\",
        \"protocol\": \"TCPS\",
        \"tlsAuthentication\": \"MUTUAL\",
        \"hostFormat\": \"FQDN\",
        \"sessionMode\": \"DIRECT\",
        \"syntaxFormat\": \"LONG\"
      }
    ],
    \"dedicated\": null,
    \"high\": \"adb.region.oraclecloud.com:1522/unique_id_databasename_high.adwc.oraclecloud.com\",
    \"low\": \"adb.region.oraclecloud.com:1522/unique_id_databasename_low.adwc.oraclecloud.com\",
    \"medium\": \"adb.region.oraclecloud.com:1522/unique_id_databasename_medium.adwc.oraclecloud.com\"
  }

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AutonomousDatabaseConnectionStrings

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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

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

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

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

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

  self.all_connection_strings = attributes[:'allConnectionStrings'] if attributes[:'allConnectionStrings']

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

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

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

Instance Attribute Details

#all_connection_stringsHash<String, String>

Returns all connection strings that can be used to connect to the Autonomous Database. For more information, please see Predefined Database Service Names for Autonomous Transaction Processing

Returns:

  • (Hash<String, String>)


78
79
80
# File 'lib/oci/database/models/autonomous_database_connection_strings.rb', line 78

def all_connection_strings
  @all_connection_strings
end

#dedicatedString

The database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements.

Returns:

  • (String)


72
73
74
# File 'lib/oci/database/models/autonomous_database_connection_strings.rb', line 72

def dedicated
  @dedicated
end

#highString

The High database service provides the highest level of resources to each SQL statement resulting in the highest performance, but supports the fewest number of concurrent SQL statements.

Returns:

  • (String)


60
61
62
# File 'lib/oci/database/models/autonomous_database_connection_strings.rb', line 60

def high
  @high
end

#lowString

The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements.

Returns:

  • (String)


68
69
70
# File 'lib/oci/database/models/autonomous_database_connection_strings.rb', line 68

def low
  @low
end

#mediumString

The Medium database service provides a lower level of resources to each SQL statement potentially resulting a lower level of performance, but supports more concurrent SQL statements.

Returns:

  • (String)


64
65
66
# File 'lib/oci/database/models/autonomous_database_connection_strings.rb', line 64

def medium
  @medium
end

#profilesArray<OCI::Database::Models::DatabaseConnectionStringProfile>

A list of connection string profiles to allow clients to group, filter and select connection string values based on structured metadata.



83
84
85
# File 'lib/oci/database/models/autonomous_database_connection_strings.rb', line 83

def profiles
  @profiles
end

Class Method Details

.attribute_mapObject

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



86
87
88
89
90
91
92
93
94
95
96
97
# File 'lib/oci/database/models/autonomous_database_connection_strings.rb', line 86

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'high': :'high',
    'medium': :'medium',
    'low': :'low',
    'dedicated': :'dedicated',
    'all_connection_strings': :'allConnectionStrings',
    'profiles': :'profiles'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



100
101
102
103
104
105
106
107
108
109
110
111
# File 'lib/oci/database/models/autonomous_database_connection_strings.rb', line 100

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'high': :'String',
    'medium': :'String',
    'low': :'String',
    'dedicated': :'String',
    'all_connection_strings': :'Hash<String, String>',
    'profiles': :'Array<OCI::Database::Models::DatabaseConnectionStringProfile>'
    # 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



155
156
157
158
159
160
161
162
163
164
165
# File 'lib/oci/database/models/autonomous_database_connection_strings.rb', line 155

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

  self.class == other.class &&
    high == other.high &&
    medium == other.medium &&
    low == other.low &&
    dedicated == other.dedicated &&
    all_connection_strings == other.all_connection_strings &&
    profiles == other.profiles
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



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
# File 'lib/oci/database/models/autonomous_database_connection_strings.rb', line 190

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


170
171
172
# File 'lib/oci/database/models/autonomous_database_connection_strings.rb', line 170

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



179
180
181
# File 'lib/oci/database/models/autonomous_database_connection_strings.rb', line 179

def hash
  [high, medium, low, dedicated, all_connection_strings, profiles].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



223
224
225
226
227
228
229
230
231
232
# File 'lib/oci/database/models/autonomous_database_connection_strings.rb', line 223

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



217
218
219
# File 'lib/oci/database/models/autonomous_database_connection_strings.rb', line 217

def to_s
  to_hash.to_s
end