software.amazon.awssdk.services.connect.model

Interface StartChatContactRequest.Builder

All Superinterfaces:

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

Enclosing class:

StartChatContactRequest

public static interface StartChatContactRequest.Builder
extends ConnectRequest.Builder, SdkPojo, CopyableBuilder<StartChatContactRequest.Builder,StartChatContactRequest>

Method Summary

Modifier and Type	Method and Description
StartChatContactRequest.Builder	attributes(Map<String,String> attributes) A custom key-value pair using an attribute map.
StartChatContactRequest.Builder	chatDurationInMinutes(Integer chatDurationInMinutes) The total duration of the newly started chat session.
StartChatContactRequest.Builder	clientToken(String clientToken) A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
StartChatContactRequest.Builder	contactFlowId(String contactFlowId) The identifier of the flow for initiating the chat.
StartChatContactRequest.Builder	initialMessage(ChatMessage initialMessage) The initial message to be sent to the newly created chat.
default StartChatContactRequest.Builder	initialMessage(Consumer<ChatMessage.Builder> initialMessage) The initial message to be sent to the newly created chat.
StartChatContactRequest.Builder	instanceId(String instanceId) The identifier of the Amazon Connect instance.
StartChatContactRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
StartChatContactRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
default StartChatContactRequest.Builder	participantDetails(Consumer<ParticipantDetails.Builder> participantDetails) Information identifying the participant.
StartChatContactRequest.Builder	participantDetails(ParticipantDetails participantDetails) Information identifying the participant.
default StartChatContactRequest.Builder	persistentChat(Consumer<PersistentChat.Builder> persistentChat) Enable persistent chats.
StartChatContactRequest.Builder	persistentChat(PersistentChat persistentChat) Enable persistent chats.
StartChatContactRequest.Builder	supportedMessagingContentTypes(Collection<String> supportedMessagingContentTypes) The supported chat message content types.
StartChatContactRequest.Builder	supportedMessagingContentTypes(String... supportedMessagingContentTypes) The supported chat message content types.

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

build

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

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

instanceId

StartChatContactRequest.Builder instanceId(String instanceId)

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Parameters:

instanceId - The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Returns:

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

contactFlowId

StartChatContactRequest.Builder contactFlowId(String contactFlowId)

The identifier of the flow for initiating the chat. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/ 846ec553-a005-41c0-8341-xxxxxxxxxxxx

Parameters:

contactFlowId - The identifier of the flow for initiating the chat. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/ 846ec553-a005-41c0-8341-xxxxxxxxxxxx

Returns:

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

attributes

StartChatContactRequest.Builder attributes(Map<String,String> attributes)

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

Parameters:

attributes - A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

Returns:

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

participantDetails

StartChatContactRequest.Builder participantDetails(ParticipantDetails participantDetails)

Information identifying the participant.

Parameters:

participantDetails - Information identifying the participant.

Returns:

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

participantDetails

default StartChatContactRequest.Builder participantDetails(Consumer<ParticipantDetails.Builder> participantDetails)

Information identifying the participant.

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

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

Parameters:

participantDetails - a consumer that will call methods on ParticipantDetails.Builder

Returns:

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

See Also:

participantDetails(ParticipantDetails)

initialMessage

StartChatContactRequest.Builder initialMessage(ChatMessage initialMessage)

The initial message to be sent to the newly created chat.

Parameters:

initialMessage - The initial message to be sent to the newly created chat.

Returns:

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

initialMessage

default StartChatContactRequest.Builder initialMessage(Consumer<ChatMessage.Builder> initialMessage)

The initial message to be sent to the newly created chat.

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

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

Parameters:

initialMessage - a consumer that will call methods on ChatMessage.Builder

Returns:

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

See Also:

initialMessage(ChatMessage)

clientToken

StartChatContactRequest.Builder clientToken(String clientToken)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

Parameters:

clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

Returns:

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

chatDurationInMinutes

StartChatContactRequest.Builder chatDurationInMinutes(Integer chatDurationInMinutes)

The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. The minumum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).

Parameters:

chatDurationInMinutes - The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. The minumum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).

Returns:

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

supportedMessagingContentTypes

StartChatContactRequest.Builder supportedMessagingContentTypes(Collection<String> supportedMessagingContentTypes)

The supported chat message content types. Content types must always contain text/plain. You can then put any other supported type in the list. For example, all the following lists are valid because they contain text/plain: [text/plain, text/markdown, application/json], [text/markdown, text/plain], [text/plain, application/json].

Parameters:

supportedMessagingContentTypes - The supported chat message content types. Content types must always contain text/plain. You can then put any other supported type in the list. For example, all the following lists are valid because they contain text/plain: [text/plain, text/markdown, application/json], [text/markdown, text/plain], [text/plain, application/json].

Returns:

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

supportedMessagingContentTypes

StartChatContactRequest.Builder supportedMessagingContentTypes(String... supportedMessagingContentTypes)

The supported chat message content types. Content types must always contain text/plain. You can then put any other supported type in the list. For example, all the following lists are valid because they contain text/plain: [text/plain, text/markdown, application/json], [text/markdown, text/plain], [text/plain, application/json].

Parameters:

supportedMessagingContentTypes - The supported chat message content types. Content types must always contain text/plain. You can then put any other supported type in the list. For example, all the following lists are valid because they contain text/plain: [text/plain, text/markdown, application/json], [text/markdown, text/plain], [text/plain, application/json].

Returns:

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

persistentChat

StartChatContactRequest.Builder persistentChat(PersistentChat persistentChat)

Enable persistent chats. For more information about enabling persistent chat, and for example use cases and how to configure for them, see Enable persistent chat.

Parameters:

persistentChat - Enable persistent chats. For more information about enabling persistent chat, and for example use cases and how to configure for them, see Enable persistent chat.

Returns:

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

persistentChat

default StartChatContactRequest.Builder persistentChat(Consumer<PersistentChat.Builder> persistentChat)

Enable persistent chats. For more information about enabling persistent chat, and for example use cases and how to configure for them, see Enable persistent chat.

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

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

Parameters:

persistentChat - a consumer that will call methods on PersistentChat.Builder

Returns:

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

See Also:

persistentChat(PersistentChat)

overrideConfiguration

StartChatContactRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder