Class: OCI::Database::Models::DatabaseSslConnectionCredentials

Inherits:
DatabaseConnectionCredentials show all
Defined in:
lib/oci/database/models/database_ssl_connection_credentials.rb

Overview

Ssl connection credential details used to connect to the database.

Constant Summary collapse

ROLE_ENUM = 
[
  ROLE_SYSDBA = 'SYSDBA'.freeze,
  ROLE_NORMAL = 'NORMAL'.freeze,
  ROLE_SYSDG = 'SYSDG'.freeze,
  ROLE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Constants inherited from DatabaseConnectionCredentials

OCI::Database::Models::DatabaseConnectionCredentials::CREDENTIAL_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from DatabaseConnectionCredentials

#credential_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from DatabaseConnectionCredentials

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ DatabaseSslConnectionCredentials

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :credential_name (String) —

    The value to assign to the #credential_name property

  • :username (String) —

    The value to assign to the #username property

  • :password (String) —

    The value to assign to the #password property

  • :role (String) —

    The value to assign to the #role property

  • :ssl_secret_id (String) —

    The value to assign to the #ssl_secret_id property



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/oci/database/models/database_ssl_connection_credentials.rb', line 89

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

  attributes['credentialType'] = 'SSL_DETAILS'

  super(attributes)

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

  self.credential_name = attributes[:'credentialName'] if attributes[:'credentialName']

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

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

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

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

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

  self.ssl_secret_id = attributes[:'sslSecretId'] if attributes[:'sslSecretId']

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

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

Instance Attribute Details

#credential_name ⇒ String

The name of the credential information that used to connect to the database. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. IMPORTANT - The name must be unique within the OCI region the credential is being created in. If you specify a name that duplicates the name of another credential within the same OCI region, you may overwrite or corrupt the credential that is already using the name.

For example: inventorydb.abc112233445566778899

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/database/models/database_ssl_connection_credentials.rb', line 32

def credential_name
  @credential_name
end

#password ⇒ String

[Required] The password that will be used to connect to the database.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/database/models/database_ssl_connection_credentials.rb', line 40

def password
  @password
end

#role ⇒ String

[Required] The role of the user that will be connecting to the database.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/database/models/database_ssl_connection_credentials.rb', line 44

def role
  @role
end

#ssl_secret_id ⇒ String

[Required] The OCID of the Oracle Cloud Infrastructure secret.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/database/models/database_ssl_connection_credentials.rb', line 48

def ssl_secret_id
  @ssl_secret_id
end

#username ⇒ String

[Required] The username that will be used to connect to the database.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/database/models/database_ssl_connection_credentials.rb', line 36

def username
  @username
end

Class Method Details

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/oci/database/models/database_ssl_connection_credentials.rb', line 51

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'credential_type': :'credentialType',
    'credential_name': :'credentialName',
    'username': :'username',
    'password': :'password',
    'role': :'role',
    'ssl_secret_id': :'sslSecretId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/oci/database/models/database_ssl_connection_credentials.rb', line 65

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'credential_type': :'String',
    'credential_name': :'String',
    'username': :'String',
    'password': :'String',
    'role': :'String',
    'ssl_secret_id': :'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



138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/oci/database/models/database_ssl_connection_credentials.rb', line 138

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

  self.class == other.class &&
    credential_type == other.credential_type &&
    credential_name == other.credential_name &&
    username == other.username &&
    password == other.password &&
    role == other.role &&
    ssl_secret_id == other.ssl_secret_id
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



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/oci/database/models/database_ssl_connection_credentials.rb', line 173

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


153
154
155
 
# File 'lib/oci/database/models/database_ssl_connection_credentials.rb', line 153

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



162
163
164
 
# File 'lib/oci/database/models/database_ssl_connection_credentials.rb', line 162

def hash
  [credential_type, credential_name, username, password, role, ssl_secret_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



206
207
208
209
210
211
212
213
214
215
 
# File 'lib/oci/database/models/database_ssl_connection_credentials.rb', line 206

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



200
201
202
 
# File 'lib/oci/database/models/database_ssl_connection_credentials.rb', line 200

def to_s
  to_hash.to_s
end