java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.directoryservicedata.model.DirectoryServiceDataRequest
    - - software.amazon.awssdk.services.directoryservicedata.model.SearchUsersRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<SearchUsersRequest.Builder,SearchUsersRequest>

@Generated("software.amazon.awssdk:codegen")
public final class SearchUsersRequest
extends DirectoryServiceDataRequest
implements ToCopyableBuilder<SearchUsersRequest.Builder,SearchUsersRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface SearchUsersRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static SearchUsersRequest.Builder`	`builder()`
`String`	`directoryId()`	The identifier (ID) of the directory that's associated with the user.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasSearchAttributes()`	For responses, this returns true if the service returned a value for the SearchAttributes property.
`Integer`	`maxResults()`	The maximum number of results to be returned per request.
`String`	`nextToken()`	An encoded paging token for paginated calls that can be passed back to retrieve the next page.
`String`	`realm()`	The domain name that's associated with the user.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`List<String>`	`searchAttributes()`	One or more data attributes that are used to search for a user.
`String`	`searchString()`	The attribute value that you want to search for.
`static Class<? extends SearchUsersRequest.Builder>`	`serializableBuilderClass()`
`SearchUsersRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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
  - directoryId
```
public final String directoryId()
```
    The identifier (ID) of the directory that's associated with the user.
    
    Returns:
    
    The identifier (ID) of the directory that's associated with the user.
  - maxResults
```
public final Integer maxResults()
```
    The maximum number of results to be returned per request.
    
    Returns:
    
    The maximum number of results to be returned per request.
  - nextToken
```
public final String nextToken()
```
    An encoded paging token for paginated calls that can be passed back to retrieve the next page.
    
    Returns:
    
    An encoded paging token for paginated calls that can be passed back to retrieve the next page.
  - realm
```
public final String realm()
```
    The domain name that's associated with the user.
    
    This parameter is optional, so you can return users outside of your Managed Microsoft AD domain. When no value is defined, only your Managed Microsoft AD users are returned.
    
    This value is case insensitive.
    
    Returns:
    
    The domain name that's associated with the user.
    
    This parameter is optional, so you can return users outside of your Managed Microsoft AD domain. When no value is defined, only your Managed Microsoft AD users are returned.
    
    This value is case insensitive.
  - hasSearchAttributes
```
public final boolean hasSearchAttributes()
```
    For responses, this returns true if the service returned a value for the SearchAttributes 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.
  - searchAttributes
```
public final List<String> searchAttributes()
```
    One or more data attributes that are used to search for a user. For a list of supported attributes, see Directory Service Data Attributes.
    
    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 hasSearchAttributes() method.
    
    Returns:
    
    One or more data attributes that are used to search for a user. For a list of supported attributes, see Directory Service Data Attributes.
  - searchString
```
public final String searchString()
```
    The attribute value that you want to search for.
    
    Wildcard (*) searches aren't supported. For a list of supported attributes, see Directory Service Data Attributes.
    
    Returns:
    
    The attribute value that you want to search for.
    
    Wildcard (*) searches aren't supported. For a list of supported attributes, see Directory Service Data Attributes.
  - toBuilder
```
public SearchUsersRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SearchUsersRequest.Builder,SearchUsersRequest>
    
    Specified by:
    
    toBuilder in class DirectoryServiceDataRequest
  - builder
```
public static SearchUsersRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SearchUsersRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class SearchUsersRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

directoryId

maxResults

nextToken

realm

hasSearchAttributes

searchAttributes

searchString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField