Interface Contact.Builder

    • Method Detail

      • arn

        Contact.Builder arn​(String arn)

        The Amazon Resource Name (ARN) for the contact.

        Parameters:
        arn - The Amazon Resource Name (ARN) for the contact.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • id

        Contact.Builder id​(String id)

        The identifier for the contact.

        Parameters:
        id - The identifier for the contact.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • initialContactId

        Contact.Builder initialContactId​(String initialContactId)

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

        Parameters:
        initialContactId - If this contact is related to other contacts, this is the ID of the initial contact.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • previousContactId

        Contact.Builder previousContactId​(String previousContactId)

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

        Parameters:
        previousContactId - If this contact is not the first contact, this is the ID of the previous contact.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • initiationMethod

        Contact.Builder initiationMethod​(String initiationMethod)

        Indicates how the contact was initiated.

        Parameters:
        initiationMethod - Indicates how the contact was initiated.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ContactInitiationMethod, ContactInitiationMethod
      • name

        Contact.Builder name​(String name)

        The name of the contact.

        Parameters:
        name - The name of the contact.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • description

        Contact.Builder description​(String description)

        The description of the contact.

        Parameters:
        description - The description of the contact.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • channel

        Contact.Builder channel​(String channel)

        How the contact reached your contact center.

        Parameters:
        channel - How the contact reached your contact center.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Channel, Channel
      • channel

        Contact.Builder channel​(Channel channel)

        How the contact reached your contact center.

        Parameters:
        channel - How the contact reached your contact center.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Channel, Channel
      • queueInfo

        Contact.Builder queueInfo​(QueueInfo queueInfo)

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

        Parameters:
        queueInfo - If this contact was queued, this contains information about the queue.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • agentInfo

        Contact.Builder agentInfo​(AgentInfo agentInfo)

        Information about the agent who accepted the contact.

        Parameters:
        agentInfo - Information about the agent who accepted the contact.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • initiationTimestamp

        Contact.Builder initiationTimestamp​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.
      • disconnectTimestamp

        Contact.Builder disconnectTimestamp​(Instant disconnectTimestamp)

        The timestamp when the customer endpoint disconnected from Amazon Connect.

        Parameters:
        disconnectTimestamp - The timestamp when the customer endpoint disconnected from Amazon Connect.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • lastUpdateTimestamp

        Contact.Builder lastUpdateTimestamp​(Instant lastUpdateTimestamp)

        The timestamp when contact was last updated.

        Parameters:
        lastUpdateTimestamp - The timestamp when contact was last updated.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • lastPausedTimestamp

        Contact.Builder lastPausedTimestamp​(Instant lastPausedTimestamp)

        The timestamp when the contact was last paused.

        Parameters:
        lastPausedTimestamp - The timestamp when the contact was last paused.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • lastResumedTimestamp

        Contact.Builder lastResumedTimestamp​(Instant lastResumedTimestamp)

        The timestamp when the contact was last resumed.

        Parameters:
        lastResumedTimestamp - The timestamp when the contact was last resumed.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • totalPauseCount

        Contact.Builder totalPauseCount​(Integer totalPauseCount)

        Total pause count for a contact.

        Parameters:
        totalPauseCount - Total pause count for a contact.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • totalPauseDurationInSeconds

        Contact.Builder totalPauseDurationInSeconds​(Integer totalPauseDurationInSeconds)

        Total pause duration for a contact in seconds.

        Parameters:
        totalPauseDurationInSeconds - Total pause duration for a contact in seconds.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • scheduledTimestamp

        Contact.Builder scheduledTimestamp​(Instant scheduledTimestamp)

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

        Parameters:
        scheduledTimestamp - The timestamp, in Unix epoch time format, at which to start running the inbound flow.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • relatedContactId

        Contact.Builder relatedContactId​(String relatedContactId)

        The contactId that is related to this contact.

        Parameters:
        relatedContactId - The contactId that is related to this contact.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • wisdomInfo

        Contact.Builder wisdomInfo​(WisdomInfo wisdomInfo)

        Information about Amazon Connect Wisdom.

        Parameters:
        wisdomInfo - Information about Amazon Connect Wisdom.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • queueTimeAdjustmentSeconds

        Contact.Builder queueTimeAdjustmentSeconds​(Integer queueTimeAdjustmentSeconds)

        An integer that represents the queue time adjust to be applied to the contact, in seconds (longer / larger queue time are routed preferentially). Cannot be specified if the QueuePriority is specified. Must be statically defined and a valid integer value.

        Parameters:
        queueTimeAdjustmentSeconds - An integer that represents the queue time adjust to be applied to the contact, in seconds (longer / larger queue time are routed preferentially). Cannot be specified if the QueuePriority is specified. Must be statically defined and a valid integer value.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • queuePriority

        Contact.Builder queuePriority​(Long queuePriority)

        An integer that represents the queue priority to be applied to the contact (lower priorities are routed preferentially). Cannot be specified if the QueueTimeAdjustmentSeconds is specified. Must be statically defined, must be larger than zero, and a valid integer value. Default Value is 5.

        Parameters:
        queuePriority - An integer that represents the queue priority to be applied to the contact (lower priorities are routed preferentially). Cannot be specified if the QueueTimeAdjustmentSeconds is specified. Must be statically defined, must be larger than zero, and a valid integer value. Default Value is 5.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • tags

        Contact.Builder tags​(Map<String,​String> tags)

        Tags associated with the contact. This contains both Amazon Web Services generated and user-defined tags.

        Parameters:
        tags - Tags associated with the contact. This contains both Amazon Web Services generated and user-defined tags.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • connectedToSystemTimestamp

        Contact.Builder connectedToSystemTimestamp​(Instant connectedToSystemTimestamp)

        The timestamp when customer endpoint connected to Amazon Connect.

        Parameters:
        connectedToSystemTimestamp - The timestamp when customer endpoint connected to Amazon Connect.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • routingCriteria

        Contact.Builder routingCriteria​(RoutingCriteria routingCriteria)

        Latest routing criteria on the contact.

        Parameters:
        routingCriteria - Latest routing criteria on the contact.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • customer

        Contact.Builder customer​(Customer customer)

        Information about the Customer on the contact.

        Parameters:
        customer - Information about the Customer on the contact.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • campaign

        Contact.Builder campaign​(Campaign campaign)
        Sets the value of the Campaign property for this object.
        Parameters:
        campaign - The new value for the Campaign property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • customerVoiceActivity

        Contact.Builder customerVoiceActivity​(CustomerVoiceActivity customerVoiceActivity)

        Information about customer’s voice activity.

        Parameters:
        customerVoiceActivity - Information about customer’s voice activity.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • qualityMetrics

        Contact.Builder qualityMetrics​(QualityMetrics qualityMetrics)

        Information about the quality of the participant's media connection.

        Parameters:
        qualityMetrics - Information about the quality of the participant's media connection.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • disconnectDetails

        Contact.Builder disconnectDetails​(DisconnectDetails disconnectDetails)

        Information about the call disconnect experience.

        Parameters:
        disconnectDetails - Information about the call disconnect experience.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • segmentAttributes

        Contact.Builder segmentAttributes​(Map<String,​SegmentAttributeValue> segmentAttributes)

        A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes and can be accessed in flows. Attribute keys can include only alphanumeric, -, and _ characters. This field can be used to show channel subtype. For example, connect:Guide or connect:SMS.

        Parameters:
        segmentAttributes - A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes and can be accessed in flows. Attribute keys can include only alphanumeric, -, and _ characters. This field can be used to show channel subtype. For example, connect:Guide or connect:SMS.
        Returns:
        Returns a reference to this object so that method calls can be chained together.