Interface StartAssistantContactRequest.Builder

All Superinterfaces:

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

Enclosing class:

StartAssistantContactRequest

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

Method Summary

Modifier and Type	Method	Description
default StartAssistantContactRequest.Builder	aiAgent(Consumer<AiAgentInput.Builder> aiAgent)	The AI agent that participates in the contact.
StartAssistantContactRequest.Builder	aiAgent(AiAgentInput aiAgent)	The AI agent that participates in the contact.
StartAssistantContactRequest.Builder	attributes(Map<String,String> attributes)	A map of key-value pairs to associate with the contact.
StartAssistantContactRequest.Builder	clientToken(String clientToken)	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
default StartAssistantContactRequest.Builder	initialMessage(Consumer<ChatMessage.Builder> initialMessage)	The initial message to send to the newly created chat.
StartAssistantContactRequest.Builder	initialMessage(ChatMessage initialMessage)	The initial message to send to the newly created chat.
StartAssistantContactRequest.Builder	instanceId(String instanceId)	The identifier of the Connect Customer instance.
StartAssistantContactRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
StartAssistantContactRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default StartAssistantContactRequest.Builder	participantDetails(Consumer<ParticipantDetails.Builder> participantDetails)	The display name and other details that identify the chat participant.
StartAssistantContactRequest.Builder	participantDetails(ParticipantDetails participantDetails)	The display name and other details that identify the chat participant.
default StartAssistantContactRequest.Builder	persistentChat(Consumer<PersistentChat.Builder> persistentChat)	The configuration that enables persistent chat.
StartAssistantContactRequest.Builder	persistentChat(PersistentChat persistentChat)	The configuration that enables persistent chat.
StartAssistantContactRequest.Builder	relatedContactId(String relatedContactId)	The identifier of an Connect Customer contact related to the new assistant contact.

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

instanceId

StartAssistantContactRequest.Builder instanceId(String instanceId)

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Parameters:

instanceId - The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

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

aiAgent

StartAssistantContactRequest.Builder aiAgent(AiAgentInput aiAgent)

The AI agent that participates in the contact.

Parameters:

aiAgent - The AI agent that participates in the contact.

Returns:

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

aiAgent

default StartAssistantContactRequest.Builder aiAgent(Consumer<AiAgentInput.Builder> aiAgent)

The AI agent that participates in the contact.

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

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

Parameters:

aiAgent - a consumer that will call methods on AiAgentInput.Builder

Returns:

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

See Also:

• aiAgent(AiAgentInput)

participantDetails

StartAssistantContactRequest.Builder participantDetails(ParticipantDetails participantDetails)

The display name and other details that identify the chat participant.

Parameters:

participantDetails - The display name and other details that identify the chat participant.

Returns:

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

participantDetails

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

The display name and other details that identify the chat 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

StartAssistantContactRequest.Builder initialMessage(ChatMessage initialMessage)

The initial message to send to the newly created chat.

Parameters:

initialMessage - The initial message to send to the newly created chat.

Returns:

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

initialMessage

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

The initial message to send 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)

attributes

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

A map of key-value pairs to associate with the contact. Amazon Connect makes these attributes available to flows as standard contact attributes.

You can provide up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can contain only alphanumeric characters, dashes, and underscores.

Parameters:

attributes - A map of key-value pairs to associate with the contact. Amazon Connect makes these attributes available to flows as standard contact attributes.

You can provide up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can contain only alphanumeric characters, dashes, and underscores.

Returns:

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

clientToken

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

persistentChat

StartAssistantContactRequest.Builder persistentChat(PersistentChat persistentChat)

The configuration that enables persistent chat. For more information about persistent chat and its use cases, see Enable persistent chat.

Parameters:

persistentChat - The configuration that enables persistent chat. For more information about persistent chat and its use cases, see Enable persistent chat.

Returns:

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

persistentChat

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

The configuration that enables persistent chat. For more information about persistent chat and its use cases, 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)

relatedContactId

StartAssistantContactRequest.Builder relatedContactId(String relatedContactId)

The identifier of an Connect Customer contact related to the new assistant contact.

You cannot provide both RelatedContactId and PersistentChat.

Parameters:

relatedContactId - The identifier of an Connect Customer contact related to the new assistant contact.

You cannot provide both RelatedContactId and PersistentChat.

Returns:

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

overrideConfiguration

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

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