UserData (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UserData
extends Object
implements Serializable, Cloneable, StructuredPojo

Data for a user.

See Also:: AWS API Documentation, 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(String key, Integer value)` Add a single ActiveSlotsByChannel entry
`UserData`	`addAvailableSlotsByChannelEntry(String key, Integer value)` Add a single AvailableSlotsByChannel entry
`UserData`	`addMaxSlotsByChannelEntry(String key, Integer value)` Add a single MaxSlotsByChannel entry
`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.
`UserData`	`clone()`
`boolean`	`equals(Object obj)`
`Map<String,Integer>`	`getActiveSlotsByChannel()` A map of active slots by channel.
`Map<String,Integer>`	`getAvailableSlotsByChannel()` A map of available slots by channel.
`List<AgentContactReference>`	`getContacts()` A list of contact reference information.
`HierarchyPathReference`	`getHierarchyPath()` Contains information about the levels of a hierarchy group assigned to a user.
`Map<String,Integer>`	`getMaxSlotsByChannel()` A map of maximum slots by channel.
`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`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setActiveSlotsByChannel(Map<String,Integer> activeSlotsByChannel)` A map of active slots by channel.
`void`	`setAvailableSlotsByChannel(Map<String,Integer> availableSlotsByChannel)` A map of available slots by channel.
`void`	`setContacts(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(Map<String,Integer> maxSlotsByChannel)` A map of maximum slots by channel.
`void`	`setNextStatus(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.
`String`	`toString()` Returns a string representation of this object.
`UserData`	`withActiveSlotsByChannel(Map<String,Integer> activeSlotsByChannel)` A map of active slots by channel.
`UserData`	`withAvailableSlotsByChannel(Map<String,Integer> availableSlotsByChannel)` A map of available slots by channel.
`UserData`	`withContacts(AgentContactReference... contacts)` A list of contact reference information.
`UserData`	`withContacts(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(Map<String,Integer> maxSlotsByChannel)` A map of maximum slots by channel.
`UserData`	`withNextStatus(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
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - UserData
```
public UserData()
```
- Method Detail
  - 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.
  - 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.
  - 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.
    
    Parameters:
    
    user - Information about the user for the data that is returned. It contains the resourceId and ARN of the user.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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.
  - 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.
  - withRoutingProfile
```
public UserData withRoutingProfile(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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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.
  - 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.
  - withHierarchyPath
```
public UserData withHierarchyPath(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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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.
  - 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.
  - 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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAvailableSlotsByChannel
```
public Map<String,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(Map<String,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(Map<String,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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addAvailableSlotsByChannelEntry
```
public UserData addAvailableSlotsByChannelEntry(String key,
                                                Integer value)
```
    Add a single AvailableSlotsByChannel entry
    
    See Also:
    
    withAvailableSlotsByChannel(java.util.Map<java.lang.String, java.lang.Integer>)
  - clearAvailableSlotsByChannelEntries
```
public UserData clearAvailableSlotsByChannelEntries()
```
    Removes all the entries added into AvailableSlotsByChannel.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getMaxSlotsByChannel
```
public Map<String,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(Map<String,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(Map<String,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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addMaxSlotsByChannelEntry
```
public UserData addMaxSlotsByChannelEntry(String key,
                                          Integer value)
```
    Add a single MaxSlotsByChannel entry
    
    See Also:
    
    withMaxSlotsByChannel(java.util.Map<java.lang.String, java.lang.Integer>)
  - clearMaxSlotsByChannelEntries
```
public UserData clearMaxSlotsByChannelEntries()
```
    Removes all the entries added into MaxSlotsByChannel.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getActiveSlotsByChannel
```
public Map<String,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(Map<String,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(Map<String,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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addActiveSlotsByChannelEntry
```
public UserData addActiveSlotsByChannelEntry(String key,
                                             Integer value)
```
    Add a single ActiveSlotsByChannel entry
    
    See Also:
    
    withActiveSlotsByChannel(java.util.Map<java.lang.String, java.lang.Integer>)
  - clearActiveSlotsByChannelEntries
```
public UserData clearActiveSlotsByChannelEntries()
```
    Removes all the entries added into ActiveSlotsByChannel.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getContacts
```
public List<AgentContactReference> getContacts()
```
    A list of contact reference information.
    
    Returns:
    
    A list of contact reference information.
  - setContacts
```
public void setContacts(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setContacts(java.util.Collection) or withContacts(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    contacts - A list of contact reference information.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withContacts
```
public UserData withContacts(Collection<AgentContactReference> contacts)
```
    A list of contact reference information.
    
    Parameters:
    
    contacts - A list of contact reference information.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNextStatus
```
public void setNextStatus(String nextStatus)
```
    The Next status of the agent.
    
    Parameters:
    
    nextStatus - The Next status of the agent.
  - getNextStatus
```
public String getNextStatus()
```
    The Next status of the agent.
    
    Returns:
    
    The Next status of the agent.
  - withNextStatus
```
public UserData withNextStatus(String nextStatus)
```
    The Next status of the agent.
    
    Parameters:
    
    nextStatus - The Next status of the agent.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public UserData clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.780

Class UserData

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UserData

Method Detail

setUser

getUser

withUser

setRoutingProfile

getRoutingProfile

withRoutingProfile

setHierarchyPath

getHierarchyPath

withHierarchyPath

setStatus

getStatus

withStatus

getAvailableSlotsByChannel

setAvailableSlotsByChannel

withAvailableSlotsByChannel

addAvailableSlotsByChannelEntry

clearAvailableSlotsByChannelEntries

getMaxSlotsByChannel

setMaxSlotsByChannel

withMaxSlotsByChannel

addMaxSlotsByChannelEntry

clearMaxSlotsByChannelEntries

getActiveSlotsByChannel

setActiveSlotsByChannel

withActiveSlotsByChannel

addActiveSlotsByChannelEntry

clearActiveSlotsByChannelEntries

getContacts

setContacts

withContacts

withContacts

setNextStatus

getNextStatus

withNextStatus

toString

equals

hashCode

clone

marshall