Package software.amazon.awssdk.services.connect.model

Interface UserData.Builder

All Superinterfaces:

Buildable, CopyableBuilder<UserData.Builder,UserData>, SdkBuilder<UserData.Builder,UserData>, SdkPojo

Enclosing class:

UserData

public static interface UserData.Builder
extends SdkPojo, CopyableBuilder<UserData.Builder,UserData>

Method Summary

Modifier and Type	Method	Description
UserData.Builder	activeSlotsByChannel(Map<Channel,Integer> activeSlotsByChannel)	A map of active slots by channel.
UserData.Builder	activeSlotsByChannelWithStrings(Map<String,Integer> activeSlotsByChannel)	A map of active slots by channel.
UserData.Builder	availableSlotsByChannel(Map<Channel,Integer> availableSlotsByChannel)	A map of available slots by channel.
UserData.Builder	availableSlotsByChannelWithStrings(Map<String,Integer> availableSlotsByChannel)	A map of available slots by channel.
UserData.Builder	contacts(Collection<AgentContactReference> contacts)	A list of contact reference information.
UserData.Builder	contacts(Consumer<AgentContactReference.Builder>... contacts)	A list of contact reference information.
UserData.Builder	contacts(AgentContactReference... contacts)	A list of contact reference information.
default UserData.Builder	hierarchyPath(Consumer<HierarchyPathReference.Builder> hierarchyPath)	Contains information about the levels of a hierarchy group assigned to a user.
UserData.Builder	hierarchyPath(HierarchyPathReference hierarchyPath)	Contains information about the levels of a hierarchy group assigned to a user.
UserData.Builder	maxSlotsByChannel(Map<Channel,Integer> maxSlotsByChannel)	A map of maximum slots by channel.
UserData.Builder	maxSlotsByChannelWithStrings(Map<String,Integer> maxSlotsByChannel)	A map of maximum slots by channel.
UserData.Builder	nextStatus(String nextStatus)	The Next status of the agent.
default UserData.Builder	routingProfile(Consumer<RoutingProfileReference.Builder> routingProfile)	Information about the routing profile that is assigned to the user.
UserData.Builder	routingProfile(RoutingProfileReference routingProfile)	Information about the routing profile that is assigned to the user.
default UserData.Builder	status(Consumer<AgentStatusReference.Builder> 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	status(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.
default UserData.Builder	user(Consumer<UserReference.Builder> user)	Information about the user for the data that is returned.
UserData.Builder	user(UserReference user)	Information about the user for the data that is returned.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Detail

user

UserData.Builder user(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.

user

default UserData.Builder user(Consumer<UserReference.Builder> user)

Information about the user for the data that is returned. It contains the resourceId and ARN of the user.

This is a convenience method that creates an instance of the UserReference.Builder avoiding the need to create one manually via UserReference.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to user(UserReference).

Parameters:

user - a consumer that will call methods on UserReference.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

user(UserReference)

routingProfile

UserData.Builder routingProfile(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.

routingProfile

default UserData.Builder routingProfile(Consumer<RoutingProfileReference.Builder> routingProfile)

Information about the routing profile that is assigned to the user.

This is a convenience method that creates an instance of the RoutingProfileReference.Builder avoiding the need to create one manually via RoutingProfileReference.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to routingProfile(RoutingProfileReference).

Parameters:

routingProfile - a consumer that will call methods on RoutingProfileReference.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

routingProfile(RoutingProfileReference)

hierarchyPath

UserData.Builder hierarchyPath(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.

hierarchyPath

default UserData.Builder hierarchyPath(Consumer<HierarchyPathReference.Builder> hierarchyPath)

Contains information about the levels of a hierarchy group assigned to a user.

This is a convenience method that creates an instance of the HierarchyPathReference.Builder avoiding the need to create one manually via HierarchyPathReference.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to hierarchyPath(HierarchyPathReference).

Parameters:

hierarchyPath - a consumer that will call methods on HierarchyPathReference.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

hierarchyPath(HierarchyPathReference)

status

UserData.Builder status(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.

status

default UserData.Builder status(Consumer<AgentStatusReference.Builder> 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.

This is a convenience method that creates an instance of the AgentStatusReference.Builder avoiding the need to create one manually via AgentStatusReference.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to status(AgentStatusReference).

Parameters:

status - a consumer that will call methods on AgentStatusReference.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

status(AgentStatusReference)

availableSlotsByChannelWithStrings

UserData.Builder availableSlotsByChannelWithStrings(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.

availableSlotsByChannel

UserData.Builder availableSlotsByChannel(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.

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.

maxSlotsByChannelWithStrings

UserData.Builder maxSlotsByChannelWithStrings(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.

maxSlotsByChannel

UserData.Builder maxSlotsByChannel(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.

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.

activeSlotsByChannelWithStrings

UserData.Builder activeSlotsByChannelWithStrings(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.

activeSlotsByChannel

UserData.Builder activeSlotsByChannel(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.

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.

contacts

UserData.Builder contacts(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.

contacts

UserData.Builder contacts(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.

contacts

UserData.Builder contacts(Consumer<AgentContactReference.Builder>... contacts)

A list of contact reference information.

This is a convenience method that creates an instance of the AgentContactReference.Builder avoiding the need to create one manually via AgentContactReference.builder() .

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #contacts(List).

Parameters:

contacts - a consumer that will call methods on AgentContactReference.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#contacts(java.util.Collection)

nextStatus

UserData.Builder nextStatus(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.