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

Class AgentContactReference

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

Information about the contact associated to the user.

See Also:

  • Method Details

    • contactId

      public final String contactId()

      The identifier of the contact in this instance of Amazon Connect.

      Returns:
      The identifier of the contact in this instance of Amazon Connect.

    • channel

      public final Channel channel()

      The channel of the contact.

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

      Returns:
      The channel of the contact.
      See Also:

    • channelAsString

      public final String channelAsString()

      The channel of the contact.

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

      Returns:
      The channel of the contact.
      See Also:

    • initiationMethod

      public final ContactInitiationMethod initiationMethod()

      How the contact was initiated.

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

      Returns:
      How the contact was initiated.
      See Also:

    • initiationMethodAsString

      public final String initiationMethodAsString()

      How the contact was initiated.

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

      Returns:
      How the contact was initiated.
      See Also:

    • agentContactState

      public final ContactState agentContactState()

      The state of the contact.

      When AgentContactState is set to CONNECTED_ONHOLD, StateStartTimestamp is not changed. Instead, StateStartTimestamp reflects the time the contact was CONNECTED to the agent.

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

      Returns:
      The state of the contact.

      When AgentContactState is set to CONNECTED_ONHOLD, StateStartTimestamp is not changed. Instead, StateStartTimestamp reflects the time the contact was CONNECTED to the agent.

      See Also:

    • agentContactStateAsString

      public final String agentContactStateAsString()

      The state of the contact.

      When AgentContactState is set to CONNECTED_ONHOLD, StateStartTimestamp is not changed. Instead, StateStartTimestamp reflects the time the contact was CONNECTED to the agent.

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

      Returns:
      The state of the contact.

      When AgentContactState is set to CONNECTED_ONHOLD, StateStartTimestamp is not changed. Instead, StateStartTimestamp reflects the time the contact was CONNECTED to the agent.

      See Also:

    • stateStartTimestamp

      public final Instant stateStartTimestamp()

      The epoch timestamp when the contact state started.

      Returns:
      The epoch timestamp when the contact state started.

    • connectedToAgentTimestamp

      public final Instant connectedToAgentTimestamp()

      The time at which the contact was connected to an agent.

      Returns:
      The time at which the contact was connected to an agent.

    • queue

      public final QueueReference queue()
      Returns the value of the Queue property for this object.
      Returns:
      The value of the Queue property for this object.

    • toBuilder

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

    • builder

      public static AgentContactReference.Builder builder()

    • serializableBuilderClass

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