Interface Contact.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Contact.Builder,
,Contact> SdkBuilder<Contact.Builder,
,Contact> SdkPojo
- Enclosing class:
Contact
-
Method Summary
Modifier and TypeMethodDescriptiondefault Contact.Builder
agentInfo
(Consumer<AgentInfo.Builder> agentInfo) Information about the agent who accepted the contact.Information about the agent who accepted the contact.The Amazon Resource Name (ARN) for the contact.How the contact reached your contact center.How the contact reached your contact center.description
(String description) The description of the contact.disconnectTimestamp
(Instant disconnectTimestamp) The timestamp when the customer endpoint disconnected from Amazon Connect.The identifier for the contact.initialContactId
(String initialContactId) If this contact is related to other contacts, this is the ID of the initial contact.initiationMethod
(String initiationMethod) Indicates how the contact was initiated.initiationMethod
(ContactInitiationMethod initiationMethod) Indicates how the contact was initiated.initiationTimestamp
(Instant initiationTimestamp) The date and time this contact was initiated, in UTC time.lastPausedTimestamp
(Instant lastPausedTimestamp) The timestamp when the contact was last paused.lastResumedTimestamp
(Instant lastResumedTimestamp) The timestamp when the contact was last resumed.lastUpdateTimestamp
(Instant lastUpdateTimestamp) The timestamp when contact was last updated.The name of the contact.previousContactId
(String previousContactId) If this contact is not the first contact, this is the ID of the previous contact.default Contact.Builder
queueInfo
(Consumer<QueueInfo.Builder> queueInfo) If this contact was queued, this contains information about the queue.If this contact was queued, this contains information about the queue.queuePriority
(Long queuePriority) An integer that represents the queue priority to be applied to the contact (lower priorities are routed preferentially).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).relatedContactId
(String relatedContactId) The contactId that is related to this contact.scheduledTimestamp
(Instant scheduledTimestamp) The timestamp, in Unix epoch time format, at which to start running the inbound flow.Tags associated with the contact.totalPauseCount
(Integer totalPauseCount) Total pause count for a contact.totalPauseDurationInSeconds
(Integer totalPauseDurationInSeconds) Total pause duration for a contact in seconds.default Contact.Builder
wisdomInfo
(Consumer<WisdomInfo.Builder> wisdomInfo) Information about Amazon Connect Wisdom.wisdomInfo
(WisdomInfo wisdomInfo) Information about Amazon Connect Wisdom.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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
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
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
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
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
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
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
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 theQueueInfo.Builder
avoiding the need to create one manually viaQueueInfo.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toqueueInfo(QueueInfo)
.- Parameters:
queueInfo
- a consumer that will call methods onQueueInfo.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 theAgentInfo.Builder
avoiding the need to create one manually viaAgentInfo.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toagentInfo(AgentInfo)
.- Parameters:
agentInfo
- a consumer that will call methods onAgentInfo.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
initiationTimestamp
The date and time this contact was initiated, in UTC time. For
INBOUND
, this is when the contact arrived. ForOUTBOUND
, this is when the agent began dialing. ForCALLBACK
, this is when the callback contact was created. ForTRANSFER
andQUEUE_TRANSFER
, this is when the transfer was initiated. ForAPI
, this is when the request arrived. ForEXTERNAL_OUTBOUND
, this is when the agent started dialing the external participant. ForMONITOR
, this is when the supervisor started listening to a contact.- Parameters:
initiationTimestamp
- The date and time this contact was initiated, in UTC time. ForINBOUND
, this is when the contact arrived. ForOUTBOUND
, this is when the agent began dialing. ForCALLBACK
, this is when the callback contact was created. ForTRANSFER
andQUEUE_TRANSFER
, this is when the transfer was initiated. ForAPI
, this is when the request arrived. ForEXTERNAL_OUTBOUND
, this is when the agent started dialing the external participant. ForMONITOR
, 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
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
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
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
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
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
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
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.
-
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
Information about Amazon Connect Wisdom.
This is a convenience method that creates an instance of theWisdomInfo.Builder
avoiding the need to create one manually viaWisdomInfo.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed towisdomInfo(WisdomInfo)
.- Parameters:
wisdomInfo
- a consumer that will call methods onWisdomInfo.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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.
-