Class: OCI::Opsi::Models::CredentialByVault

Inherits:
CredentialDetails show all
Defined in:
lib/oci/opsi/models/credential_by_vault.rb

Overview

Vault Credential Details to connect to the database.

Constant Summary collapse

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

Constants inherited from CredentialDetails

OCI::Opsi::Models::CredentialDetails::CREDENTIAL_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from CredentialDetails

#credential_source_name, #credential_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from CredentialDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ CredentialByVault

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :credential_source_name (String) —

    The value to assign to the #credential_source_name proprety

  • :user_name (String) —

    The value to assign to the #user_name property

  • :password_secret_id (String) —

    The value to assign to the #password_secret_id property

  • :wallet_secret_id (String) —

    The value to assign to the #wallet_secret_id property

  • :role (String) —

    The value to assign to the #role property

[View source]

73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/oci/opsi/models/credential_by_vault.rb', line 73

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

  attributes['credentialType'] = 'CREDENTIALS_BY_VAULT'

  super(attributes)

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

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

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

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

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

Instance Attribute Details

#password_secret_id ⇒ String

The secret OCID mapping to the database credentials.

Returns:

  • (String) 

24
25
26
 
# File 'lib/oci/opsi/models/credential_by_vault.rb', line 24

def password_secret_id
  @password_secret_id
end

#role ⇒ String

database user role.

Returns:

  • (String) 

32
33
34
 
# File 'lib/oci/opsi/models/credential_by_vault.rb', line 32

def role
  @role
end

#user_name ⇒ String

database user name.

Returns:

  • (String) 

20
21
22
 
# File 'lib/oci/opsi/models/credential_by_vault.rb', line 20

def user_name
  @user_name
end

#wallet_secret_id ⇒ String

The OCID of the Secret where the database keystore contents are stored. This is used for TCPS support in BM/VM/ExaCS cases.

Returns:

  • (String) 

28
29
30
 
# File 'lib/oci/opsi/models/credential_by_vault.rb', line 28

def wallet_secret_id
  @wallet_secret_id
end

Class Method Details

.attribute_map ⇒ Object

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

[View source]

35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/oci/opsi/models/credential_by_vault.rb', line 35

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'credential_source_name': :'credentialSourceName',
    'credential_type': :'credentialType',
    'user_name': :'userName',
    'password_secret_id': :'passwordSecretId',
    'wallet_secret_id': :'walletSecretId',
    'role': :'role'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.

[View source]

49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/oci/opsi/models/credential_by_vault.rb', line 49

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

[View source]

124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/oci/opsi/models/credential_by_vault.rb', line 124

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

  self.class == other.class &&
    credential_source_name == other.credential_source_name &&
    credential_type == other.credential_type &&
    user_name == other.user_name &&
    password_secret_id == other.password_secret_id &&
    wallet_secret_id == other.wallet_secret_id &&
    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

[View source]

159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/oci/opsi/models/credential_by_vault.rb', line 159

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
[View source]

139
140
141
 
# File 'lib/oci/opsi/models/credential_by_vault.rb', line 139

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code

[View source]

148
149
150
 
# File 'lib/oci/opsi/models/credential_by_vault.rb', line 148

def hash
  [credential_source_name, credential_type, user_name, password_secret_id, wallet_secret_id, role].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash

[View source]

192
193
194
195
196
197
198
199
200
201
 
# File 'lib/oci/opsi/models/credential_by_vault.rb', line 192

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

[View source]

186
187
188
 
# File 'lib/oci/opsi/models/credential_by_vault.rb', line 186

def to_s
  to_hash.to_s
end