Class: OCI::FileStorage::Models::CreateLdapBindAccountDetails

Inherits:
CreateOutboundConnectorDetails show all
Defined in:
lib/oci/file_storage/models/create_ldap_bind_account_details.rb

Overview

Account details for the LDAP bind account to be used by mount targets that use this outbound connector.

Instance Attribute Summary collapse

Attributes inherited from CreateOutboundConnectorDetails

#availability_domain, #compartment_id, #connector_type, #defined_tags, #display_name, #freeform_tags, #locks

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from CreateOutboundConnectorDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ CreateLdapBindAccountDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
135
136
137
138
139
140
 
# File 'lib/oci/file_storage/models/create_ldap_bind_account_details.rb', line 99

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 bind account.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/file_storage/models/create_ldap_bind_account_details.rb', line 21

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/create_ldap_bind_account_details.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) 


25
26
27
 
# File 'lib/oci/file_storage/models/create_ldap_bind_account_details.rb', line 25

def password_secret_id
  @password_secret_id
end

#password_secret_version ⇒ Integer

Version of the password secret in the Vault to use.

Returns:

  • (Integer) 


29
30
31
 
# File 'lib/oci/file_storage/models/create_ldap_bind_account_details.rb', line 29

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) 


33
34
35
 
# File 'lib/oci/file_storage/models/create_ldap_bind_account_details.rb', line 33

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) 


37
38
39
 
# File 'lib/oci/file_storage/models/create_ldap_bind_account_details.rb', line 37

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.



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'availability_domain': :'availabilityDomain',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'connector_type': :'connectorType',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'locks': :'locks',
    '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.



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/oci/file_storage/models/create_ldap_bind_account_details.rb', line 61

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'availability_domain': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'connector_type': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'locks': :'Array<OCI::FileStorage::Models::ResourceLock>',
    '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



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/oci/file_storage/models/create_ldap_bind_account_details.rb', line 149

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

  self.class == other.class &&
    availability_domain == other.availability_domain &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    connector_type == other.connector_type &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    locks == other.locks &&
    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



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/oci/file_storage/models/create_ldap_bind_account_details.rb', line 191

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


171
172
173
 
# File 'lib/oci/file_storage/models/create_ldap_bind_account_details.rb', line 171

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



180
181
182
 
# File 'lib/oci/file_storage/models/create_ldap_bind_account_details.rb', line 180

def hash
  [availability_domain, compartment_id, display_name, connector_type, freeform_tags, defined_tags, locks, 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



224
225
226
227
228
229
230
231
232
233
 
# File 'lib/oci/file_storage/models/create_ldap_bind_account_details.rb', line 224

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



218
219
220
 
# File 'lib/oci/file_storage/models/create_ldap_bind_account_details.rb', line 218

def to_s
  to_hash.to_s
end