UserData (AWS Java SDK :: Services :: Connect 2.17.257 API)

java.lang.Object
- software.amazon.awssdk.services.connect.model.UserData

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<UserData.Builder,UserData>

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

Data for a user.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface UserData.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`UserData.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Map<Channel,Integer>`	`activeSlotsByChannel()` A map of active slots by channel.
`Map<String,Integer>`	`activeSlotsByChannelAsStrings()` A map of active slots by channel.
`Map<Channel,Integer>`	`availableSlotsByChannel()` A map of available slots by channel.
`Map<String,Integer>`	`availableSlotsByChannelAsStrings()` A map of available slots by channel.
`static UserData.Builder`	`builder()`
`List<AgentContactReference>`	`contacts()` A list of contact reference information.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasActiveSlotsByChannel()` For responses, this returns true if the service returned a value for the ActiveSlotsByChannel property.
`boolean`	`hasAvailableSlotsByChannel()` For responses, this returns true if the service returned a value for the AvailableSlotsByChannel property.
`boolean`	`hasContacts()` For responses, this returns true if the service returned a value for the Contacts property.
`int`	`hashCode()`
`boolean`	`hasMaxSlotsByChannel()` For responses, this returns true if the service returned a value for the MaxSlotsByChannel property.
`HierarchyPathReference`	`hierarchyPath()` Contains information about the levels of a hierarchy group assigned to a user.
`Map<Channel,Integer>`	`maxSlotsByChannel()` A map of maximum slots by channel.
`Map<String,Integer>`	`maxSlotsByChannelAsStrings()` A map of maximum slots by channel.
`RoutingProfileReference`	`routingProfile()` Information about the routing profile that is assigned to the user.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends UserData.Builder>`	`serializableBuilderClass()`
`AgentStatusReference`	`status()` The status of the agent that they manually set in their Contact Control Panel (CCP), or that the supervisor manually changes in the real-time metrics report.
`UserData.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`UserReference`	`user()` Information about the user for the data that is returned.

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
  - user
```
public final UserReference user()
```
    Information about the user for the data that is returned. It contains resourceId and ARN of the user.
    
    Returns:
    
    Information about the user for the data that is returned. It contains resourceId and ARN of the user.
  - routingProfile
```
public final RoutingProfileReference routingProfile()
```
    Information about the routing profile that is assigned to the user.
    
    Returns:
    
    Information about the routing profile that is assigned to the user.
  - hierarchyPath
```
public final HierarchyPathReference hierarchyPath()
```
    Contains information about the levels of a hierarchy group assigned to a user.
    
    Returns:
    
    Contains information about the levels of a hierarchy group assigned to a user.
  - status
```
public final AgentStatusReference status()
```
    The status of the agent that they manually set in their Contact Control Panel (CCP), or that the supervisor manually changes in the real-time metrics report.
    
    Returns:
    
    The status of the agent that they manually set in their Contact Control Panel (CCP), or that the supervisor manually changes in the real-time metrics report.
  - availableSlotsByChannel
```
public final Map<Channel,Integer> availableSlotsByChannel()
```
    A map of available slots by channel. The key is a channel name. The value is an integer: the available number of slots.
    
    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 hasAvailableSlotsByChannel() method.
    
    Returns:
    
    A map of available slots by channel. The key is a channel name. The value is an integer: the available number of slots.
  - hasAvailableSlotsByChannel
```
public final boolean hasAvailableSlotsByChannel()
```
    For responses, this returns true if the service returned a value for the AvailableSlotsByChannel 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.
  - availableSlotsByChannelAsStrings
```
public final Map<String,Integer> availableSlotsByChannelAsStrings()
```
    A map of available slots by channel. The key is a channel name. The value is an integer: the available number of slots.
    
    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 hasAvailableSlotsByChannel() method.
    
    Returns:
    
    A map of available slots by channel. The key is a channel name. The value is an integer: the available number of slots.
  - maxSlotsByChannel
```
public final Map<Channel,Integer> maxSlotsByChannel()
```
    A map of maximum slots by channel. The key is a channel name. The value is an integer: the maximum number of slots. This is calculated from MediaConcurrency of the RoutingProfile assigned to the agent.
    
    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 hasMaxSlotsByChannel() method.
    
    Returns:
    
    A map of maximum slots by channel. The key is a channel name. The value is an integer: the maximum number of slots. This is calculated from MediaConcurrency of the RoutingProfile assigned to the agent.
  - hasMaxSlotsByChannel
```
public final boolean hasMaxSlotsByChannel()
```
    For responses, this returns true if the service returned a value for the MaxSlotsByChannel 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.
  - maxSlotsByChannelAsStrings
```
public final Map<String,Integer> maxSlotsByChannelAsStrings()
```
    A map of maximum slots by channel. The key is a channel name. The value is an integer: the maximum number of slots. This is calculated from MediaConcurrency of the RoutingProfile assigned to the agent.
    
    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 hasMaxSlotsByChannel() method.
    
    Returns:
    
    A map of maximum slots by channel. The key is a channel name. The value is an integer: the maximum number of slots. This is calculated from MediaConcurrency of the RoutingProfile assigned to the agent.
  - activeSlotsByChannel
```
public final Map<Channel,Integer> activeSlotsByChannel()
```
    A map of active slots by channel. The key is a channel name. The value is an integer: the number of active slots.
    
    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 hasActiveSlotsByChannel() method.
    
    Returns:
    
    A map of active slots by channel. The key is a channel name. The value is an integer: the number of active slots.
  - hasActiveSlotsByChannel
```
public final boolean hasActiveSlotsByChannel()
```
    For responses, this returns true if the service returned a value for the ActiveSlotsByChannel 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.
  - activeSlotsByChannelAsStrings
```
public final Map<String,Integer> activeSlotsByChannelAsStrings()
```
    A map of active slots by channel. The key is a channel name. The value is an integer: the number of active slots.
    
    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 hasActiveSlotsByChannel() method.
    
    Returns:
    
    A map of active slots by channel. The key is a channel name. The value is an integer: the number of active slots.
  - hasContacts
```
public final boolean hasContacts()
```
    For responses, this returns true if the service returned a value for the Contacts 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.
  - contacts
```
public final List<AgentContactReference> contacts()
```
    A list of contact reference information.
    
    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 hasContacts() method.
    
    Returns:
    
    A list of contact reference information.
  - toBuilder
```
public UserData.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UserData.Builder,UserData>
  - builder
```
public static UserData.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends UserData.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

Class UserData

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

user

routingProfile

hierarchyPath

status

availableSlotsByChannel

hasAvailableSlotsByChannel

availableSlotsByChannelAsStrings

maxSlotsByChannel

hasMaxSlotsByChannel

maxSlotsByChannelAsStrings

activeSlotsByChannel

hasActiveSlotsByChannel

activeSlotsByChannelAsStrings

hasContacts

contacts

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields