Class UserDataFilters
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<UserDataFilters.Builder,
UserDataFilters>
A filter for the user data.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionagents()
A list of up to 100 agent IDs or ARNs.static UserDataFilters.Builder
builder()
final ContactFilter
A filter for the user data based on the contact information that is associated to the user.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Agents property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Queues property.final boolean
For responses, this returns true if the service returned a value for the RoutingProfiles property.final boolean
For responses, this returns true if the service returned a value for the UserHierarchyGroups property.queues()
A list of up to 100 queues or ARNs.A list of up to 100 routing profile IDs or ARNs.static Class
<? extends UserDataFilters.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.A UserHierarchyGroup ID or ARN.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 theisEmpty()
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
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
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 theisEmpty()
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
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 theisEmpty()
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
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 theisEmpty()
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<UserDataFilters.Builder,
UserDataFilters> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-