Class AgentInfo

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

Information about the agent who accepted the contact.

See Also:

  • Method Details

    • id

      public final String id()

      The identifier of the agent who accepted the contact.

      Returns:
      The identifier of the agent who accepted the contact.

    • connectedToAgentTimestamp

      public final Instant connectedToAgentTimestamp()

      The timestamp when the contact was connected to the agent.

      Returns:
      The timestamp when the contact was connected to the agent.

    • agentPauseDurationInSeconds

      public final Integer agentPauseDurationInSeconds()

      Agent pause duration for a contact in seconds.

      Returns:
      Agent pause duration for a contact in seconds.

    • hierarchyGroups

      public final HierarchyGroups hierarchyGroups()

      The agent hierarchy groups for the agent.

      Returns:
      The agent hierarchy groups for the agent.

    • deviceInfo

      public final DeviceInfo deviceInfo()

      Information regarding Agent’s device.

      Returns:
      Information regarding Agent’s device.

    • capabilities

      public final ParticipantCapabilities capabilities()
      Returns the value of the Capabilities property for this object.
      Returns:
      The value of the Capabilities property for this object.

    • afterContactWorkDuration

      public final Integer afterContactWorkDuration()

      The difference in time, in whole seconds, between AfterContactWorkStartTimestamp and AfterContactWorkEndTimestamp.

      Returns:
      The difference in time, in whole seconds, between AfterContactWorkStartTimestamp and AfterContactWorkEndTimestamp.

    • afterContactWorkStartTimestamp

      public final Instant afterContactWorkStartTimestamp()

      The date and time when the agent started doing After Contact Work for the contact, in UTC time.

      Returns:
      The date and time when the agent started doing After Contact Work for the contact, in UTC time.

    • afterContactWorkEndTimestamp

      public final Instant afterContactWorkEndTimestamp()

      The date and time when the agent ended After Contact Work for the contact, in UTC time. In cases when agent finishes doing AfterContactWork for chat contacts and switches their activity status to offline or equivalent without clearing the contact in CCP, discrepancies may be noticed for AfterContactWorkEndTimestamp.

      Returns:
      The date and time when the agent ended After Contact Work for the contact, in UTC time. In cases when agent finishes doing AfterContactWork for chat contacts and switches their activity status to offline or equivalent without clearing the contact in CCP, discrepancies may be noticed for AfterContactWorkEndTimestamp.

    • agentInitiatedHoldDuration

      public final Integer agentInitiatedHoldDuration()

      The total hold duration in seconds initiated by the agent.

      Returns:
      The total hold duration in seconds initiated by the agent.

    • hasStateTransitions

      public final boolean hasStateTransitions()
      For responses, this returns true if the service returned a value for the StateTransitions 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.

    • stateTransitions

      public final List<StateTransition> stateTransitions()

      List of StateTransition for a supervisor.

      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 hasStateTransitions() method.

      Returns:
      List of StateTransition for a supervisor.

    • toBuilder

      public AgentInfo.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<AgentInfo.Builder,AgentInfo>
      Returns:
      a builder for type T

    • builder

      public static AgentInfo.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AgentInfo.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.