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

Class ContactSearchSummary

    • Method Detail

      • arn

        public final String arn()

        The Amazon Resource Name (ARN) of the contact.

        Returns:
        The Amazon Resource Name (ARN) of the contact.

      • id

        public final String id()

        The identifier of the contact summary.

        Returns:
        The identifier of the contact summary.

      • initialContactId

        public final String initialContactId()

        If this contact is related to other contacts, this is the ID of the initial contact.

        Returns:
        If this contact is related to other contacts, this is the ID of the initial contact.

      • previousContactId

        public final String previousContactId()

        If this contact is not the first contact, this is the ID of the previous contact.

        Returns:
        If this contact is not the first contact, this is the ID of the previous contact.

      • channel

        public final Channel channel()

        How the contact reached your contact center.

        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:
        How the contact reached your contact center.
        See Also:
        Channel

      • channelAsString

        public final String channelAsString()

        How the contact reached your contact center.

        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:
        How the contact reached your contact center.
        See Also:
        Channel

      • queueInfo

        public final ContactSearchSummaryQueueInfo queueInfo()

        If this contact was queued, this contains information about the queue.

        Returns:
        If this contact was queued, this contains information about the queue.

      • agentInfo

        public final ContactSearchSummaryAgentInfo agentInfo()

        Information about the agent who accepted the contact.

        Returns:
        Information about the agent who accepted the contact.

      • initiationTimestamp

        public final Instant initiationTimestamp()

        The date and time this contact was initiated, in UTC time. For INBOUND, this is when the contact arrived. For OUTBOUND, this is when the agent began dialing. For CALLBACK, this is when the callback contact was created. For TRANSFER and QUEUE_TRANSFER, this is when the transfer was initiated. For API, this is when the request arrived. For EXTERNAL_OUTBOUND, this is when the agent started dialing the external participant. For MONITOR, this is when the supervisor started listening to a contact.

        Returns:
        The date and time this contact was initiated, in UTC time. For INBOUND, this is when the contact arrived. For OUTBOUND, this is when the agent began dialing. For CALLBACK, this is when the callback contact was created. For TRANSFER and QUEUE_TRANSFER, this is when the transfer was initiated. For API, this is when the request arrived. For EXTERNAL_OUTBOUND, this is when the agent started dialing the external participant. For MONITOR, this is when the supervisor started listening to a contact.

      • disconnectTimestamp

        public final Instant disconnectTimestamp()

        The timestamp when the customer endpoint disconnected from Amazon Connect.

        Returns:
        The timestamp when the customer endpoint disconnected from Amazon Connect.

      • scheduledTimestamp

        public final Instant scheduledTimestamp()

        The timestamp, in Unix epoch time format, at which to start running the inbound flow.

        Returns:
        The timestamp, in Unix epoch time format, at which to start running the inbound flow.

      • hasSegmentAttributes

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

      • segmentAttributes

        public final Map<String,​ContactSearchSummarySegmentAttributeValue> segmentAttributes()

        Set of segment attributes for a contact.

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

        Returns:
        Set of segment attributes for a contact.

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

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