Interface ContactSearchSummary.Builder

  • Method Details

    • arn

      The Amazon Resource Name (ARN) of the contact.

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

      The identifier of the contact summary.

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

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

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

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

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

      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

      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

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

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

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

      Parameters:
      queueInfo - a consumer that will call methods on ContactSearchSummaryQueueInfo.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • 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

      Information about the agent who accepted the contact.

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

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

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

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

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

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

      Set of segment attributes for a contact.

      Parameters:
      segmentAttributes - Set of segment attributes for a contact.
      Returns:
      Returns a reference to this object so that method calls can be chained together.