Package software.amazon.awssdk.services.directoryservicedata.model

Class DescribeUserRequest

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.DescribeUserRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeUserRequest.Builder,DescribeUserRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeUserRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeUserRequest.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	hasOtherAttributes()	For responses, this returns true if the service returned a value for the OtherAttributes property.
List<String>	otherAttributes()	One or more attribute names to be returned for the user.
String	realm()	The domain name that's associated with the user.
String	samAccountName()	The name of the user.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeUserRequest.Builder>	serializableBuilderClass()
DescribeUserRequest.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.

hasOtherAttributes

public final boolean hasOtherAttributes()

For responses, this returns true if the service returned a value for the OtherAttributes 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.

otherAttributes

public final List<String> otherAttributes()

One or more attribute names to be returned for the user. A key is an attribute name, and the value is a list of maps. 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 hasOtherAttributes() method.

Returns:

One or more attribute names to be returned for the user. A key is an attribute name, and the value is a list of maps. For a list of supported attributes, see Directory Service Data Attributes.

realm

public final String realm()

The domain name that's associated with the user.

This parameter is optional, so you can return users outside 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 your Managed Microsoft AD domain. When no value is defined, only your Managed Microsoft AD users are returned.

This value is case insensitive.

samAccountName

public final String samAccountName()

The name of the user.

Returns:

The name of the user.

toBuilder

public DescribeUserRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeUserRequest.Builder,DescribeUserRequest>

Specified by:

toBuilder in class DirectoryServiceDataRequest

builder

public static DescribeUserRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeUserRequest.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