Interface SendChatIntegrationEventRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, ConnectRequest.Builder, CopyableBuilder<SendChatIntegrationEventRequest.Builder,SendChatIntegrationEventRequest>, SdkBuilder<SendChatIntegrationEventRequest.Builder,SendChatIntegrationEventRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

SendChatIntegrationEventRequest

@Mutable
@NotThreadSafe
public static interface SendChatIntegrationEventRequest.Builder
extends ConnectRequest.Builder, SdkPojo, CopyableBuilder<SendChatIntegrationEventRequest.Builder,SendChatIntegrationEventRequest>

Method Summary

Modifier and Type	Method	Description
SendChatIntegrationEventRequest.Builder	destinationId(String destinationId)	Chat system identifier, used in part to uniquely identify chat.
default SendChatIntegrationEventRequest.Builder	event(Consumer<ChatEvent.Builder> event)	Chat integration event payload
SendChatIntegrationEventRequest.Builder	event(ChatEvent event)	Chat integration event payload
default SendChatIntegrationEventRequest.Builder	newSessionDetails(Consumer<NewSessionDetails.Builder> newSessionDetails)	Contact properties to apply when starting a new chat.
SendChatIntegrationEventRequest.Builder	newSessionDetails(NewSessionDetails newSessionDetails)	Contact properties to apply when starting a new chat.
SendChatIntegrationEventRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
SendChatIntegrationEventRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
SendChatIntegrationEventRequest.Builder	sourceId(String sourceId)	External identifier of chat customer participant, used in part to uniquely identify a chat.
SendChatIntegrationEventRequest.Builder	subtype(String subtype)	Classification of a channel.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.connect.model.ConnectRequest.Builder

build

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, sdkFieldNameToField, sdkFields

Method Details

sourceId

SendChatIntegrationEventRequest.Builder sourceId(String sourceId)

External identifier of chat customer participant, used in part to uniquely identify a chat. For SMS, this is the E164 phone number of the chat customer participant.

Parameters:

sourceId - External identifier of chat customer participant, used in part to uniquely identify a chat. For SMS, this is the E164 phone number of the chat customer participant.

Returns:

Returns a reference to this object so that method calls can be chained together.

destinationId

SendChatIntegrationEventRequest.Builder destinationId(String destinationId)

Chat system identifier, used in part to uniquely identify chat. This is associated with the Amazon Connect instance and flow to be used to start chats. For Server Migration Service, this is the phone number destination of inbound Server Migration Service messages represented by an Amazon Web Services End User Messaging phone number ARN.

Parameters:

destinationId - Chat system identifier, used in part to uniquely identify chat. This is associated with the Amazon Connect instance and flow to be used to start chats. For Server Migration Service, this is the phone number destination of inbound Server Migration Service messages represented by an Amazon Web Services End User Messaging phone number ARN.

Returns:

Returns a reference to this object so that method calls can be chained together.

subtype

SendChatIntegrationEventRequest.Builder subtype(String subtype)

Classification of a channel. This is used in part to uniquely identify chat.

Valid value: ["connect:sms", connect:"WhatsApp"]

Parameters:

subtype - Classification of a channel. This is used in part to uniquely identify chat.

Valid value: ["connect:sms", connect:"WhatsApp"]

Returns:

Returns a reference to this object so that method calls can be chained together.

event

SendChatIntegrationEventRequest.Builder event(ChatEvent event)

Chat integration event payload

Parameters:

event - Chat integration event payload

Returns:

Returns a reference to this object so that method calls can be chained together.

event

default SendChatIntegrationEventRequest.Builder event(Consumer<ChatEvent.Builder> event)

Chat integration event payload

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

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

Parameters:

event - a consumer that will call methods on ChatEvent.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• event(ChatEvent)

newSessionDetails

SendChatIntegrationEventRequest.Builder newSessionDetails(NewSessionDetails newSessionDetails)

Contact properties to apply when starting a new chat. If the integration event is handled with an existing chat, this is ignored.

Parameters:

newSessionDetails - Contact properties to apply when starting a new chat. If the integration event is handled with an existing chat, this is ignored.

Returns:

Returns a reference to this object so that method calls can be chained together.

newSessionDetails

default SendChatIntegrationEventRequest.Builder newSessionDetails(Consumer<NewSessionDetails.Builder> newSessionDetails)

Contact properties to apply when starting a new chat. If the integration event is handled with an existing chat, this is ignored.

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

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

Parameters:

newSessionDetails - a consumer that will call methods on NewSessionDetails.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• newSessionDetails(NewSessionDetails)

overrideConfiguration

SendChatIntegrationEventRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

SendChatIntegrationEventRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.