/* * Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.connect.model; import java.io.Serializable; /** *
* Data for a user. *
*/ public class UserData implements Serializable { /** *
* Information about the user for the data that is returned. It contains the
* resourceId
and ARN of the user.
*
* Information about the routing profile that is assigned to the user. *
*/ private RoutingProfileReference routingProfile; /** ** Contains information about the levels of a hierarchy group assigned to a * user. *
*/ private HierarchyPathReference hierarchyPath; /** ** 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. *
*/ private AgentStatusReference status; /** ** A map of available slots by channel. The key is a channel name. The value * is an integer: the available number of slots. *
*/ private java.util.Map
* 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.
*
* A map of active slots by channel. The key is a channel name. The value is * an integer: the number of active slots. *
*/ private java.util.Map* A list of contact reference information. *
*/ private java.util.List* The Next status of the agent. *
*
* Constraints:
* Length: 1 - 127
*/
private String nextStatus;
/**
*
* Information about the user for the data that is returned. It contains the
* resourceId
and ARN of the user.
*
* Information about the user for the data that is returned. It
* contains the resourceId
and ARN of the user.
*
* Information about the user for the data that is returned. It contains the
* resourceId
and ARN of the user.
*
* Information about the user for the data that is returned. It
* contains the resourceId
and ARN of the 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. * * @param user
* Information about the user for the data that is returned. It
* contains the resourceId
and ARN of the user.
*
* Information about the routing profile that is assigned to the user. *
* * @return* Information about the routing profile that is assigned to the * user. *
*/ public RoutingProfileReference getRoutingProfile() { return routingProfile; } /** ** Information about the routing profile that is assigned to the user. *
* * @param routingProfile* Information about the routing profile that is assigned to the * user. *
*/ public void setRoutingProfile(RoutingProfileReference routingProfile) { this.routingProfile = 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. * * @param routingProfile
* Information about the routing profile that is assigned to the * user. *
* @return A reference to this updated object so that method calls can be * chained together. */ public UserData withRoutingProfile(RoutingProfileReference routingProfile) { this.routingProfile = routingProfile; return this; } /** ** Contains information about the levels of a hierarchy group assigned to a * user. *
* * @return* Contains information about the levels of a hierarchy group * assigned to a user. *
*/ public HierarchyPathReference getHierarchyPath() { return hierarchyPath; } /** ** Contains information about the levels of a hierarchy group assigned to a * user. *
* * @param hierarchyPath* Contains information about the levels of a hierarchy group * assigned to a user. *
*/ public void setHierarchyPath(HierarchyPathReference hierarchyPath) { this.hierarchyPath = 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. * * @param hierarchyPath
* Contains information about the levels of a hierarchy group * assigned to a user. *
* @return A reference to this updated object so that method calls can be * chained together. */ public UserData withHierarchyPath(HierarchyPathReference hierarchyPath) { this.hierarchyPath = hierarchyPath; return this; } /** ** 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. *
* * @return* 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. *
*/ public AgentStatusReference getStatus() { return 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. *
* * @param 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. *
*/ public void setStatus(AgentStatusReference status) { this.status = 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. * * @param 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. *
* @return A reference to this updated object so that method calls can be * chained together. */ public UserData withStatus(AgentStatusReference status) { this.status = status; return this; } /** ** A map of available slots by channel. The key is a channel name. The value * is an integer: the available number of slots. *
* * @return* A map of available slots by channel. The key is a channel name. * The value is an integer: the available number of slots. *
*/ public java.util.Map* A map of available slots by channel. The key is a channel name. The value * is an integer: the available number of slots. *
* * @param availableSlotsByChannel* A map of available slots by channel. The key is a channel * name. The value is an integer: the available number of slots. *
*/ public void setAvailableSlotsByChannel(java.util.Map* 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. * * @param availableSlotsByChannel
* A map of available slots by channel. The key is a channel * name. The value is an integer: the available number of slots. *
* @return A reference to this updated object so that method calls can be * chained together. */ public UserData withAvailableSlotsByChannel( java.util.Map* 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.
*
* @param key The key of the entry to be added into AvailableSlotsByChannel.
* @param value The corresponding value of the entry to be added into
* AvailableSlotsByChannel.
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public UserData addAvailableSlotsByChannelEntry(String key, Integer value) {
if (null == this.availableSlotsByChannel) {
this.availableSlotsByChannel = new java.util.HashMap
* Returns a reference to this object so that method calls can be chained
* together.
*/
public UserData clearAvailableSlotsByChannelEntries() {
this.availableSlotsByChannel = null;
return this;
}
/**
*
* 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
* 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
* 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
* 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
* 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
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param 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
* 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
* 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.
*
* @param key The key of the entry to be added into MaxSlotsByChannel.
* @param value The corresponding value of the entry to be added into
* MaxSlotsByChannel.
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public UserData addMaxSlotsByChannelEntry(String key, Integer value) {
if (null == this.maxSlotsByChannel) {
this.maxSlotsByChannel = new java.util.HashMap
* Returns a reference to this object so that method calls can be chained
* together.
*/
public UserData clearMaxSlotsByChannelEntries() {
this.maxSlotsByChannel = null;
return this;
}
/**
*
* A map of active slots by channel. The key is a channel name. The value is
* an integer: the number of active slots.
*
* A map of active slots by channel. The key is a channel name. The
* value is an integer: the number of active slots.
*
* A map of active slots by channel. The key is a channel name. The value is
* an integer: the number of active slots.
*
* A map of active slots by channel. The key is a channel name.
* The value is an integer: the number of active slots.
*
* 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.
*
* @param activeSlotsByChannel
* A map of active slots by channel. The key is a channel name.
* The value is an integer: the number of active slots.
*
* 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.
*
* @param key The key of the entry to be added into ActiveSlotsByChannel.
* @param value The corresponding value of the entry to be added into
* ActiveSlotsByChannel.
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public UserData addActiveSlotsByChannelEntry(String key, Integer value) {
if (null == this.activeSlotsByChannel) {
this.activeSlotsByChannel = new java.util.HashMap
* Returns a reference to this object so that method calls can be chained
* together.
*/
public UserData clearActiveSlotsByChannelEntries() {
this.activeSlotsByChannel = null;
return this;
}
/**
*
* A list of contact reference information.
*
* A list of contact reference information.
*
* A list of contact reference information.
*
* A list of contact reference information.
*
* A list of contact reference information.
*
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param contacts
* A list of contact reference information.
*
* A list of contact reference information.
*
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param contacts
* A list of contact reference information.
*
* The Next status of the agent.
*
* Constraints:
* The Next status of the agent.
*
* The Next status of the agent.
*
* Constraints:
* The Next status of the agent.
*
* The Next status of the agent.
*
* Returns a reference to this object so that method calls can be chained
* together.
*
* Constraints:
* The Next status of the agent.
* RoutingProfile
assigned to the
* agent.
* RoutingProfile
assigned
* to the agent.
* RoutingProfile
assigned to the
* agent.
* RoutingProfile
* assigned to the agent.
* RoutingProfile
assigned to the
* agent.
* RoutingProfile
* assigned to the agent.
* RoutingProfile
assigned to the
* agent.
*
* Length: 1 - 127
*
* @return
* Length: 1 - 127
*
* @param nextStatus
* Length: 1 - 127
*
* @param nextStatus