Package software.amazon.awssdk.services.lexmodelsv2.model

Interface DescribeIntentResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeIntentResponse.Builder,DescribeIntentResponse>, LexModelsV2Response.Builder, SdkBuilder<DescribeIntentResponse.Builder,DescribeIntentResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribeIntentResponse

public static interface DescribeIntentResponse.Builder
extends LexModelsV2Response.Builder, SdkPojo, CopyableBuilder<DescribeIntentResponse.Builder,DescribeIntentResponse>

Method Summary

Modifier and Type	Method	Description
DescribeIntentResponse.Builder	botId(String botId)	The identifier of the bot associated with the intent.
DescribeIntentResponse.Builder	botVersion(String botVersion)	The version of the bot associated with the intent.
DescribeIntentResponse.Builder	creationDateTime(Instant creationDateTime)	A timestamp of the date and time that the intent was created.
DescribeIntentResponse.Builder	description(String description)	The description of the intent.
default DescribeIntentResponse.Builder	dialogCodeHook(Consumer<DialogCodeHookSettings.Builder> dialogCodeHook)	The Lambda function called during each turn of a conversation with the intent.
DescribeIntentResponse.Builder	dialogCodeHook(DialogCodeHookSettings dialogCodeHook)	The Lambda function called during each turn of a conversation with the intent.
default DescribeIntentResponse.Builder	fulfillmentCodeHook(Consumer<FulfillmentCodeHookSettings.Builder> fulfillmentCodeHook)	The Lambda function called when the intent is complete and ready for fulfillment.
DescribeIntentResponse.Builder	fulfillmentCodeHook(FulfillmentCodeHookSettings fulfillmentCodeHook)	The Lambda function called when the intent is complete and ready for fulfillment.
default DescribeIntentResponse.Builder	initialResponseSetting(Consumer<InitialResponseSetting.Builder> initialResponseSetting)	Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.
DescribeIntentResponse.Builder	initialResponseSetting(InitialResponseSetting initialResponseSetting)	Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.
DescribeIntentResponse.Builder	inputContexts(Collection<InputContext> inputContexts)	A list of contexts that must be active for the intent to be considered for sending to the user.
DescribeIntentResponse.Builder	inputContexts(Consumer<InputContext.Builder>... inputContexts)	A list of contexts that must be active for the intent to be considered for sending to the user.
DescribeIntentResponse.Builder	inputContexts(InputContext... inputContexts)	A list of contexts that must be active for the intent to be considered for sending to the user.
default DescribeIntentResponse.Builder	intentClosingSetting(Consumer<IntentClosingSetting.Builder> intentClosingSetting)	The response that Amazon Lex sends to when the intent is closed.
DescribeIntentResponse.Builder	intentClosingSetting(IntentClosingSetting intentClosingSetting)	The response that Amazon Lex sends to when the intent is closed.
default DescribeIntentResponse.Builder	intentConfirmationSetting(Consumer<IntentConfirmationSetting.Builder> intentConfirmationSetting)	Prompts that Amazon Lex sends to the user to confirm completion of an intent.
DescribeIntentResponse.Builder	intentConfirmationSetting(IntentConfirmationSetting intentConfirmationSetting)	Prompts that Amazon Lex sends to the user to confirm completion of an intent.
DescribeIntentResponse.Builder	intentId(String intentId)	The unique identifier assigned to the intent when it was created.
DescribeIntentResponse.Builder	intentName(String intentName)	The name specified for the intent.
default DescribeIntentResponse.Builder	kendraConfiguration(Consumer<KendraConfiguration.Builder> kendraConfiguration)	Configuration information required to use the AMAZON.KendraSearchIntent intent.
DescribeIntentResponse.Builder	kendraConfiguration(KendraConfiguration kendraConfiguration)	Configuration information required to use the AMAZON.KendraSearchIntent intent.
DescribeIntentResponse.Builder	lastUpdatedDateTime(Instant lastUpdatedDateTime)	A timestamp of the date and time that the intent was last updated.
DescribeIntentResponse.Builder	localeId(String localeId)	The language and locale specified for the intent.
DescribeIntentResponse.Builder	outputContexts(Collection<OutputContext> outputContexts)	A list of contexts that are activated when the intent is fulfilled.
DescribeIntentResponse.Builder	outputContexts(Consumer<OutputContext.Builder>... outputContexts)	A list of contexts that are activated when the intent is fulfilled.
DescribeIntentResponse.Builder	outputContexts(OutputContext... outputContexts)	A list of contexts that are activated when the intent is fulfilled.
DescribeIntentResponse.Builder	parentIntentSignature(String parentIntentSignature)	The identifier of the built-in intent that this intent is derived from, if any.
default DescribeIntentResponse.Builder	qnAIntentConfiguration(Consumer<QnAIntentConfiguration.Builder> qnAIntentConfiguration)	Details about the configuration of the built-in Amazon.QnAIntent.
DescribeIntentResponse.Builder	qnAIntentConfiguration(QnAIntentConfiguration qnAIntentConfiguration)	Details about the configuration of the built-in Amazon.QnAIntent.
DescribeIntentResponse.Builder	sampleUtterances(Collection<SampleUtterance> sampleUtterances)	User utterances that trigger this intent.
DescribeIntentResponse.Builder	sampleUtterances(Consumer<SampleUtterance.Builder>... sampleUtterances)	User utterances that trigger this intent.
DescribeIntentResponse.Builder	sampleUtterances(SampleUtterance... sampleUtterances)	User utterances that trigger this intent.
DescribeIntentResponse.Builder	slotPriorities(Collection<SlotPriority> slotPriorities)	The list that determines the priority that slots should be elicited from the user.
DescribeIntentResponse.Builder	slotPriorities(Consumer<SlotPriority.Builder>... slotPriorities)	The list that determines the priority that slots should be elicited from the user.
DescribeIntentResponse.Builder	slotPriorities(SlotPriority... slotPriorities)	The list that determines the priority that slots should be elicited from the user.

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

