Class GetIntentResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetIntentResponse.Builder,
GetIntentResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic GetIntentResponse.Builder
builder()
final String
checksum()
Checksum of the intent.final Statement
After the Lambda function specified in thefulfillmentActivity
element fulfills the intent, Amazon Lex conveys this statement to the user.final Prompt
If defined in the bot, Amazon Lex uses prompt to confirm the intent before fulfilling the user's request.final Instant
The date that the intent was created.final String
A description of the intent.final CodeHook
If defined in the bot, Amazon Amazon Lex invokes this Lambda function for each user input.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final FollowUpPrompt
If defined in the bot, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled.final FulfillmentActivity
Describes how the intent is fulfilled.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the InputContexts property.final boolean
For responses, this returns true if the service returned a value for the OutputContexts property.final boolean
For responses, this returns true if the service returned a value for the SampleUtterances property.final boolean
hasSlots()
For responses, this returns true if the service returned a value for the Slots property.final List
<InputContext> 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.final KendraConfiguration
Configuration information, if any, to connect to an Amazon Kendra index with theAMAZON.KendraSearchIntent
intent.final Instant
The date that the intent was updated.final String
name()
The name of the intent.final List
<OutputContext> An array ofOutputContext
objects that lists the contexts that the intent activates when the intent is fulfilled.final String
A unique identifier for a built-in intent.final Statement
If the user answers "no" to the question defined inconfirmationPrompt
, Amazon Lex responds with this statement to acknowledge that the intent was canceled.An array of sample utterances configured for the intent.static Class
<? extends GetIntentResponse.Builder> slots()
An array of intent slots configured for the intent.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
version()
The version of the intent.Methods inherited from class software.amazon.awssdk.services.lexmodelbuilding.model.LexModelBuildingResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the intent.
- Returns:
- The name of the intent.
-
description
A description of the intent.
- Returns:
- A description of the intent.
-
hasSlots
public final boolean hasSlots()For responses, this returns true if the service returned a value for the Slots property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
slots
An array of intent slots configured for the intent.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSlots()
method.- Returns:
- An array of intent slots configured for the intent.
-
hasSampleUtterances
public final boolean hasSampleUtterances()For responses, this returns true if the service returned a value for the SampleUtterances property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
sampleUtterances
An array of sample utterances configured for the intent.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSampleUtterances()
method.- Returns:
- An array of sample utterances configured for the intent.
-
confirmationPrompt
If defined in the bot, Amazon Lex uses prompt to confirm the intent before fulfilling the user's request. For more information, see PutIntent.
- Returns:
- If defined in the bot, Amazon Lex uses prompt to confirm the intent before fulfilling the user's request. For more information, see PutIntent.
-
rejectionStatement
If the user answers "no" to the question defined in
confirmationPrompt
, Amazon Lex responds with this statement to acknowledge that the intent was canceled.- Returns:
- If the user answers "no" to the question defined in
confirmationPrompt
, Amazon Lex responds with this statement to acknowledge that the intent was canceled.
-
followUpPrompt
If defined in the bot, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled. For more information, see PutIntent.
- Returns:
- If defined in the bot, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled. For more information, see PutIntent.
-
conclusionStatement
After the Lambda function specified in the
fulfillmentActivity
element fulfills the intent, Amazon Lex conveys this statement to the user.- Returns:
- After the Lambda function specified in the
fulfillmentActivity
element fulfills the intent, Amazon Lex conveys this statement to the user.
-
dialogCodeHook
If defined in the bot, Amazon Amazon Lex invokes this Lambda function for each user input. For more information, see PutIntent.
- Returns:
- If defined in the bot, Amazon Amazon Lex invokes this Lambda function for each user input. For more information, see PutIntent.
-
fulfillmentActivity
Describes how the intent is fulfilled. For more information, see PutIntent.
- Returns:
- Describes how the intent is fulfilled. For more information, see PutIntent.
-
parentIntentSignature
A unique identifier for a built-in intent.
- Returns:
- A unique identifier for a built-in intent.
-
lastUpdatedDate
The date that the intent was updated. When you create a resource, the creation date and the last updated date are the same.
- Returns:
- The date that the intent was updated. When you create a resource, the creation date and the last updated date are the same.
-
createdDate
The date that the intent was created.
- Returns:
- The date that the intent was created.
-
version
The version of the intent.
- Returns:
- The version of the intent.
-
checksum
Checksum of the intent.
- Returns:
- Checksum of the intent.
-
kendraConfiguration
Configuration information, if any, to connect to an Amazon Kendra index with the
AMAZON.KendraSearchIntent
intent.- Returns:
- Configuration information, if any, to connect to an Amazon Kendra index with the
AMAZON.KendraSearchIntent
intent.
-
hasInputContexts
public final boolean hasInputContexts()For responses, this returns true if the service returned a value for the InputContexts property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
inputContexts
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.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasInputContexts()
method.- Returns:
- 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.
-
hasOutputContexts
public final boolean hasOutputContexts()For responses, this returns true if the service returned a value for the OutputContexts property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
outputContexts
An array of
OutputContext
objects that lists the contexts that the intent activates when the intent is fulfilled.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasOutputContexts()
method.- Returns:
- An array of
OutputContext
objects that lists the contexts that the intent activates when the intent is fulfilled.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<GetIntentResponse.Builder,
GetIntentResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-