Interface Contact.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Contact.Builder,Contact>, SdkBuilder<Contact.Builder,Contact>, SdkPojo
Enclosing class:
Contact
public static interface Contact.Builder extends SdkPojo, CopyableBuilder<Contact.Builder,Contact>

  • Method Details

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

    • contactAssociationId

      Contact.Builder contactAssociationId(String contactAssociationId)

      This is the root contactId which is used as a unique identifier for all subsequent contacts in a contact tree.

      Parameters:
      contactAssociationId - This is the root contactId which is used as a unique identifier for all subsequent contacts in a contact tree.
      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:

    • initiationMethod

      Contact.Builder initiationMethod(ContactInitiationMethod 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:

    • 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

      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:

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

    • queueInfo

      default Contact.Builder queueInfo(Consumer<QueueInfo.Builder> queueInfo)

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

      This is a convenience method that creates an instance of the QueueInfo.Builder avoiding the need to create one manually via QueueInfo.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to queueInfo(QueueInfo).

      Parameters:
      queueInfo - a consumer that will call methods on QueueInfo.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

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

    • agentInfo

      default Contact.Builder agentInfo(Consumer<AgentInfo.Builder> agentInfo)

      Information about the agent who accepted the contact.

      This is a convenience method that creates an instance of the AgentInfo.Builder avoiding the need to create one manually via AgentInfo.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to agentInfo(AgentInfo).

      Parameters:
      agentInfo - a consumer that will call methods on AgentInfo.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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 date and time that the customer endpoint disconnected from the current contact, in UTC time. In transfer scenarios, the DisconnectTimestamp of the previous contact indicates the date and time when that contact ended.

      Parameters:
      disconnectTimestamp - The date and time that the customer endpoint disconnected from the current contact, in UTC time. In transfer scenarios, the DisconnectTimestamp of the previous contact indicates the date and time when that contact ended.
      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.

    • wisdomInfo

      default Contact.Builder wisdomInfo(Consumer<WisdomInfo.Builder> wisdomInfo)

      Information about Amazon Connect Wisdom.

      This is a convenience method that creates an instance of the WisdomInfo.Builder avoiding the need to create one manually via WisdomInfo.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to wisdomInfo(WisdomInfo).

      Parameters:
      wisdomInfo - a consumer that will call methods on WisdomInfo.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • customerId

      Contact.Builder customerId(String customerId)

      The customer's identification number. For example, the CustomerId may be a customer number from your CRM. You can create a Lambda function to pull the unique customer ID of the caller from your CRM system. If you enable Amazon Connect Voice ID capability, this attribute is populated with the CustomerSpeakerId of the caller.

      Parameters:
      customerId - The customer's identification number. For example, the CustomerId may be a customer number from your CRM. You can create a Lambda function to pull the unique customer ID of the caller from your CRM system. If you enable Amazon Connect Voice ID capability, this attribute is populated with the CustomerSpeakerId of the caller.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customerEndpoint

      Contact.Builder customerEndpoint(EndpointInfo customerEndpoint)

      The customer or external third party participant endpoint.

      Parameters:
      customerEndpoint - The customer or external third party participant endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customerEndpoint

      default Contact.Builder customerEndpoint(Consumer<EndpointInfo.Builder> customerEndpoint)

      The customer or external third party participant endpoint.

      This is a convenience method that creates an instance of the EndpointInfo.Builder avoiding the need to create one manually via EndpointInfo.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to customerEndpoint(EndpointInfo).

      Parameters:
      customerEndpoint - a consumer that will call methods on EndpointInfo.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • systemEndpoint

      Contact.Builder systemEndpoint(EndpointInfo systemEndpoint)

      The system endpoint. For INBOUND, this is the phone number or email address that the customer dialed. For OUTBOUND and EXTERNAL_OUTBOUND, this is the outbound caller ID number assigned to the outbound queue that is used to dial the customer. For callback, this shows up as Softphone for calls handled by agents with softphone.

      Parameters:
      systemEndpoint - The system endpoint. For INBOUND, this is the phone number or email address that the customer dialed. For OUTBOUND and EXTERNAL_OUTBOUND, this is the outbound caller ID number assigned to the outbound queue that is used to dial the customer. For callback, this shows up as Softphone for calls handled by agents with softphone.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • systemEndpoint

      default Contact.Builder systemEndpoint(Consumer<EndpointInfo.Builder> systemEndpoint)

      The system endpoint. For INBOUND, this is the phone number or email address that the customer dialed. For OUTBOUND and EXTERNAL_OUTBOUND, this is the outbound caller ID number assigned to the outbound queue that is used to dial the customer. For callback, this shows up as Softphone for calls handled by agents with softphone.

      This is a convenience method that creates an instance of the EndpointInfo.Builder avoiding the need to create one manually via EndpointInfo.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to systemEndpoint(EndpointInfo).

      Parameters:
      systemEndpoint - a consumer that will call methods on EndpointInfo.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

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

    • routingCriteria

      default Contact.Builder routingCriteria(Consumer<RoutingCriteria.Builder> routingCriteria)

      Latest routing criteria on the contact.

      This is a convenience method that creates an instance of the RoutingCriteria.Builder avoiding the need to create one manually via RoutingCriteria.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to routingCriteria(RoutingCriteria).

      Parameters:
      routingCriteria - a consumer that will call methods on RoutingCriteria.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

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

    • customer

      default Contact.Builder customer(Consumer<Customer.Builder> customer)

      Information about the Customer on the contact.

      This is a convenience method that creates an instance of the Customer.Builder avoiding the need to create one manually via Customer.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to customer(Customer).

      Parameters:
      customer - a consumer that will call methods on Customer.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

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

    • campaign

      default Contact.Builder campaign(Consumer<Campaign.Builder> campaign)
      Sets the value of the Campaign property for this object. This is a convenience method that creates an instance of the Campaign.Builder avoiding the need to create one manually via Campaign.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to campaign(Campaign).

      Parameters:
      campaign - a consumer that will call methods on Campaign.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • answeringMachineDetectionStatus

      Contact.Builder answeringMachineDetectionStatus(String answeringMachineDetectionStatus)

      Indicates how an outbound campaign call is actually disposed if the contact is connected to Amazon Connect.

      Parameters:
      answeringMachineDetectionStatus - Indicates how an outbound campaign call is actually disposed if the contact is connected to Amazon Connect.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • answeringMachineDetectionStatus

      Contact.Builder answeringMachineDetectionStatus(AnsweringMachineDetectionStatus answeringMachineDetectionStatus)

      Indicates how an outbound campaign call is actually disposed if the contact is connected to Amazon Connect.

      Parameters:
      answeringMachineDetectionStatus - Indicates how an outbound campaign call is actually disposed if the contact is connected to Amazon Connect.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

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

    • customerVoiceActivity

      default Contact.Builder customerVoiceActivity(Consumer<CustomerVoiceActivity.Builder> customerVoiceActivity)

      Information about customer’s voice activity.

      This is a convenience method that creates an instance of the CustomerVoiceActivity.Builder avoiding the need to create one manually via CustomerVoiceActivity.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to customerVoiceActivity(CustomerVoiceActivity).

      Parameters:
      customerVoiceActivity - a consumer that will call methods on CustomerVoiceActivity.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

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

    • qualityMetrics

      default Contact.Builder qualityMetrics(Consumer<QualityMetrics.Builder> qualityMetrics)

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

      This is a convenience method that creates an instance of the QualityMetrics.Builder avoiding the need to create one manually via QualityMetrics.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to qualityMetrics(QualityMetrics).

      Parameters:
      qualityMetrics - a consumer that will call methods on QualityMetrics.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

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

    • disconnectDetails

      default Contact.Builder disconnectDetails(Consumer<DisconnectDetails.Builder> disconnectDetails)

      Information about the call disconnect experience.

      This is a convenience method that creates an instance of the DisconnectDetails.Builder avoiding the need to create one manually via DisconnectDetails.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to disconnectDetails(DisconnectDetails).

      Parameters:
      disconnectDetails - a consumer that will call methods on DisconnectDetails.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • additionalEmailRecipients

      Contact.Builder additionalEmailRecipients(AdditionalEmailRecipients additionalEmailRecipients)

      List of additional email addresses for an email contact.

      Parameters:
      additionalEmailRecipients - List of additional email addresses for an email contact.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • additionalEmailRecipients

      default Contact.Builder additionalEmailRecipients(Consumer<AdditionalEmailRecipients.Builder> additionalEmailRecipients)

      List of additional email addresses for an email contact.

      This is a convenience method that creates an instance of the AdditionalEmailRecipients.Builder avoiding the need to create one manually via AdditionalEmailRecipients.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to additionalEmailRecipients(AdditionalEmailRecipients).

      Parameters:
      additionalEmailRecipients - a consumer that will call methods on AdditionalEmailRecipients.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

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