software.amazon.awssdk.services.connect.model

Class UserDataFilters

java.lang.Object

software.amazon.awssdk.services.connect.model.UserDataFilters

All Implemented Interfaces:

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

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

A filter for the user data.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UserDataFilters.Builder

Method Summary

Modifier and Type	Method and Description
List<String>	agents() A list of up to 100 agent IDs or ARNs.
static UserDataFilters.Builder	builder()
ContactFilter	contactFilter() A filter for the user data based on the contact information that is associated to the user.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAgents() For responses, this returns true if the service returned a value for the Agents property.
int	hashCode()
boolean	hasQueues() For responses, this returns true if the service returned a value for the Queues property.
boolean	hasRoutingProfiles() For responses, this returns true if the service returned a value for the RoutingProfiles property.
boolean	hasUserHierarchyGroups() For responses, this returns true if the service returned a value for the UserHierarchyGroups property.
List<String>	queues() A list of up to 100 queues or ARNs.
List<String>	routingProfiles() A list of up to 100 routing profile IDs or ARNs.
List<SdkField<?>>	sdkFields()
static Class<? extends UserDataFilters.Builder>	serializableBuilderClass()
UserDataFilters.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<String>	userHierarchyGroups() A UserHierarchyGroup ID or ARN.

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

hasQueues

public final boolean hasQueues()

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

queues

public final List<String> queues()

A list of up to 100 queues or ARNs.

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 hasQueues() method.

Returns:

A list of up to 100 queues or ARNs.

contactFilter

public final ContactFilter contactFilter()

A filter for the user data based on the contact information that is associated to the user. It contains a list of contact states.

Returns:

A filter for the user data based on the contact information that is associated to the user. It contains a list of contact states.

hasRoutingProfiles

public final boolean hasRoutingProfiles()

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

routingProfiles

public final List<String> routingProfiles()

A list of up to 100 routing profile IDs or ARNs.

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 hasRoutingProfiles() method.

Returns:

A list of up to 100 routing profile IDs or ARNs.

hasAgents

public final boolean hasAgents()

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

agents

public final List<String> agents()

A list of up to 100 agent IDs or ARNs.

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 hasAgents() method.

Returns:

A list of up to 100 agent IDs or ARNs.

hasUserHierarchyGroups

public final boolean hasUserHierarchyGroups()

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

userHierarchyGroups

public final List<String> userHierarchyGroups()

A UserHierarchyGroup ID or ARN.

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 hasUserHierarchyGroups() method.

Returns:

A UserHierarchyGroup ID or ARN.

toBuilder

public UserDataFilters.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UserDataFilters.Builder,UserDataFilters>

builder

public static UserDataFilters.Builder builder()

serializableBuilderClass

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