java.lang.Object
- software.amazon.awssdk.services.mq.model.LdapServerMetadataInput

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<LdapServerMetadataInput.Builder,LdapServerMetadataInput>
```
@Generated("software.amazon.awssdk:codegen")
public final class LdapServerMetadataInput
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<LdapServerMetadataInput.Builder,LdapServerMetadataInput>
```
Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker.

Does not apply to RabbitMQ brokers.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface LdapServerMetadataInput.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static LdapServerMetadataInput.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasHosts()`	For responses, this returns true if the service returned a value for the Hosts property.
`List<String>`	`hosts()`	Specifies the location of the LDAP server such as Directory Service for Microsoft Active Directory.
`String`	`roleBase()`	The distinguished name of the node in the directory information tree (DIT) to search for roles or groups.
`String`	`roleName()`	Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
`String`	`roleSearchMatching()`	The LDAP search filter used to find roles within the roleBase.
`Boolean`	`roleSearchSubtree()`	The directory search scope for the role.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends LdapServerMetadataInput.Builder>`	`serializableBuilderClass()`
`String`	`serviceAccountPassword()`	Service account password.
`String`	`serviceAccountUsername()`	Service account username.
`LdapServerMetadataInput.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`userBase()`	Select a particular subtree of the directory information tree (DIT) to search for user entries.
`String`	`userRoleName()`	Specifies the name of the LDAP attribute for the user group membership.
`String`	`userSearchMatching()`	The LDAP search filter used to find users within the userBase.
`Boolean`	`userSearchSubtree()`	The directory search scope for the user.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - hasHosts
```
public final boolean hasHosts()
```
    For responses, this returns true if the service returned a value for the Hosts property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - hosts
```
public final List<String> hosts()
```
    Specifies the location of the LDAP server such as Directory Service for Microsoft Active Directory. Optional failover server.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasHosts() method.
    
    Returns:
    
    Specifies the location of the LDAP server such as Directory Service for Microsoft Active Directory. Optional failover server.
  - roleBase
```
public final String roleBase()
```
    The distinguished name of the node in the directory information tree (DIT) to search for roles or groups. For example, ou=group, ou=corp, dc=corp, dc=example, dc=com.
    
    Returns:
    
    The distinguished name of the node in the directory information tree (DIT) to search for roles or groups. For example, ou=group, ou=corp, dc=corp, dc=example, dc=com.
  - roleName
```
public final String roleName()
```
    Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
    
    Returns:
    
    Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
  - roleSearchMatching
```
public final String roleSearchMatching()
```
    The LDAP search filter used to find roles within the roleBase. The distinguished name of the user matched by userSearchMatching is substituted into the {0} placeholder in the search filter. The client's username is substituted into the {1} placeholder. For example, if you set this option to (member=uid={1})for the user janedoe, the search filter becomes (member=uid=janedoe) after string substitution. It matches all role entries that have a member attribute equal to uid=janedoe under the subtree selected by the roleBase.
    
    Returns:
    
    The LDAP search filter used to find roles within the roleBase. The distinguished name of the user matched by userSearchMatching is substituted into the {0} placeholder in the search filter. The client's username is substituted into the {1} placeholder. For example, if you set this option to (member=uid={1})for the user janedoe, the search filter becomes (member=uid=janedoe) after string substitution. It matches all role entries that have a member attribute equal to uid=janedoe under the subtree selected by the roleBase.
  - roleSearchSubtree
```
public final Boolean roleSearchSubtree()
```
    The directory search scope for the role. If set to true, scope is to search the entire subtree.
    
    Returns:
    
    The directory search scope for the role. If set to true, scope is to search the entire subtree.
  - serviceAccountPassword
```
public final String serviceAccountPassword()
```
    Service account password. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin,dc=corp, dc=example, dc=com.
    
    Returns:
    
    Service account password. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin,dc=corp, dc=example, dc=com.
  - serviceAccountUsername
```
public final String serviceAccountUsername()
```
    Service account username. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin,dc=corp, dc=example, dc=com.
    
    Returns:
    
    Service account username. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin,dc=corp, dc=example, dc=com.
  - userBase
```
public final String userBase()
```
    Select a particular subtree of the directory information tree (DIT) to search for user entries. The subtree is specified by a DN, which specifies the base node of the subtree. For example, by setting this option to ou=Users,ou=corp, dc=corp, dc=example, dc=com, the search for user entries is restricted to the subtree beneath ou=Users, ou=corp, dc=corp, dc=example, dc=com.
    
    Returns:
    
    Select a particular subtree of the directory information tree (DIT) to search for user entries. The subtree is specified by a DN, which specifies the base node of the subtree. For example, by setting this option to ou=Users,ou=corp, dc=corp, dc=example, dc=com, the search for user entries is restricted to the subtree beneath ou=Users, ou=corp, dc=corp, dc=example, dc=com.
  - userRoleName
```
public final String userRoleName()
```
    Specifies the name of the LDAP attribute for the user group membership.
    
    Returns:
    
    Specifies the name of the LDAP attribute for the user group membership.
  - userSearchMatching
```
public final String userSearchMatching()
```
    The LDAP search filter used to find users within the userBase. The client's username is substituted into the {0} placeholder in the search filter. For example, if this option is set to (uid={0}) and the received username is janedoe, the search filter becomes (uid=janedoe) after string substitution. It will result in matching an entry like uid=janedoe, ou=Users,ou=corp, dc=corp, dc=example, dc=com.
    
    Returns:
    
    The LDAP search filter used to find users within the userBase. The client's username is substituted into the {0} placeholder in the search filter. For example, if this option is set to (uid={0}) and the received username is janedoe, the search filter becomes (uid=janedoe) after string substitution. It will result in matching an entry like uid=janedoe, ou=Users,ou=corp, dc=corp, dc=example, dc=com.
  - userSearchSubtree
```
public final Boolean userSearchSubtree()
```
    The directory search scope for the user. If set to true, scope is to search the entire subtree.
    
    Returns:
    
    The directory search scope for the user. If set to true, scope is to search the entire subtree.
  - toBuilder
```
public LdapServerMetadataInput.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<LdapServerMetadataInput.Builder,LdapServerMetadataInput>
  - builder
```
public static LdapServerMetadataInput.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends LdapServerMetadataInput.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class LdapServerMetadataInput

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

hasHosts

hosts

roleBase

roleName

roleSearchMatching

roleSearchSubtree

serviceAccountPassword

serviceAccountUsername

userBase

userRoleName

userSearchMatching

userSearchSubtree

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields