/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.lexmodelbuilding.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class PutIntentRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* The name of the intent. The name is not case sensitive. *
*
* The name can't match a built-in intent name, or a built-in intent name with "AMAZON." removed. For example,
* because there is a built-in intent called AMAZON.HelpIntent
, you can't create a custom intent called
* HelpIntent
.
*
* For a list of built-in intents, see Standard Built-in Intents in the Alexa Skills Kit. *
*/ private String name; /** ** A description of the intent. *
*/ private String description; /** ** An array of intent slots. At runtime, Amazon Lex elicits required slot values from the user using prompts defined * in the slots. For more information, see how-it-works. *
*/ private java.util.List* An array of utterances (strings) that a user might say to signal the intent. For example, * "I want {PizzaSize} pizza", "Order {Quantity} {PizzaSize} pizzas". *
** In each utterance, a slot name is enclosed in curly braces. *
*/ private java.util.List* Prompts the user to confirm the intent. This question should have a yes or no answer. *
*
* Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For
* example, with the OrderPizza
intent, you might want to confirm that the order is correct before
* placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask
* the user for confirmation before providing the information.
*
* You you must provide both the rejectionStatement
and the confirmationPrompt
, or
* neither.
*
* When the user answers "no" to the question defined in confirmationPrompt
, Amazon Lex responds with
* this statement to acknowledge that the intent was canceled.
*
* You must provide both the rejectionStatement
and the confirmationPrompt
, or neither.
*
* Amazon Lex uses this prompt to solicit additional activity after fulfilling an intent. For example, after the
* OrderPizza
intent is fulfilled, you might prompt the user to order a drink.
*
* The action that Amazon Lex takes depends on the user's response, as follows: *
** If the user says "Yes" it responds with the clarification prompt that is configured for the bot. *
** if the user says "Yes" and continues with an utterance that triggers an intent it starts a conversation for the * intent. *
** If the user says "No" it responds with the rejection statement configured for the the follow-up prompt. *
** If it doesn't recognize the utterance it repeats the follow-up prompt again. *
*
* The followUpPrompt
field and the conclusionStatement
field are mutually exclusive. You
* can specify only one.
*
* The statement that you want Amazon Lex to convey to the user after the intent is successfully fulfilled by the * Lambda function. *
*
* This element is relevant only if you provide a Lambda function in the fulfillmentActivity
. If you
* return the intent to the client application, you can't specify this element.
*
* The followUpPrompt
and conclusionStatement
are mutually exclusive. You can specify only
* one.
*
* Specifies a Lambda function to invoke for each user input. You can invoke this Lambda function to personalize * user interaction. *
*
* For example, suppose your bot determines that the user is John. Your Lambda function might retrieve John's
* information from a backend database and prepopulate some of the values. For example, if you find that John is
* gluten intolerant, you might set the corresponding intent slot, GlutenIntolerant
, to true. You might
* find John's phone number and set the corresponding session attribute.
*
* Required. Describes how the intent is fulfilled. For example, after a user provides all of the information for a
* pizza order, fulfillmentActivity
defines how the bot places an order with a local pizza store.
*
* You might configure Amazon Lex to return all of the intent information to the client application, or direct it to * invoke a Lambda function that can process the intent (for example, place an order with a pizzeria). *
*/ private FulfillmentActivity fulfillmentActivity; /** ** A unique identifier for the built-in intent to base this intent on. To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit. *
*/ private String parentIntentSignature; /** *
* Identifies a specific revision of the $LATEST
version.
*
* When you create a new intent, leave the checksum
field blank. If you specify a checksum you get a
* BadRequestException
exception.
*
* When you want to update a intent, set the checksum
field to the checksum of the most recent revision
* of the $LATEST
version. If you don't specify the checksum
field, or if the checksum
* does not match the $LATEST
version, you get a PreconditionFailedException
exception.
*
* When set to true
a new numbered version of the intent is created. This is the same as calling the
* CreateIntentVersion
operation. If you do not specify createVersion
, the default is
* false
.
*
* Configuration information required to use the AMAZON.KendraSearchIntent
intent to connect to an
* Amazon Kendra index. For more information, see
* AMAZON.KendraSearchIntent.
*
* An array of InputContext
objects that lists the contexts that must be active for Amazon Lex to
* choose the intent in a conversation with the user.
*
* An array of OutputContext
objects that lists the contexts that the intent activates when the intent
* is fulfilled.
*
* The name of the intent. The name is not case sensitive. *
*
* The name can't match a built-in intent name, or a built-in intent name with "AMAZON." removed. For example,
* because there is a built-in intent called AMAZON.HelpIntent
, you can't create a custom intent called
* HelpIntent
.
*
* For a list of built-in intents, see Standard Built-in Intents in the Alexa Skills Kit. *
* * @param name * The name of the intent. The name is not case sensitive. *
* The name can't match a built-in intent name, or a built-in intent name with "AMAZON." removed. For
* example, because there is a built-in intent called AMAZON.HelpIntent
, you can't create a
* custom intent called HelpIntent
.
*
* For a list of built-in intents, see Standard Built-in Intents in the Alexa Skills Kit. */ public void setName(String name) { this.name = name; } /** *
* The name of the intent. The name is not case sensitive. *
*
* The name can't match a built-in intent name, or a built-in intent name with "AMAZON." removed. For example,
* because there is a built-in intent called AMAZON.HelpIntent
, you can't create a custom intent called
* HelpIntent
.
*
* For a list of built-in intents, see Standard Built-in Intents in the Alexa Skills Kit. *
* * @return The name of the intent. The name is not case sensitive. *
* The name can't match a built-in intent name, or a built-in intent name with "AMAZON." removed. For
* example, because there is a built-in intent called AMAZON.HelpIntent
, you can't create a
* custom intent called HelpIntent
.
*
* For a list of built-in intents, see Standard Built-in Intents in the Alexa Skills Kit. */ public String getName() { return this.name; } /** *
* The name of the intent. The name is not case sensitive. *
*
* The name can't match a built-in intent name, or a built-in intent name with "AMAZON." removed. For example,
* because there is a built-in intent called AMAZON.HelpIntent
, you can't create a custom intent called
* HelpIntent
.
*
* For a list of built-in intents, see Standard Built-in Intents in the Alexa Skills Kit. *
* * @param name * The name of the intent. The name is not case sensitive. *
* The name can't match a built-in intent name, or a built-in intent name with "AMAZON." removed. For
* example, because there is a built-in intent called AMAZON.HelpIntent
, you can't create a
* custom intent called HelpIntent
.
*
* For a list of built-in intents, see Standard Built-in Intents in the Alexa Skills Kit. * @return Returns a reference to this object so that method calls can be chained together. */ public PutIntentRequest withName(String name) { setName(name); return this; } /** *
* A description of the intent. *
* * @param description * A description of the intent. */ public void setDescription(String description) { this.description = description; } /** ** A description of the intent. *
* * @return A description of the intent. */ public String getDescription() { return this.description; } /** ** A description of the intent. *
* * @param description * A description of the intent. * @return Returns a reference to this object so that method calls can be chained together. */ public PutIntentRequest withDescription(String description) { setDescription(description); return this; } /** ** An array of intent slots. At runtime, Amazon Lex elicits required slot values from the user using prompts defined * in the slots. For more information, see how-it-works. *
* * @return An array of intent slots. At runtime, Amazon Lex elicits required slot values from the user using prompts * defined in the slots. For more information, see how-it-works. */ public java.util.List* An array of intent slots. At runtime, Amazon Lex elicits required slot values from the user using prompts defined * in the slots. For more information, see how-it-works. *
* * @param slots * An array of intent slots. At runtime, Amazon Lex elicits required slot values from the user using prompts * defined in the slots. For more information, see how-it-works. */ public void setSlots(java.util.Collection* An array of intent slots. At runtime, Amazon Lex elicits required slot values from the user using prompts defined * in the slots. For more information, see how-it-works. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setSlots(java.util.Collection)} or {@link #withSlots(java.util.Collection)} if you want to override the * existing values. *
* * @param slots * An array of intent slots. At runtime, Amazon Lex elicits required slot values from the user using prompts * defined in the slots. For more information, see how-it-works. * @return Returns a reference to this object so that method calls can be chained together. */ public PutIntentRequest withSlots(Slot... slots) { if (this.slots == null) { setSlots(new java.util.ArrayList* An array of intent slots. At runtime, Amazon Lex elicits required slot values from the user using prompts defined * in the slots. For more information, see how-it-works. *
* * @param slots * An array of intent slots. At runtime, Amazon Lex elicits required slot values from the user using prompts * defined in the slots. For more information, see how-it-works. * @return Returns a reference to this object so that method calls can be chained together. */ public PutIntentRequest withSlots(java.util.Collection* An array of utterances (strings) that a user might say to signal the intent. For example, * "I want {PizzaSize} pizza", "Order {Quantity} {PizzaSize} pizzas". *
** In each utterance, a slot name is enclosed in curly braces. *
* * @return An array of utterances (strings) that a user might say to signal the intent. For example, * "I want {PizzaSize} pizza", "Order {Quantity} {PizzaSize} pizzas". *
* In each utterance, a slot name is enclosed in curly braces.
*/
public java.util.List
* An array of utterances (strings) that a user might say to signal the intent. For example,
* "I want {PizzaSize} pizza", "Order {Quantity} {PizzaSize} pizzas".
*
* In each utterance, a slot name is enclosed in curly braces.
*
* In each utterance, a slot name is enclosed in curly braces.
*/
public void setSampleUtterances(java.util.Collection
* An array of utterances (strings) that a user might say to signal the intent. For example,
* "I want {PizzaSize} pizza", "Order {Quantity} {PizzaSize} pizzas".
*
* In each utterance, a slot name is enclosed in curly braces.
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setSampleUtterances(java.util.Collection)} or {@link #withSampleUtterances(java.util.Collection)} if you
* want to override the existing values.
*
* In each utterance, a slot name is enclosed in curly braces.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutIntentRequest withSampleUtterances(String... sampleUtterances) {
if (this.sampleUtterances == null) {
setSampleUtterances(new java.util.ArrayList
* An array of utterances (strings) that a user might say to signal the intent. For example,
* "I want {PizzaSize} pizza", "Order {Quantity} {PizzaSize} pizzas".
*
* In each utterance, a slot name is enclosed in curly braces.
*
* In each utterance, a slot name is enclosed in curly braces.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutIntentRequest withSampleUtterances(java.util.Collection
* Prompts the user to confirm the intent. This question should have a yes or no answer.
*
* Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For
* example, with the
* You you must provide both the OrderPizza
intent, you might want to confirm that the order is correct before
* placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask
* the user for confirmation before providing the information.
* rejectionStatement
and the confirmationPrompt
, or
* neither.
*
* Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment.
* For example, with the OrderPizza
intent, you might want to confirm that the order is correct
* before placing it. For other intents, such as intents that simply respond to user questions, you might not
* need to ask the user for confirmation before providing the information.
*
* You you must provide both the rejectionStatement
and the confirmationPrompt
, or
* neither.
*
* Prompts the user to confirm the intent. This question should have a yes or no answer. *
*
* Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For
* example, with the OrderPizza
intent, you might want to confirm that the order is correct before
* placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask
* the user for confirmation before providing the information.
*
* You you must provide both the rejectionStatement
and the confirmationPrompt
, or
* neither.
*
* Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for
* fulfillment. For example, with the OrderPizza
intent, you might want to confirm that the
* order is correct before placing it. For other intents, such as intents that simply respond to user
* questions, you might not need to ask the user for confirmation before providing the information.
*
* You you must provide both the rejectionStatement
and the confirmationPrompt
, or
* neither.
*
* Prompts the user to confirm the intent. This question should have a yes or no answer. *
*
* Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For
* example, with the OrderPizza
intent, you might want to confirm that the order is correct before
* placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask
* the user for confirmation before providing the information.
*
* You you must provide both the rejectionStatement
and the confirmationPrompt
, or
* neither.
*
* Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment.
* For example, with the OrderPizza
intent, you might want to confirm that the order is correct
* before placing it. For other intents, such as intents that simply respond to user questions, you might not
* need to ask the user for confirmation before providing the information.
*
* You you must provide both the rejectionStatement
and the confirmationPrompt
, or
* neither.
*
* When the user answers "no" to the question defined in confirmationPrompt
, Amazon Lex responds with
* this statement to acknowledge that the intent was canceled.
*
* You must provide both the rejectionStatement
and the confirmationPrompt
, or neither.
*
confirmationPrompt
, Amazon Lex responds
* with this statement to acknowledge that the intent was canceled.
* You must provide both the rejectionStatement
and the confirmationPrompt
, or
* neither.
*
* When the user answers "no" to the question defined in confirmationPrompt
, Amazon Lex responds with
* this statement to acknowledge that the intent was canceled.
*
* You must provide both the rejectionStatement
and the confirmationPrompt
, or neither.
*
confirmationPrompt
, Amazon Lex
* responds with this statement to acknowledge that the intent was canceled.
* You must provide both the rejectionStatement
and the confirmationPrompt
, or
* neither.
*
* When the user answers "no" to the question defined in confirmationPrompt
, Amazon Lex responds with
* this statement to acknowledge that the intent was canceled.
*
* You must provide both the rejectionStatement
and the confirmationPrompt
, or neither.
*
confirmationPrompt
, Amazon Lex responds
* with this statement to acknowledge that the intent was canceled.
* You must provide both the rejectionStatement
and the confirmationPrompt
, or
* neither.
*
* Amazon Lex uses this prompt to solicit additional activity after fulfilling an intent. For example, after the
* OrderPizza
intent is fulfilled, you might prompt the user to order a drink.
*
* The action that Amazon Lex takes depends on the user's response, as follows: *
** If the user says "Yes" it responds with the clarification prompt that is configured for the bot. *
** if the user says "Yes" and continues with an utterance that triggers an intent it starts a conversation for the * intent. *
** If the user says "No" it responds with the rejection statement configured for the the follow-up prompt. *
** If it doesn't recognize the utterance it repeats the follow-up prompt again. *
*
* The followUpPrompt
field and the conclusionStatement
field are mutually exclusive. You
* can specify only one.
*
OrderPizza
intent is fulfilled, you might prompt the user to order a drink.
* * The action that Amazon Lex takes depends on the user's response, as follows: *
** If the user says "Yes" it responds with the clarification prompt that is configured for the bot. *
** if the user says "Yes" and continues with an utterance that triggers an intent it starts a conversation * for the intent. *
** If the user says "No" it responds with the rejection statement configured for the the follow-up prompt. *
** If it doesn't recognize the utterance it repeats the follow-up prompt again. *
*
* The followUpPrompt
field and the conclusionStatement
field are mutually
* exclusive. You can specify only one.
*/
public void setFollowUpPrompt(FollowUpPrompt followUpPrompt) {
this.followUpPrompt = followUpPrompt;
}
/**
*
* Amazon Lex uses this prompt to solicit additional activity after fulfilling an intent. For example, after the
* OrderPizza
intent is fulfilled, you might prompt the user to order a drink.
*
* The action that Amazon Lex takes depends on the user's response, as follows: *
** If the user says "Yes" it responds with the clarification prompt that is configured for the bot. *
** if the user says "Yes" and continues with an utterance that triggers an intent it starts a conversation for the * intent. *
** If the user says "No" it responds with the rejection statement configured for the the follow-up prompt. *
** If it doesn't recognize the utterance it repeats the follow-up prompt again. *
*
* The followUpPrompt
field and the conclusionStatement
field are mutually exclusive. You
* can specify only one.
*
OrderPizza
intent is fulfilled, you might prompt the user to order a drink.
* * The action that Amazon Lex takes depends on the user's response, as follows: *
** If the user says "Yes" it responds with the clarification prompt that is configured for the bot. *
** if the user says "Yes" and continues with an utterance that triggers an intent it starts a conversation * for the intent. *
** If the user says "No" it responds with the rejection statement configured for the the follow-up prompt. *
** If it doesn't recognize the utterance it repeats the follow-up prompt again. *
*
* The followUpPrompt
field and the conclusionStatement
field are mutually
* exclusive. You can specify only one.
*/
public FollowUpPrompt getFollowUpPrompt() {
return this.followUpPrompt;
}
/**
*
* Amazon Lex uses this prompt to solicit additional activity after fulfilling an intent. For example, after the
* OrderPizza
intent is fulfilled, you might prompt the user to order a drink.
*
* The action that Amazon Lex takes depends on the user's response, as follows: *
** If the user says "Yes" it responds with the clarification prompt that is configured for the bot. *
** if the user says "Yes" and continues with an utterance that triggers an intent it starts a conversation for the * intent. *
** If the user says "No" it responds with the rejection statement configured for the the follow-up prompt. *
** If it doesn't recognize the utterance it repeats the follow-up prompt again. *
*
* The followUpPrompt
field and the conclusionStatement
field are mutually exclusive. You
* can specify only one.
*
OrderPizza
intent is fulfilled, you might prompt the user to order a drink.
* * The action that Amazon Lex takes depends on the user's response, as follows: *
** If the user says "Yes" it responds with the clarification prompt that is configured for the bot. *
** if the user says "Yes" and continues with an utterance that triggers an intent it starts a conversation * for the intent. *
** If the user says "No" it responds with the rejection statement configured for the the follow-up prompt. *
** If it doesn't recognize the utterance it repeats the follow-up prompt again. *
*
* The followUpPrompt
field and the conclusionStatement
field are mutually
* exclusive. You can specify only one.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutIntentRequest withFollowUpPrompt(FollowUpPrompt followUpPrompt) {
setFollowUpPrompt(followUpPrompt);
return this;
}
/**
*
* The statement that you want Amazon Lex to convey to the user after the intent is successfully fulfilled by the * Lambda function. *
*
* This element is relevant only if you provide a Lambda function in the fulfillmentActivity
. If you
* return the intent to the client application, you can't specify this element.
*
* The followUpPrompt
and conclusionStatement
are mutually exclusive. You can specify only
* one.
*
* This element is relevant only if you provide a Lambda function in the fulfillmentActivity
. If
* you return the intent to the client application, you can't specify this element.
*
* The followUpPrompt
and conclusionStatement
are mutually exclusive. You can
* specify only one.
*
* The statement that you want Amazon Lex to convey to the user after the intent is successfully fulfilled by the * Lambda function. *
*
* This element is relevant only if you provide a Lambda function in the fulfillmentActivity
. If you
* return the intent to the client application, you can't specify this element.
*
* The followUpPrompt
and conclusionStatement
are mutually exclusive. You can specify only
* one.
*
* This element is relevant only if you provide a Lambda function in the fulfillmentActivity
.
* If you return the intent to the client application, you can't specify this element.
*
* The followUpPrompt
and conclusionStatement
are mutually exclusive. You can
* specify only one.
*
* The statement that you want Amazon Lex to convey to the user after the intent is successfully fulfilled by the * Lambda function. *
*
* This element is relevant only if you provide a Lambda function in the fulfillmentActivity
. If you
* return the intent to the client application, you can't specify this element.
*
* The followUpPrompt
and conclusionStatement
are mutually exclusive. You can specify only
* one.
*
* This element is relevant only if you provide a Lambda function in the fulfillmentActivity
. If
* you return the intent to the client application, you can't specify this element.
*
* The followUpPrompt
and conclusionStatement
are mutually exclusive. You can
* specify only one.
*
* Specifies a Lambda function to invoke for each user input. You can invoke this Lambda function to personalize * user interaction. *
*
* For example, suppose your bot determines that the user is John. Your Lambda function might retrieve John's
* information from a backend database and prepopulate some of the values. For example, if you find that John is
* gluten intolerant, you might set the corresponding intent slot, GlutenIntolerant
, to true. You might
* find John's phone number and set the corresponding session attribute.
*
* For example, suppose your bot determines that the user is John. Your Lambda function might retrieve John's
* information from a backend database and prepopulate some of the values. For example, if you find that John
* is gluten intolerant, you might set the corresponding intent slot, GlutenIntolerant
, to true.
* You might find John's phone number and set the corresponding session attribute.
*/
public void setDialogCodeHook(CodeHook dialogCodeHook) {
this.dialogCodeHook = dialogCodeHook;
}
/**
*
* Specifies a Lambda function to invoke for each user input. You can invoke this Lambda function to personalize * user interaction. *
*
* For example, suppose your bot determines that the user is John. Your Lambda function might retrieve John's
* information from a backend database and prepopulate some of the values. For example, if you find that John is
* gluten intolerant, you might set the corresponding intent slot, GlutenIntolerant
, to true. You might
* find John's phone number and set the corresponding session attribute.
*
* For example, suppose your bot determines that the user is John. Your Lambda function might retrieve
* John's information from a backend database and prepopulate some of the values. For example, if you find
* that John is gluten intolerant, you might set the corresponding intent slot,
* GlutenIntolerant
, to true. You might find John's phone number and set the corresponding
* session attribute.
*/
public CodeHook getDialogCodeHook() {
return this.dialogCodeHook;
}
/**
*
* Specifies a Lambda function to invoke for each user input. You can invoke this Lambda function to personalize * user interaction. *
*
* For example, suppose your bot determines that the user is John. Your Lambda function might retrieve John's
* information from a backend database and prepopulate some of the values. For example, if you find that John is
* gluten intolerant, you might set the corresponding intent slot, GlutenIntolerant
, to true. You might
* find John's phone number and set the corresponding session attribute.
*
* For example, suppose your bot determines that the user is John. Your Lambda function might retrieve John's
* information from a backend database and prepopulate some of the values. For example, if you find that John
* is gluten intolerant, you might set the corresponding intent slot, GlutenIntolerant
, to true.
* You might find John's phone number and set the corresponding session attribute.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutIntentRequest withDialogCodeHook(CodeHook dialogCodeHook) {
setDialogCodeHook(dialogCodeHook);
return this;
}
/**
*
* Required. Describes how the intent is fulfilled. For example, after a user provides all of the information for a
* pizza order, fulfillmentActivity
defines how the bot places an order with a local pizza store.
*
* You might configure Amazon Lex to return all of the intent information to the client application, or direct it to * invoke a Lambda function that can process the intent (for example, place an order with a pizzeria). *
* * @param fulfillmentActivity * Required. Describes how the intent is fulfilled. For example, after a user provides all of the information * for a pizza order,fulfillmentActivity
defines how the bot places an order with a local pizza
* store.
* * You might configure Amazon Lex to return all of the intent information to the client application, or * direct it to invoke a Lambda function that can process the intent (for example, place an order with a * pizzeria). */ public void setFulfillmentActivity(FulfillmentActivity fulfillmentActivity) { this.fulfillmentActivity = fulfillmentActivity; } /** *
* Required. Describes how the intent is fulfilled. For example, after a user provides all of the information for a
* pizza order, fulfillmentActivity
defines how the bot places an order with a local pizza store.
*
* You might configure Amazon Lex to return all of the intent information to the client application, or direct it to * invoke a Lambda function that can process the intent (for example, place an order with a pizzeria). *
* * @return Required. Describes how the intent is fulfilled. For example, after a user provides all of the * information for a pizza order,fulfillmentActivity
defines how the bot places an order with
* a local pizza store.
* * You might configure Amazon Lex to return all of the intent information to the client application, or * direct it to invoke a Lambda function that can process the intent (for example, place an order with a * pizzeria). */ public FulfillmentActivity getFulfillmentActivity() { return this.fulfillmentActivity; } /** *
* Required. Describes how the intent is fulfilled. For example, after a user provides all of the information for a
* pizza order, fulfillmentActivity
defines how the bot places an order with a local pizza store.
*
* You might configure Amazon Lex to return all of the intent information to the client application, or direct it to * invoke a Lambda function that can process the intent (for example, place an order with a pizzeria). *
* * @param fulfillmentActivity * Required. Describes how the intent is fulfilled. For example, after a user provides all of the information * for a pizza order,fulfillmentActivity
defines how the bot places an order with a local pizza
* store.
* * You might configure Amazon Lex to return all of the intent information to the client application, or * direct it to invoke a Lambda function that can process the intent (for example, place an order with a * pizzeria). * @return Returns a reference to this object so that method calls can be chained together. */ public PutIntentRequest withFulfillmentActivity(FulfillmentActivity fulfillmentActivity) { setFulfillmentActivity(fulfillmentActivity); return this; } /** *
* A unique identifier for the built-in intent to base this intent on. To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit. *
* * @param parentIntentSignature * A unique identifier for the built-in intent to base this intent on. To find the signature for an intent, * see Standard Built-in Intents in the Alexa Skills Kit. */ public void setParentIntentSignature(String parentIntentSignature) { this.parentIntentSignature = parentIntentSignature; } /** ** A unique identifier for the built-in intent to base this intent on. To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit. *
* * @return A unique identifier for the built-in intent to base this intent on. To find the signature for an intent, * see Standard Built-in Intents in the Alexa Skills Kit. */ public String getParentIntentSignature() { return this.parentIntentSignature; } /** ** A unique identifier for the built-in intent to base this intent on. To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit. *
* * @param parentIntentSignature * A unique identifier for the built-in intent to base this intent on. To find the signature for an intent, * see Standard Built-in Intents in the Alexa Skills Kit. * @return Returns a reference to this object so that method calls can be chained together. */ public PutIntentRequest withParentIntentSignature(String parentIntentSignature) { setParentIntentSignature(parentIntentSignature); return this; } /** *
* Identifies a specific revision of the $LATEST
version.
*
* When you create a new intent, leave the checksum
field blank. If you specify a checksum you get a
* BadRequestException
exception.
*
* When you want to update a intent, set the checksum
field to the checksum of the most recent revision
* of the $LATEST
version. If you don't specify the checksum
field, or if the checksum
* does not match the $LATEST
version, you get a PreconditionFailedException
exception.
*
$LATEST
version.
*
* When you create a new intent, leave the checksum
field blank. If you specify a checksum you
* get a BadRequestException
exception.
*
* When you want to update a intent, set the checksum
field to the checksum of the most recent
* revision of the $LATEST
version. If you don't specify the checksum
field, or if
* the checksum does not match the $LATEST
version, you get a
* PreconditionFailedException
exception.
*/
public void setChecksum(String checksum) {
this.checksum = checksum;
}
/**
*
* Identifies a specific revision of the $LATEST
version.
*
* When you create a new intent, leave the checksum
field blank. If you specify a checksum you get a
* BadRequestException
exception.
*
* When you want to update a intent, set the checksum
field to the checksum of the most recent revision
* of the $LATEST
version. If you don't specify the checksum
field, or if the checksum
* does not match the $LATEST
version, you get a PreconditionFailedException
exception.
*
$LATEST
version.
*
* When you create a new intent, leave the checksum
field blank. If you specify a checksum you
* get a BadRequestException
exception.
*
* When you want to update a intent, set the checksum
field to the checksum of the most recent
* revision of the $LATEST
version. If you don't specify the checksum
field, or
* if the checksum does not match the $LATEST
version, you get a
* PreconditionFailedException
exception.
*/
public String getChecksum() {
return this.checksum;
}
/**
*
* Identifies a specific revision of the $LATEST
version.
*
* When you create a new intent, leave the checksum
field blank. If you specify a checksum you get a
* BadRequestException
exception.
*
* When you want to update a intent, set the checksum
field to the checksum of the most recent revision
* of the $LATEST
version. If you don't specify the checksum
field, or if the checksum
* does not match the $LATEST
version, you get a PreconditionFailedException
exception.
*
$LATEST
version.
*
* When you create a new intent, leave the checksum
field blank. If you specify a checksum you
* get a BadRequestException
exception.
*
* When you want to update a intent, set the checksum
field to the checksum of the most recent
* revision of the $LATEST
version. If you don't specify the checksum
field, or if
* the checksum does not match the $LATEST
version, you get a
* PreconditionFailedException
exception.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutIntentRequest withChecksum(String checksum) {
setChecksum(checksum);
return this;
}
/**
*
* When set to true
a new numbered version of the intent is created. This is the same as calling the
* CreateIntentVersion
operation. If you do not specify createVersion
, the default is
* false
.
*
true
a new numbered version of the intent is created. This is the same as calling
* the CreateIntentVersion
operation. If you do not specify createVersion
, the
* default is false
.
*/
public void setCreateVersion(Boolean createVersion) {
this.createVersion = createVersion;
}
/**
*
* When set to true
a new numbered version of the intent is created. This is the same as calling the
* CreateIntentVersion
operation. If you do not specify createVersion
, the default is
* false
.
*
true
a new numbered version of the intent is created. This is the same as
* calling the CreateIntentVersion
operation. If you do not specify createVersion
,
* the default is false
.
*/
public Boolean getCreateVersion() {
return this.createVersion;
}
/**
*
* When set to true
a new numbered version of the intent is created. This is the same as calling the
* CreateIntentVersion
operation. If you do not specify createVersion
, the default is
* false
.
*
true
a new numbered version of the intent is created. This is the same as calling
* the CreateIntentVersion
operation. If you do not specify createVersion
, the
* default is false
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutIntentRequest withCreateVersion(Boolean createVersion) {
setCreateVersion(createVersion);
return this;
}
/**
*
* When set to true
a new numbered version of the intent is created. This is the same as calling the
* CreateIntentVersion
operation. If you do not specify createVersion
, the default is
* false
.
*
true
a new numbered version of the intent is created. This is the same as
* calling the CreateIntentVersion
operation. If you do not specify createVersion
,
* the default is false
.
*/
public Boolean isCreateVersion() {
return this.createVersion;
}
/**
*
* Configuration information required to use the AMAZON.KendraSearchIntent
intent to connect to an
* Amazon Kendra index. For more information, see
* AMAZON.KendraSearchIntent.
*
AMAZON.KendraSearchIntent
intent to connect to
* an Amazon Kendra index. For more information, see
* AMAZON.KendraSearchIntent.
*/
public void setKendraConfiguration(KendraConfiguration kendraConfiguration) {
this.kendraConfiguration = kendraConfiguration;
}
/**
*
* Configuration information required to use the AMAZON.KendraSearchIntent
intent to connect to an
* Amazon Kendra index. For more information, see
* AMAZON.KendraSearchIntent.
*
AMAZON.KendraSearchIntent
intent to connect to
* an Amazon Kendra index. For more information, see
* AMAZON.KendraSearchIntent.
*/
public KendraConfiguration getKendraConfiguration() {
return this.kendraConfiguration;
}
/**
*
* Configuration information required to use the AMAZON.KendraSearchIntent
intent to connect to an
* Amazon Kendra index. For more information, see
* AMAZON.KendraSearchIntent.
*
AMAZON.KendraSearchIntent
intent to connect to
* an Amazon Kendra index. For more information, see
* AMAZON.KendraSearchIntent.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutIntentRequest withKendraConfiguration(KendraConfiguration kendraConfiguration) {
setKendraConfiguration(kendraConfiguration);
return this;
}
/**
*
* An array of InputContext
objects that lists the contexts that must be active for Amazon Lex to
* choose the intent in a conversation with the user.
*
InputContext
objects that lists the contexts that must be active for Amazon Lex
* to choose the intent in a conversation with the user.
*/
public java.util.List
* An array of InputContext
objects that lists the contexts that must be active for Amazon Lex to
* choose the intent in a conversation with the user.
*
InputContext
objects that lists the contexts that must be active for Amazon Lex
* to choose the intent in a conversation with the user.
*/
public void setInputContexts(java.util.Collection
* An array of InputContext
objects that lists the contexts that must be active for Amazon Lex to
* choose the intent in a conversation with the user.
*
* NOTE: This method appends the values to the existing list (if any). Use * {@link #setInputContexts(java.util.Collection)} or {@link #withInputContexts(java.util.Collection)} if you want * to override the existing values. *
* * @param inputContexts * An array ofInputContext
objects that lists the contexts that must be active for Amazon Lex
* to choose the intent in a conversation with the user.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutIntentRequest withInputContexts(InputContext... inputContexts) {
if (this.inputContexts == null) {
setInputContexts(new java.util.ArrayList
* An array of InputContext
objects that lists the contexts that must be active for Amazon Lex to
* choose the intent in a conversation with the user.
*
InputContext
objects that lists the contexts that must be active for Amazon Lex
* to choose the intent in a conversation with the user.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutIntentRequest withInputContexts(java.util.Collection
* An array of OutputContext
objects that lists the contexts that the intent activates when the intent
* is fulfilled.
*
OutputContext
objects that lists the contexts that the intent activates when the
* intent is fulfilled.
*/
public java.util.List
* An array of OutputContext
objects that lists the contexts that the intent activates when the intent
* is fulfilled.
*
OutputContext
objects that lists the contexts that the intent activates when the
* intent is fulfilled.
*/
public void setOutputContexts(java.util.Collection
* An array of OutputContext
objects that lists the contexts that the intent activates when the intent
* is fulfilled.
*
* NOTE: This method appends the values to the existing list (if any). Use * {@link #setOutputContexts(java.util.Collection)} or {@link #withOutputContexts(java.util.Collection)} if you want * to override the existing values. *
* * @param outputContexts * An array ofOutputContext
objects that lists the contexts that the intent activates when the
* intent is fulfilled.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutIntentRequest withOutputContexts(OutputContext... outputContexts) {
if (this.outputContexts == null) {
setOutputContexts(new java.util.ArrayList
* An array of OutputContext
objects that lists the contexts that the intent activates when the intent
* is fulfilled.
*
OutputContext
objects that lists the contexts that the intent activates when the
* intent is fulfilled.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutIntentRequest withOutputContexts(java.util.Collection