software.amazon.awssdk.services.lexmodelsv2.model

Interface SessionSpecification.Builder

All Superinterfaces:

Buildable, CopyableBuilder<SessionSpecification.Builder,SessionSpecification>, SdkBuilder<SessionSpecification.Builder,SessionSpecification>, SdkPojo

Enclosing class:

SessionSpecification

public static interface SessionSpecification.Builder
extends SdkPojo, CopyableBuilder<SessionSpecification.Builder,SessionSpecification>

Method Summary

Modifier and Type	Method and Description
SessionSpecification.Builder	botAliasId(String botAliasId) The identifier of the alias of the bot that the session was held with.
SessionSpecification.Builder	botVersion(String botVersion) The version of the bot that the session was held with.
SessionSpecification.Builder	channel(String channel) The channel that is integrated with the bot that the session was held with.
SessionSpecification.Builder	conversationDurationSeconds(Long conversationDurationSeconds) The duration of the conversation in seconds.
SessionSpecification.Builder	conversationEndState(ConversationEndState conversationEndState) The final state of the conversation.
SessionSpecification.Builder	conversationEndState(String conversationEndState) The final state of the conversation.
SessionSpecification.Builder	conversationEndTime(Instant conversationEndTime) The date and time when the conversation ended.
SessionSpecification.Builder	conversationStartTime(Instant conversationStartTime) The date and time when the conversation began.
SessionSpecification.Builder	invokedIntentSamples(Collection<InvokedIntentSample> invokedIntentSamples) A list of objects containing the name of an intent that was invoked.
SessionSpecification.Builder	invokedIntentSamples(Consumer<InvokedIntentSample.Builder>... invokedIntentSamples) A list of objects containing the name of an intent that was invoked.
SessionSpecification.Builder	invokedIntentSamples(InvokedIntentSample... invokedIntentSamples) A list of objects containing the name of an intent that was invoked.
SessionSpecification.Builder	localeId(String localeId) The locale of the bot that the session was held with.
SessionSpecification.Builder	mode(AnalyticsModality mode) The mode of the session.
SessionSpecification.Builder	mode(String mode) The mode of the session.
SessionSpecification.Builder	numberOfTurns(Long numberOfTurns) The number of turns that the session took.
SessionSpecification.Builder	originatingRequestId(String originatingRequestId) The identifier of the first request in a session.
SessionSpecification.Builder	sessionId(String sessionId) The identifier of the session.

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

botAliasId

SessionSpecification.Builder botAliasId(String botAliasId)

The identifier of the alias of the bot that the session was held with.

Parameters:

botAliasId - The identifier of the alias of the bot that the session was held with.

Returns:

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

botVersion

SessionSpecification.Builder botVersion(String botVersion)

The version of the bot that the session was held with.

Parameters:

botVersion - The version of the bot that the session was held with.

Returns:

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

localeId

SessionSpecification.Builder localeId(String localeId)

The locale of the bot that the session was held with.

Parameters:

localeId - The locale of the bot that the session was held with.

Returns:

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

channel

SessionSpecification.Builder channel(String channel)

The channel that is integrated with the bot that the session was held with.

Parameters:

channel - The channel that is integrated with the bot that the session was held with.

Returns:

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

sessionId

SessionSpecification.Builder sessionId(String sessionId)

The identifier of the session.

Parameters:

sessionId - The identifier of the session.

Returns:

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

conversationStartTime

SessionSpecification.Builder conversationStartTime(Instant conversationStartTime)

The date and time when the conversation began. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.

Parameters:

conversationStartTime - The date and time when the conversation began. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.

Returns:

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

conversationEndTime

SessionSpecification.Builder conversationEndTime(Instant conversationEndTime)

The date and time when the conversation ended. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.

Parameters:

conversationEndTime - The date and time when the conversation ended. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.

Returns:

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

conversationDurationSeconds

SessionSpecification.Builder conversationDurationSeconds(Long conversationDurationSeconds)

The duration of the conversation in seconds. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.

Parameters:

conversationDurationSeconds - The duration of the conversation in seconds. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.

Returns:

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

conversationEndState

SessionSpecification.Builder conversationEndState(String conversationEndState)

The final state of the conversation. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.

Parameters:

conversationEndState - The final state of the conversation. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.

Returns:

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

See Also:

ConversationEndState, ConversationEndState

conversationEndState

SessionSpecification.Builder conversationEndState(ConversationEndState conversationEndState)

The final state of the conversation. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.

Parameters:

conversationEndState - The final state of the conversation. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.

Returns:

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

See Also:

ConversationEndState, ConversationEndState

mode

SessionSpecification.Builder mode(String mode)

The mode of the session. The possible values are as follows:

• Speech – The session was spoken.

• Text – The session was written.

• DTMF – The session used a touch-tone keypad (Dual Tone Multi-Frequency).

• MultiMode – The session used multiple modes.

Parameters:

mode - The mode of the session. The possible values are as follows:

• Speech – The session was spoken.

• Text – The session was written.

• DTMF – The session used a touch-tone keypad (Dual Tone Multi-Frequency).

• MultiMode – The session used multiple modes.

Returns:

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

See Also:

AnalyticsModality, AnalyticsModality

mode

SessionSpecification.Builder mode(AnalyticsModality mode)

The mode of the session. The possible values are as follows:

• Speech – The session was spoken.

• Text – The session was written.

• DTMF – The session used a touch-tone keypad (Dual Tone Multi-Frequency).

• MultiMode – The session used multiple modes.

Parameters:

mode - The mode of the session. The possible values are as follows:

• Speech – The session was spoken.

• Text – The session was written.

• DTMF – The session used a touch-tone keypad (Dual Tone Multi-Frequency).

• MultiMode – The session used multiple modes.

Returns:

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

See Also:

AnalyticsModality, AnalyticsModality

numberOfTurns

SessionSpecification.Builder numberOfTurns(Long numberOfTurns)

The number of turns that the session took.

Parameters:

numberOfTurns - The number of turns that the session took.

Returns:

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

invokedIntentSamples

SessionSpecification.Builder invokedIntentSamples(Collection<InvokedIntentSample> invokedIntentSamples)

A list of objects containing the name of an intent that was invoked.

Parameters:

invokedIntentSamples - A list of objects containing the name of an intent that was invoked.

Returns:

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

invokedIntentSamples

SessionSpecification.Builder invokedIntentSamples(InvokedIntentSample... invokedIntentSamples)

A list of objects containing the name of an intent that was invoked.

Parameters:

invokedIntentSamples - A list of objects containing the name of an intent that was invoked.

Returns:

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

invokedIntentSamples

SessionSpecification.Builder invokedIntentSamples(Consumer<InvokedIntentSample.Builder>... invokedIntentSamples)

A list of objects containing the name of an intent that was invoked.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #invokedIntentSamples(List).

Parameters:

invokedIntentSamples - a consumer that will call methods on InvokedIntentSample.Builder

Returns:

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

See Also:

#invokedIntentSamples(java.util.Collection)

originatingRequestId

SessionSpecification.Builder originatingRequestId(String originatingRequestId)

The identifier of the first request in a session.

Parameters:

originatingRequestId - The identifier of the first request in a session.

Returns:

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