Class: OCI::DatabaseManagement::Models::DatabaseSecretCredentialDetails

Inherits:
DatabaseCredentialDetails show all
Defined in:
lib/oci/database_management/models/database_secret_credential_details.rb

Overview

User provides a secret OCID, which will be used to retrieve the password to connect to the database.

Constant Summary collapse

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

Constants inherited from DatabaseCredentialDetails

OCI::DatabaseManagement::Models::DatabaseCredentialDetails::CREDENTIAL_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from DatabaseCredentialDetails

#credential_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from DatabaseCredentialDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ DatabaseSecretCredentialDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :password_secret_id (String) —

    The value to assign to the #password_secret_id property

  • :username (String) —

    The value to assign to the #username property

  • :role (String) —

    The value to assign to the #role property



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/oci/database_management/models/database_secret_credential_details.rb', line 67

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

  attributes['credentialType'] = 'SECRET'

  super(attributes)

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

  self.password_secret_id = attributes[:'passwordSecretId'] if attributes[:'passwordSecretId']

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

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

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

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

Instance Attribute Details

#password_secret_id ⇒ String

[Required] The OCID of the Secret where the database password is stored.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/database_management/models/database_secret_credential_details.rb', line 24

def password_secret_id
  @password_secret_id
end

#role ⇒ String

The role of the database user.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/database_management/models/database_secret_credential_details.rb', line 32

def role
  @role
end

#username ⇒ String

The user to connect to the database.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/database_management/models/database_secret_credential_details.rb', line 28

def username
  @username
end

Class Method Details

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
44
 
# File 'lib/oci/database_management/models/database_secret_credential_details.rb', line 35

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'credential_type': :'credentialType',
    'password_secret_id': :'passwordSecretId',
    'username': :'username',
    'role': :'role'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



47
48
49
50
51
52
53
54
55
56
 
# File 'lib/oci/database_management/models/database_secret_credential_details.rb', line 47

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



108
109
110
111
112
113
114
115
116
 
# File 'lib/oci/database_management/models/database_secret_credential_details.rb', line 108

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

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



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/oci/database_management/models/database_secret_credential_details.rb', line 141

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


121
122
123
 
# File 'lib/oci/database_management/models/database_secret_credential_details.rb', line 121

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



130
131
132
 
# File 'lib/oci/database_management/models/database_secret_credential_details.rb', line 130

def hash
  [credential_type, password_secret_id, username, role].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



174
175
176
177
178
179
180
181
182
183
 
# File 'lib/oci/database_management/models/database_secret_credential_details.rb', line 174

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



168
169
170
 
# File 'lib/oci/database_management/models/database_secret_credential_details.rb', line 168

def to_s
  to_hash.to_s
end