UserData (aws-android-sdk-connect 2.81.1 API)

java.lang.Object
- com.amazonaws.services.connect.model.UserData

All Implemented Interfaces:

java.io.Serializable
```
public class UserData
extends java.lang.Object
implements java.io.Serializable
```
Data for a user.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

UserData()

Constructors
Constructor and Description
`UserData()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UserData`	`addActiveSlotsByChannelEntry(java.lang.String key, java.lang.Integer value)` A map of active slots by channel.
`UserData`	`addAvailableSlotsByChannelEntry(java.lang.String key, java.lang.Integer value)` A map of available slots by channel.
`UserData`	`addMaxSlotsByChannelEntry(java.lang.String key, java.lang.Integer value)` A map of maximum slots by channel.
`UserData`	`clearActiveSlotsByChannelEntries()` Removes all the entries added into ActiveSlotsByChannel.
`UserData`	`clearAvailableSlotsByChannelEntries()` Removes all the entries added into AvailableSlotsByChannel.
`UserData`	`clearMaxSlotsByChannelEntries()` Removes all the entries added into MaxSlotsByChannel.
`boolean`	`equals(java.lang.Object obj)`
`java.util.Map<java.lang.String,java.lang.Integer>`	`getActiveSlotsByChannel()` A map of active slots by channel.
`java.util.Map<java.lang.String,java.lang.Integer>`	`getAvailableSlotsByChannel()` A map of available slots by channel.
`java.util.List<AgentContactReference>`	`getContacts()` A list of contact reference information.
`HierarchyPathReference`	`getHierarchyPath()` Contains information about the levels of a hierarchy group assigned to a user.
`java.util.Map<java.lang.String,java.lang.Integer>`	`getMaxSlotsByChannel()` A map of maximum slots by channel.
`java.lang.String`	`getNextStatus()` The Next status of the agent.
`RoutingProfileReference`	`getRoutingProfile()` Information about the routing profile that is assigned to the user.
`AgentStatusReference`	`getStatus()` 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.
`UserReference`	`getUser()` Information about the user for the data that is returned.
`int`	`hashCode()`
`void`	`setActiveSlotsByChannel(java.util.Map<java.lang.String,java.lang.Integer> activeSlotsByChannel)` A map of active slots by channel.
`void`	`setAvailableSlotsByChannel(java.util.Map<java.lang.String,java.lang.Integer> availableSlotsByChannel)` A map of available slots by channel.
`void`	`setContacts(java.util.Collection<AgentContactReference> contacts)` A list of contact reference information.
`void`	`setHierarchyPath(HierarchyPathReference hierarchyPath)` Contains information about the levels of a hierarchy group assigned to a user.
`void`	`setMaxSlotsByChannel(java.util.Map<java.lang.String,java.lang.Integer> maxSlotsByChannel)` A map of maximum slots by channel.
`void`	`setNextStatus(java.lang.String nextStatus)` The Next status of the agent.
`void`	`setRoutingProfile(RoutingProfileReference routingProfile)` Information about the routing profile that is assigned to the user.
`void`	`setStatus(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.
`void`	`setUser(UserReference user)` Information about the user for the data that is returned.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`UserData`	`withActiveSlotsByChannel(java.util.Map<java.lang.String,java.lang.Integer> activeSlotsByChannel)` A map of active slots by channel.
`UserData`	`withAvailableSlotsByChannel(java.util.Map<java.lang.String,java.lang.Integer> availableSlotsByChannel)` A map of available slots by channel.
`UserData`	`withContacts(AgentContactReference... contacts)` A list of contact reference information.
`UserData`	`withContacts(java.util.Collection<AgentContactReference> contacts)` A list of contact reference information.
`UserData`	`withHierarchyPath(HierarchyPathReference hierarchyPath)` Contains information about the levels of a hierarchy group assigned to a user.
`UserData`	`withMaxSlotsByChannel(java.util.Map<java.lang.String,java.lang.Integer> maxSlotsByChannel)` A map of maximum slots by channel.
`UserData`	`withNextStatus(java.lang.String nextStatus)` The Next status of the agent.
`UserData`	`withRoutingProfile(RoutingProfileReference routingProfile)` Information about the routing profile that is assigned to the user.
`UserData`	`withStatus(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`	`withUser(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

- Constructor Detail
  - UserData
```
public UserData()
```
- Method Detail
  - getUser
```
public UserReference getUser()
```
    Information about the user for the data that is returned. It contains the resourceId and ARN of the user.
    
    Returns:
    
    Information about the user for the data that is returned. It contains the resourceId and ARN of the user.
  - setUser
```
public void setUser(UserReference user)
```
    Information about the user for the data that is returned. It contains the resourceId and ARN of the user.
    
    Parameters:
    
    user -
    Information about the user for the data that is returned. It contains the resourceId and ARN of the user.
  - withUser
```
public UserData withUser(UserReference user)
```
    Information about the user for the data that is returned. It contains the resourceId and ARN of the user.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    user -
    Information about the user for the data that is returned. It contains the resourceId and ARN of the user.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getRoutingProfile
```
public RoutingProfileReference getRoutingProfile()
```
    Information about the routing profile that is assigned to the user.
    
    Returns:
    
    Information about the routing profile that is assigned to the user.
  - setRoutingProfile
```
public void setRoutingProfile(RoutingProfileReference routingProfile)
```
    Information about the routing profile that is assigned to the user.
    
    Parameters:
    
    routingProfile -
    Information about the routing profile that is assigned to the user.
  - withRoutingProfile
```
public UserData withRoutingProfile(RoutingProfileReference routingProfile)
```
    Information about the routing profile that is assigned to the user.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    routingProfile -
    Information about the routing profile that is assigned to the user.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getHierarchyPath
```
public HierarchyPathReference getHierarchyPath()
```
    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.
  - setHierarchyPath
```
public void setHierarchyPath(HierarchyPathReference hierarchyPath)
```
    Contains information about the levels of a hierarchy group assigned to a user.
    
    Parameters:
    
    hierarchyPath -
    Contains information about the levels of a hierarchy group assigned to a user.
  - withHierarchyPath
```
public UserData withHierarchyPath(HierarchyPathReference hierarchyPath)
```
    Contains information about the levels of a hierarchy group assigned to a user.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    hierarchyPath -
    Contains information about the levels of a hierarchy group assigned to a user.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getStatus
```
public AgentStatusReference getStatus()
```
    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.
  - setStatus
```
public void setStatus(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.
    
    Parameters:
    
    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.
  - withStatus
```
public UserData withStatus(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 a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getAvailableSlotsByChannel
```
public java.util.Map<java.lang.String,java.lang.Integer> getAvailableSlotsByChannel()
```
    A map of available slots by channel. The key is a channel name. The value is an integer: the available number of slots.
    
    Returns:
    
    A map of available slots by channel. The key is a channel name. The value is an integer: the available number of slots.
  - setAvailableSlotsByChannel
```
public void setAvailableSlotsByChannel(java.util.Map<java.lang.String,java.lang.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.
    
    Parameters:
    
    availableSlotsByChannel -
    A map of available slots by channel. The key is a channel name. The value is an integer: the available number of slots.
  - withAvailableSlotsByChannel
```
public UserData withAvailableSlotsByChannel(java.util.Map<java.lang.String,java.lang.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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    availableSlotsByChannel -
    A map of available slots by channel. The key is a channel name. The value is an integer: the available number of slots.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addAvailableSlotsByChannelEntry
```
public UserData addAvailableSlotsByChannelEntry(java.lang.String key,
                                                java.lang.Integer value)
```
    A map of available slots by channel. The key is a channel name. The value is an integer: the available number of slots.
    
    The method adds a new key-value pair into AvailableSlotsByChannel parameter, and returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    key - The key of the entry to be added into AvailableSlotsByChannel.
    
    value - The corresponding value of the entry to be added into AvailableSlotsByChannel.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - clearAvailableSlotsByChannelEntries
```
public UserData clearAvailableSlotsByChannelEntries()
```
    Removes all the entries added into AvailableSlotsByChannel.
    Returns a reference to this object so that method calls can be chained together.
  - getMaxSlotsByChannel
```
public java.util.Map<java.lang.String,java.lang.Integer> getMaxSlotsByChannel()
```
    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.
    
    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.
  - setMaxSlotsByChannel
```
public void setMaxSlotsByChannel(java.util.Map<java.lang.String,java.lang.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.
    
    Parameters:
    
    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.
  - withMaxSlotsByChannel
```
public UserData withMaxSlotsByChannel(java.util.Map<java.lang.String,java.lang.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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addMaxSlotsByChannelEntry
```
public UserData addMaxSlotsByChannelEntry(java.lang.String key,
                                          java.lang.Integer value)
```
    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.
    
    The method adds a new key-value pair into MaxSlotsByChannel parameter, and returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    key - The key of the entry to be added into MaxSlotsByChannel.
    
    value - The corresponding value of the entry to be added into MaxSlotsByChannel.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - clearMaxSlotsByChannelEntries
```
public UserData clearMaxSlotsByChannelEntries()
```
    Removes all the entries added into MaxSlotsByChannel.
    Returns a reference to this object so that method calls can be chained together.
  - getActiveSlotsByChannel
```
public java.util.Map<java.lang.String,java.lang.Integer> getActiveSlotsByChannel()
```
    A map of active slots by channel. The key is a channel name. The value is an integer: the number of active slots.
    
    Returns:
    
    A map of active slots by channel. The key is a channel name. The value is an integer: the number of active slots.
  - setActiveSlotsByChannel
```
public void setActiveSlotsByChannel(java.util.Map<java.lang.String,java.lang.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.
    
    Parameters:
    
    activeSlotsByChannel -
    A map of active slots by channel. The key is a channel name. The value is an integer: the number of active slots.
  - withActiveSlotsByChannel
```
public UserData withActiveSlotsByChannel(java.util.Map<java.lang.String,java.lang.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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    activeSlotsByChannel -
    A map of active slots by channel. The key is a channel name. The value is an integer: the number of active slots.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addActiveSlotsByChannelEntry
```
public UserData addActiveSlotsByChannelEntry(java.lang.String key,
                                             java.lang.Integer value)
```
    A map of active slots by channel. The key is a channel name. The value is an integer: the number of active slots.
    
    The method adds a new key-value pair into ActiveSlotsByChannel parameter, and returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    key - The key of the entry to be added into ActiveSlotsByChannel.
    
    value - The corresponding value of the entry to be added into ActiveSlotsByChannel.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - clearActiveSlotsByChannelEntries
```
public UserData clearActiveSlotsByChannelEntries()
```
    Removes all the entries added into ActiveSlotsByChannel.
    Returns a reference to this object so that method calls can be chained together.
  - getContacts
```
public java.util.List<AgentContactReference> getContacts()
```
    A list of contact reference information.
    
    Returns:
    
    A list of contact reference information.
  - setContacts
```
public void setContacts(java.util.Collection<AgentContactReference> contacts)
```
    A list of contact reference information.
    
    Parameters:
    
    contacts -
    A list of contact reference information.
  - withContacts
```
public UserData withContacts(AgentContactReference... contacts)
```
    A list of contact reference information.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    contacts -
    A list of contact reference information.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withContacts
```
public UserData withContacts(java.util.Collection<AgentContactReference> contacts)
```
    A list of contact reference information.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    contacts -
    A list of contact reference information.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getNextStatus
```
public java.lang.String getNextStatus()
```
    The Next status of the agent.
    
    Constraints:
    Length: 1 - 127
    
    Returns:
    
    The Next status of the agent.
  - setNextStatus
```
public void setNextStatus(java.lang.String nextStatus)
```
    The Next status of the agent.
    
    Constraints:
    Length: 1 - 127
    
    Parameters:
    
    nextStatus -
    The Next status of the agent.
  - withNextStatus
```
public UserData withNextStatus(java.lang.String nextStatus)
```
    The Next status of the agent.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 127
    
    Parameters:
    
    nextStatus -
    The Next status of the agent.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class UserData

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UserData

Method Detail

getUser

setUser

withUser

getRoutingProfile

setRoutingProfile

withRoutingProfile

getHierarchyPath

setHierarchyPath

withHierarchyPath

getStatus

setStatus

withStatus

getAvailableSlotsByChannel

setAvailableSlotsByChannel

withAvailableSlotsByChannel

addAvailableSlotsByChannelEntry

clearAvailableSlotsByChannelEntries

getMaxSlotsByChannel

setMaxSlotsByChannel

withMaxSlotsByChannel

addMaxSlotsByChannelEntry

clearMaxSlotsByChannelEntries

getActiveSlotsByChannel

setActiveSlotsByChannel

withActiveSlotsByChannel

addActiveSlotsByChannelEntry

clearActiveSlotsByChannelEntries

getContacts

setContacts

withContacts

withContacts

getNextStatus

setNextStatus

withNextStatus

toString

hashCode

equals