Class: OCI::DatabaseManagement::Models::PreferredCredentialSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database_management/models/preferred_credential_summary.rb

Overview

The summary of preferred credentials.

Constant Summary collapse

STATUS_ENUM = 
[
  STATUS_SET = 'SET'.freeze,
  STATUS_NOT_SET = 'NOT_SET'.freeze,
  STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
ROLE_ENUM = 
[
  ROLE_NORMAL = 'NORMAL'.freeze,
  ROLE_SYSDBA = 'SYSDBA'.freeze,
  ROLE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PreferredCredentialSummary

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

  • :status (String) —

    The value to assign to the #status property

  • :is_accessible (BOOLEAN) —

    The value to assign to the #is_accessible property

  • :user_name (String) —

    The value to assign to the #user_name property

  • :role (String) —

    The value to assign to the #role property

  • :password_secret_id (String) —

    The value to assign to the #password_secret_id property

  • :named_credential_id (String) —

    The value to assign to the #named_credential_id property



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/oci/database_management/models/preferred_credential_summary.rb', line 95

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

  self.is_accessible = attributes[:'isAccessible'] unless attributes[:'isAccessible'].nil?

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

  self.is_accessible = attributes[:'is_accessible'] unless attributes[:'is_accessible'].nil?

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

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

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

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

Instance Attribute Details

#credential_name ⇒ String

[Required] The name of the preferred credential.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/database_management/models/preferred_credential_summary.rb', line 26

def credential_name
  @credential_name
end

#is_accessible ⇒ BOOLEAN

[Required] Indicates whether the preferred credential is accessible.

Returns:

  • (BOOLEAN) 


34
35
36
 
# File 'lib/oci/database_management/models/preferred_credential_summary.rb', line 34

def is_accessible
  @is_accessible
end

#named_credential_id ⇒ String

The OCID of the Named Credential that contains the database user password metadata.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/database_management/models/preferred_credential_summary.rb', line 50

def named_credential_id
  @named_credential_id
end

#password_secret_id ⇒ String

The OCID of the Vault service secret that contains the database user password.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/database_management/models/preferred_credential_summary.rb', line 46

def password_secret_id
  @password_secret_id
end

#role ⇒ String

The role of the database user.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/database_management/models/preferred_credential_summary.rb', line 42

def role
  @role
end

#status ⇒ String

[Required] The status of the preferred credential.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/database_management/models/preferred_credential_summary.rb', line 30

def status
  @status
end

#user_name ⇒ String

The user name used to connect to the database.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/database_management/models/preferred_credential_summary.rb', line 38

def user_name
  @user_name
end

Class Method Details

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/oci/database_management/models/preferred_credential_summary.rb', line 53

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'credential_name': :'credentialName',
    'status': :'status',
    'is_accessible': :'isAccessible',
    'user_name': :'userName',
    'role': :'role',
    'password_secret_id': :'passwordSecretId',
    'named_credential_id': :'namedCredentialId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/oci/database_management/models/preferred_credential_summary.rb', line 68

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'credential_name': :'String',
    'status': :'String',
    'is_accessible': :'BOOLEAN',
    'user_name': :'String',
    'role': :'String',
    'password_secret_id': :'String',
    'named_credential_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



169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/oci/database_management/models/preferred_credential_summary.rb', line 169

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

  self.class == other.class &&
    credential_name == other.credential_name &&
    status == other.status &&
    is_accessible == other.is_accessible &&
    user_name == other.user_name &&
    role == other.role &&
    password_secret_id == other.password_secret_id &&
    named_credential_id == other.named_credential_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



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/oci/database_management/models/preferred_credential_summary.rb', line 205

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


185
186
187
 
# File 'lib/oci/database_management/models/preferred_credential_summary.rb', line 185

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



194
195
196
 
# File 'lib/oci/database_management/models/preferred_credential_summary.rb', line 194

def hash
  [credential_name, status, is_accessible, user_name, role, password_secret_id, named_credential_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



238
239
240
241
242
243
244
245
246
247
 
# File 'lib/oci/database_management/models/preferred_credential_summary.rb', line 238

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



232
233
234
 
# File 'lib/oci/database_management/models/preferred_credential_summary.rb', line 232

def to_s
  to_hash.to_s
end