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

Class UserData

java.lang.Object
software.amazon.awssdk.services.connect.model.UserData
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<UserData.Builder,UserData>
@Generated("software.amazon.awssdk:codegen") public final class UserData extends Object implements SdkPojo, Serializable, ToCopyableBuilder<UserData.Builder,UserData>

Data for a user.

See Also:

  • Method Details

    • user

      public final UserReference user()

      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.

    • 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.

    • nextStatus

      public final String nextStatus()

      The Next status of the agent.

      Returns:
      The Next status of the agent.

    • toBuilder

      public UserData.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<UserData.Builder,UserData>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.