Class ParticipantTimerConfiguration

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

Configuration information for the timer. After the timer configuration is set, it persists for the duration of the chat. It persists across new contacts in the chain, for example, transfer contacts.

For more information about how chat timeouts work, see Set up chat timeouts for human participants.

See Also:

  • Method Details

    • participantRole

      public final TimerEligibleParticipantRoles participantRole()

      The role of the participant in the chat conversation.

      If the service returns an enum value that is not available in the current SDK version, participantRole will return TimerEligibleParticipantRoles.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from participantRoleAsString().

      Returns:
      The role of the participant in the chat conversation.
      See Also:

    • participantRoleAsString

      public final String participantRoleAsString()

      The role of the participant in the chat conversation.

      If the service returns an enum value that is not available in the current SDK version, participantRole will return TimerEligibleParticipantRoles.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from participantRoleAsString().

      Returns:
      The role of the participant in the chat conversation.
      See Also:

    • timerType

      public final ParticipantTimerType timerType()

      The type of timer. IDLE indicates the timer applies for considering a human chat participant as idle. DISCONNECT_NONCUSTOMER indicates the timer applies to automatically disconnecting a chat participant due to idleness.

      If the service returns an enum value that is not available in the current SDK version, timerType will return ParticipantTimerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from timerTypeAsString().

      Returns:
      The type of timer. IDLE indicates the timer applies for considering a human chat participant as idle. DISCONNECT_NONCUSTOMER indicates the timer applies to automatically disconnecting a chat participant due to idleness.
      See Also:

    • timerTypeAsString

      public final String timerTypeAsString()

      The type of timer. IDLE indicates the timer applies for considering a human chat participant as idle. DISCONNECT_NONCUSTOMER indicates the timer applies to automatically disconnecting a chat participant due to idleness.

      If the service returns an enum value that is not available in the current SDK version, timerType will return ParticipantTimerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from timerTypeAsString().

      Returns:
      The type of timer. IDLE indicates the timer applies for considering a human chat participant as idle. DISCONNECT_NONCUSTOMER indicates the timer applies to automatically disconnecting a chat participant due to idleness.
      See Also:

    • timerValue

      public final ParticipantTimerValue timerValue()

      The value of the timer. Either the timer action (Unset to delete the timer), or the duration of the timer in minutes. Only one value can be set.

      Returns:
      The value of the timer. Either the timer action (Unset to delete the timer), or the duration of the timer in minutes. Only one value can be set.

    • toBuilder

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

    • builder

      public static ParticipantTimerConfiguration.Builder builder()

    • serializableBuilderClass

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