copy

Methods inherited from interface software.amazon.awssdk.services.lexmodelsv2.model.LexModelsV2Response.Builder

build, responseMetadata, responseMetadata

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

applyMutation, build

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

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Details

intentId

DescribeIntentResponse.Builder intentId(String intentId)

The unique identifier assigned to the intent when it was created.

Parameters:

intentId - The unique identifier assigned to the intent when it was created.

Returns:

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

intentName

DescribeIntentResponse.Builder intentName(String intentName)

The name specified for the intent.

Parameters:

intentName - The name specified for the intent.

Returns:

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

description

DescribeIntentResponse.Builder description(String description)

The description of the intent.

Parameters:

description - The description of the intent.

Returns:

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

parentIntentSignature

DescribeIntentResponse.Builder parentIntentSignature(String parentIntentSignature)

The identifier of the built-in intent that this intent is derived from, if any.

Parameters:

parentIntentSignature - The identifier of the built-in intent that this intent is derived from, if any.

Returns:

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

sampleUtterances

DescribeIntentResponse.Builder sampleUtterances(Collection<SampleUtterance> sampleUtterances)

User utterances that trigger this intent.

Parameters:

sampleUtterances - User utterances that trigger this intent.

Returns:

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

sampleUtterances

DescribeIntentResponse.Builder sampleUtterances(SampleUtterance... sampleUtterances)

User utterances that trigger this intent.

Parameters:

sampleUtterances - User utterances that trigger this intent.

Returns:

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

sampleUtterances

DescribeIntentResponse.Builder sampleUtterances(Consumer<SampleUtterance.Builder>... sampleUtterances)

User utterances that trigger this intent.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sampleUtterances(List<SampleUtterance>).

Parameters:

sampleUtterances - a consumer that will call methods on SampleUtterance.Builder

Returns:

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

See Also:

• sampleUtterances(java.util.Collection<SampleUtterance>)

dialogCodeHook

DescribeIntentResponse.Builder dialogCodeHook(DialogCodeHookSettings dialogCodeHook)

The Lambda function called during each turn of a conversation with the intent.

Parameters:

dialogCodeHook - The Lambda function called during each turn of a conversation with the intent.

Returns:

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

dialogCodeHook

default DescribeIntentResponse.Builder dialogCodeHook(Consumer<DialogCodeHookSettings.Builder> dialogCodeHook)

The Lambda function called during each turn of a conversation with the intent.

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

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

Parameters:

dialogCodeHook - a consumer that will call methods on DialogCodeHookSettings.Builder

Returns:

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

See Also:

• dialogCodeHook(DialogCodeHookSettings)

fulfillmentCodeHook

DescribeIntentResponse.Builder fulfillmentCodeHook(FulfillmentCodeHookSettings fulfillmentCodeHook)

The Lambda function called when the intent is complete and ready for fulfillment.

Parameters:

fulfillmentCodeHook - The Lambda function called when the intent is complete and ready for fulfillment.

Returns:

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

fulfillmentCodeHook

default DescribeIntentResponse.Builder fulfillmentCodeHook(Consumer<FulfillmentCodeHookSettings.Builder> fulfillmentCodeHook)

The Lambda function called when the intent is complete and ready for fulfillment.

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

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

Parameters:

fulfillmentCodeHook - a consumer that will call methods on FulfillmentCodeHookSettings.Builder

Returns:

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

See Also:

• fulfillmentCodeHook(FulfillmentCodeHookSettings)

slotPriorities

DescribeIntentResponse.Builder slotPriorities(Collection<SlotPriority> slotPriorities)

The list that determines the priority that slots should be elicited from the user.

Parameters:

slotPriorities - The list that determines the priority that slots should be elicited from the user.

Returns:

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

slotPriorities

DescribeIntentResponse.Builder slotPriorities(SlotPriority... slotPriorities)

The list that determines the priority that slots should be elicited from the user.

Parameters:

slotPriorities - The list that determines the priority that slots should be elicited from the user.

Returns:

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

slotPriorities

DescribeIntentResponse.Builder slotPriorities(Consumer<SlotPriority.Builder>... slotPriorities)

The list that determines the priority that slots should be elicited from the user.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to slotPriorities(List<SlotPriority>).

Parameters:

slotPriorities - a consumer that will call methods on SlotPriority.Builder

Returns:

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

See Also:

• slotPriorities(java.util.Collection<SlotPriority>)

intentConfirmationSetting

DescribeIntentResponse.Builder intentConfirmationSetting(IntentConfirmationSetting intentConfirmationSetting)

Prompts that Amazon Lex sends to the user to confirm completion of an intent.

Parameters:

intentConfirmationSetting - Prompts that Amazon Lex sends to the user to confirm completion of an intent.

Returns:

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

intentConfirmationSetting

default DescribeIntentResponse.Builder intentConfirmationSetting(Consumer<IntentConfirmationSetting.Builder> intentConfirmationSetting)

Prompts that Amazon Lex sends to the user to confirm completion of an intent.

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

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

Parameters:

intentConfirmationSetting - a consumer that will call methods on IntentConfirmationSetting.Builder

Returns:

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

See Also:

• intentConfirmationSetting(IntentConfirmationSetting)

intentClosingSetting

DescribeIntentResponse.Builder intentClosingSetting(IntentClosingSetting intentClosingSetting)

The response that Amazon Lex sends to when the intent is closed.

Parameters:

intentClosingSetting - The response that Amazon Lex sends to when the intent is closed.

Returns:

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

intentClosingSetting

default DescribeIntentResponse.Builder intentClosingSetting(Consumer<IntentClosingSetting.Builder> intentClosingSetting)

The response that Amazon Lex sends to when the intent is closed.

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

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

Parameters:

intentClosingSetting - a consumer that will call methods on IntentClosingSetting.Builder

Returns:

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

See Also:

• intentClosingSetting(IntentClosingSetting)

inputContexts

DescribeIntentResponse.Builder inputContexts(Collection<InputContext> inputContexts)

A list of contexts that must be active for the intent to be considered for sending to the user.

Parameters:

inputContexts - A list of contexts that must be active for the intent to be considered for sending to the user.

Returns:

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

inputContexts

DescribeIntentResponse.Builder inputContexts(InputContext... inputContexts)

A list of contexts that must be active for the intent to be considered for sending to the user.

Parameters:

inputContexts - A list of contexts that must be active for the intent to be considered for sending to the user.

Returns:

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

inputContexts

DescribeIntentResponse.Builder inputContexts(Consumer<InputContext.Builder>... inputContexts)

A list of contexts that must be active for the intent to be considered for sending to the user.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to inputContexts(List<InputContext>).

Parameters:

inputContexts - a consumer that will call methods on InputContext.Builder

Returns:

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

See Also:

• inputContexts(java.util.Collection<InputContext>)

outputContexts

DescribeIntentResponse.Builder outputContexts(Collection<OutputContext> outputContexts)

A list of contexts that are activated when the intent is fulfilled.

Parameters:

outputContexts - A list of contexts that are activated when the intent is fulfilled.

Returns:

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

outputContexts

DescribeIntentResponse.Builder outputContexts(OutputContext... outputContexts)

A list of contexts that are activated when the intent is fulfilled.

Parameters:

outputContexts - A list of contexts that are activated when the intent is fulfilled.

Returns:

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

outputContexts

DescribeIntentResponse.Builder outputContexts(Consumer<OutputContext.Builder>... outputContexts)

A list of contexts that are activated when the intent is fulfilled.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to outputContexts(List<OutputContext>).

Parameters:

outputContexts - a consumer that will call methods on OutputContext.Builder

Returns:

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

See Also:

• outputContexts(java.util.Collection<OutputContext>)

kendraConfiguration

DescribeIntentResponse.Builder kendraConfiguration(KendraConfiguration kendraConfiguration)

Configuration information required to use the AMAZON.KendraSearchIntent intent.

Parameters:

kendraConfiguration - Configuration information required to use the AMAZON.KendraSearchIntent intent.

Returns:

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

kendraConfiguration

default DescribeIntentResponse.Builder kendraConfiguration(Consumer<KendraConfiguration.Builder> kendraConfiguration)

Configuration information required to use the AMAZON.KendraSearchIntent intent.

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

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

Parameters:

kendraConfiguration - a consumer that will call methods on KendraConfiguration.Builder

Returns:

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

See Also:

• kendraConfiguration(KendraConfiguration)

botId

DescribeIntentResponse.Builder botId(String botId)

The identifier of the bot associated with the intent.

Parameters:

botId - The identifier of the bot associated with the intent.

Returns:

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

botVersion

DescribeIntentResponse.Builder botVersion(String botVersion)

The version of the bot associated with the intent.

Parameters:

botVersion - The version of the bot associated with the intent.

Returns:

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

localeId

DescribeIntentResponse.Builder localeId(String localeId)

The language and locale specified for the intent.

Parameters:

localeId - The language and locale specified for the intent.

Returns:

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

creationDateTime

DescribeIntentResponse.Builder creationDateTime(Instant creationDateTime)

A timestamp of the date and time that the intent was created.

Parameters:

creationDateTime - A timestamp of the date and time that the intent was created.

Returns:

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

lastUpdatedDateTime

DescribeIntentResponse.Builder lastUpdatedDateTime(Instant lastUpdatedDateTime)

A timestamp of the date and time that the intent was last updated.

Parameters:

lastUpdatedDateTime - A timestamp of the date and time that the intent was last updated.

Returns:

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

initialResponseSetting

DescribeIntentResponse.Builder initialResponseSetting(InitialResponseSetting initialResponseSetting)

Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.

Parameters:

initialResponseSetting - Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.

Returns:

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

initialResponseSetting

default DescribeIntentResponse.Builder initialResponseSetting(Consumer<InitialResponseSetting.Builder> initialResponseSetting)

Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.

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

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

Parameters:

initialResponseSetting - a consumer that will call methods on InitialResponseSetting.Builder

Returns:

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

See Also:

• initialResponseSetting(InitialResponseSetting)

qnAIntentConfiguration

DescribeIntentResponse.Builder qnAIntentConfiguration(QnAIntentConfiguration qnAIntentConfiguration)

Details about the configuration of the built-in Amazon.QnAIntent.

Parameters:

qnAIntentConfiguration - Details about the configuration of the built-in Amazon.QnAIntent.

Returns:

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

qnAIntentConfiguration

default DescribeIntentResponse.Builder qnAIntentConfiguration(Consumer<QnAIntentConfiguration.Builder> qnAIntentConfiguration)

Details about the configuration of the built-in Amazon.QnAIntent.

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

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

Parameters:

qnAIntentConfiguration - a consumer that will call methods on QnAIntentConfiguration.Builder

Returns:

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

See Also:

• qnAIntentConfiguration(QnAIntentConfiguration)