Package software.amazon.awssdk.services.workmail.model

Class ListUsersFilters

java.lang.Object

software.amazon.awssdk.services.workmail.model.ListUsersFilters

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ListUsersFilters.Builder,ListUsersFilters>

@Generated("software.amazon.awssdk:codegen")
public final class ListUsersFilters
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ListUsersFilters.Builder,ListUsersFilters>

Filtering options for ListUsers operation. This is only used as input to Operation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListUsersFilters.Builder

Method Summary

Modifier and Type	Method	Description
static ListUsersFilters.Builder	builder()
String	displayNamePrefix()	Filters only users with the provided display name prefix.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	primaryEmailPrefix()	Filters only users with the provided email prefix.
List<SdkField<?>>	sdkFields()
static Class<? extends ListUsersFilters.Builder>	serializableBuilderClass()
EntityState	state()	Filters only users with the provided state.
String	stateAsString()	Filters only users with the provided state.
ListUsersFilters.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	usernamePrefix()	Filters only users with the provided username prefix.

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

usernamePrefix

public final String usernamePrefix()

Filters only users with the provided username prefix.

Returns:

Filters only users with the provided username prefix.

displayNamePrefix

public final String displayNamePrefix()

Filters only users with the provided display name prefix.

Returns:

Filters only users with the provided display name prefix.

primaryEmailPrefix

public final String primaryEmailPrefix()

Filters only users with the provided email prefix.

Returns:

Filters only users with the provided email prefix.

state

public final EntityState state()

Filters only users with the provided state.

If the service returns an enum value that is not available in the current SDK version, state will return EntityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

Filters only users with the provided state.

See Also:

EntityState

stateAsString

public final String stateAsString()

Filters only users with the provided state.

If the service returns an enum value that is not available in the current SDK version, state will return EntityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

Filters only users with the provided state.

See Also:

EntityState

toBuilder

public ListUsersFilters.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListUsersFilters.Builder,ListUsersFilters>

builder

public static ListUsersFilters.Builder builder()

serializableBuilderClass

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