Class ParticipantTimerValue

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

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.

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

See Also:

  • Method Details

    • participantTimerAction

      public final ParticipantTimerAction participantTimerAction()

      The timer action. Currently only one value is allowed: Unset. It deletes a timer.

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

      Returns:
      The timer action. Currently only one value is allowed: Unset. It deletes a timer.
      See Also:

    • participantTimerActionAsString

      public final String participantTimerActionAsString()

      The timer action. Currently only one value is allowed: Unset. It deletes a timer.

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

      Returns:
      The timer action. Currently only one value is allowed: Unset. It deletes a timer.
      See Also:

    • participantTimerDurationInMinutes

      public final Integer participantTimerDurationInMinutes()

      The duration of a timer, in minutes.

      Returns:
      The duration of a timer, in minutes.

    • toBuilder

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

    • builder

      public static ParticipantTimerValue.Builder builder()

    • serializableBuilderClass

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

    • fromParticipantTimerAction

      public static ParticipantTimerValue fromParticipantTimerAction(String participantTimerAction)
      Create an instance of this class with participantTimerActionAsString() initialized to the given value.

      The timer action. Currently only one value is allowed: Unset. It deletes a timer.

      Parameters:
      participantTimerAction - The timer action. Currently only one value is allowed: Unset. It deletes a timer.
      See Also:

    • fromParticipantTimerAction

      public static ParticipantTimerValue fromParticipantTimerAction(ParticipantTimerAction participantTimerAction)
      Create an instance of this class with participantTimerActionAsString() initialized to the given value.

      The timer action. Currently only one value is allowed: Unset. It deletes a timer.

      Parameters:
      participantTimerAction - The timer action. Currently only one value is allowed: Unset. It deletes a timer.
      See Also:

    • fromParticipantTimerDurationInMinutes

      public static ParticipantTimerValue fromParticipantTimerDurationInMinutes(Integer participantTimerDurationInMinutes)
      Create an instance of this class with participantTimerDurationInMinutes() initialized to the given value.

      The duration of a timer, in minutes.

      Parameters:
      participantTimerDurationInMinutes - The duration of a timer, in minutes.

    • type

      public ParticipantTimerValue.Type type()
      Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be ParticipantTimerValue.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be ParticipantTimerValue.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

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