Class: OCI::FileStorage::Models::LdapBindAccount

Inherits:
OutboundConnector show all
Defined in:
lib/oci/file_storage/models/ldap_bind_account.rb

Overview

Account details for the LDAP bind account used by the outbound connector.

Constant Summary

Constants inherited from OutboundConnector

OutboundConnector::CONNECTOR_TYPE_ENUM, OutboundConnector::LIFECYCLE_STATE_ENUM

Instance Attribute Summary collapse

Attributes inherited from OutboundConnector

#availability_domain, #compartment_id, #connector_type, #defined_tags, #display_name, #freeform_tags, #id, #lifecycle_state, #locks, #system_tags, #time_created

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from OutboundConnector

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ LdapBindAccount

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/oci/file_storage/models/ldap_bind_account.rb', line 110

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

  attributes['connectorType'] = 'LDAPBIND'

  super(attributes)

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

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

  self.bind_distinguished_name = attributes[:'bindDistinguishedName'] if attributes[:'bindDistinguishedName']

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

  self.bind_distinguished_name = attributes[:'bind_distinguished_name'] if attributes[:'bind_distinguished_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.password_secret_version = attributes[:'passwordSecretVersion'] if attributes[:'passwordSecretVersion']

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

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

  self.trusted_certificate_secret_id = attributes[:'trustedCertificateSecretId'] if attributes[:'trustedCertificateSecretId']

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

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

  self.trusted_certificate_secret_version = attributes[:'trustedCertificateSecretVersion'] if attributes[:'trustedCertificateSecretVersion']

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

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

Instance Attribute Details

#bind_distinguished_name ⇒ String

[Required] The LDAP Distinguished Name of the account.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/file_storage/models/ldap_bind_account.rb', line 20

def bind_distinguished_name
  @bind_distinguished_name
end

#endpoints ⇒ Array<OCI::FileStorage::Models::Endpoint>

[Required] Array of server endpoints to use when connecting with the LDAP bind account.

Returns:



16
17
18
 
# File 'lib/oci/file_storage/models/ldap_bind_account.rb', line 16

def endpoints
  @endpoints
end

#password_secret_id ⇒ String

The OCID of the password for the LDAP bind account in the Vault.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/file_storage/models/ldap_bind_account.rb', line 24

def password_secret_id
  @password_secret_id
end

#password_secret_version ⇒ Integer

Version of the password secret in the Vault to use.

Returns:

  • (Integer) 


28
29
30
 
# File 'lib/oci/file_storage/models/ldap_bind_account.rb', line 28

def password_secret_version
  @password_secret_version
end

#trusted_certificate_secret_id ⇒ String

The OCID of the trusted certificate for the LDAP server in the Vault .

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/file_storage/models/ldap_bind_account.rb', line 32

def trusted_certificate_secret_id
  @trusted_certificate_secret_id
end

#trusted_certificate_secret_version ⇒ Integer

Version of the trusted certificate secret in the Vault to use.

Returns:

  • (Integer) 


36
37
38
 
# File 'lib/oci/file_storage/models/ldap_bind_account.rb', line 36

def trusted_certificate_secret_version
  @trusted_certificate_secret_version
end

Class Method Details

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/oci/file_storage/models/ldap_bind_account.rb', line 39

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'availability_domain': :'availabilityDomain',
    'compartment_id': :'compartmentId',
    'id': :'id',
    'lifecycle_state': :'lifecycleState',
    'display_name': :'displayName',
    'time_created': :'timeCreated',
    'connector_type': :'connectorType',
    'locks': :'locks',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'endpoints': :'endpoints',
    'bind_distinguished_name': :'bindDistinguishedName',
    'password_secret_id': :'passwordSecretId',
    'password_secret_version': :'passwordSecretVersion',
    'trusted_certificate_secret_id': :'trustedCertificateSecretId',
    'trusted_certificate_secret_version': :'trustedCertificateSecretVersion'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'availability_domain': :'String',
    'compartment_id': :'String',
    'id': :'String',
    'lifecycle_state': :'String',
    'display_name': :'String',
    'time_created': :'DateTime',
    'connector_type': :'String',
    'locks': :'Array<OCI::FileStorage::Models::ResourceLock>',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'endpoints': :'Array<OCI::FileStorage::Models::Endpoint>',
    'bind_distinguished_name': :'String',
    'password_secret_id': :'String',
    'password_secret_version': :'Integer',
    'trusted_certificate_secret_id': :'String',
    'trusted_certificate_secret_version': :'Integer'
    # 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



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/file_storage/models/ldap_bind_account.rb', line 160

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

  self.class == other.class &&
    availability_domain == other.availability_domain &&
    compartment_id == other.compartment_id &&
    id == other.id &&
    lifecycle_state == other.lifecycle_state &&
    display_name == other.display_name &&
    time_created == other.time_created &&
    connector_type == other.connector_type &&
    locks == other.locks &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags &&
    endpoints == other.endpoints &&
    bind_distinguished_name == other.bind_distinguished_name &&
    password_secret_id == other.password_secret_id &&
    password_secret_version == other.password_secret_version &&
    trusted_certificate_secret_id == other.trusted_certificate_secret_id &&
    trusted_certificate_secret_version == other.trusted_certificate_secret_version
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



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

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


186
187
188
 
# File 'lib/oci/file_storage/models/ldap_bind_account.rb', line 186

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



195
196
197
 
# File 'lib/oci/file_storage/models/ldap_bind_account.rb', line 195

def hash
  [availability_domain, compartment_id, id, lifecycle_state, display_name, time_created, connector_type, locks, freeform_tags, defined_tags, system_tags, endpoints, bind_distinguished_name, password_secret_id, password_secret_version, trusted_certificate_secret_id, trusted_certificate_secret_version].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



239
240
241
242
243
244
245
246
247
248
 
# File 'lib/oci/file_storage/models/ldap_bind_account.rb', line 239

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



233
234
235
 
# File 'lib/oci/file_storage/models/ldap_bind_account.rb', line 233

def to_s
  to_hash.to_s
end