Class DescribeIntentResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeIntentResponse.Builder,
DescribeIntentResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
botId()
The identifier of the bot associated with the intent.final String
The version of the bot associated with the intent.builder()
final Instant
A timestamp of the date and time that the intent was created.final String
The description of the intent.final DialogCodeHookSettings
The Lambda function called during each turn of a conversation with the intent.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.The Lambda function called when the intent is complete and ready for fulfillment.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
For responses, this returns true if the service returned a value for the SlotPriorities property.final InitialResponseSetting
Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.final List
<InputContext> A list of contexts that must be active for the intent to be considered for sending to the user.final IntentClosingSetting
The response that Amazon Lex sends to when the intent is closed.Prompts that Amazon Lex sends to the user to confirm completion of an intent.final String
intentId()
The unique identifier assigned to the intent when it was created.final String
The name specified for the intent.final KendraConfiguration
Configuration information required to use theAMAZON.KendraSearchIntent
intent.final Instant
A timestamp of the date and time that the intent was last updated.final String
localeId()
The language and locale specified for the intent.final List
<OutputContext> A list of contexts that are activated when the intent is fulfilled.final String
The identifier of the built-in intent that this intent is derived from, if any.final QnAIntentConfiguration
Details about the configuration of the built-inAmazon.QnAIntent
.final List
<SampleUtterance> User utterances that trigger this intent.static Class
<? extends DescribeIntentResponse.Builder> final List
<SlotPriority> The list that determines the priority that slots should be elicited from the user.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.Methods inherited from class software.amazon.awssdk.services.lexmodelsv2.model.LexModelsV2Response
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
intentId
The unique identifier assigned to the intent when it was created.
- Returns:
- The unique identifier assigned to the intent when it was created.
-
intentName
The name specified for the intent.
- Returns:
- The name specified for the intent.
-
description
The description of the intent.
- Returns:
- The description of the intent.
-
parentIntentSignature
The identifier of the built-in intent that this intent is derived from, if any.
- Returns:
- The identifier of the built-in intent that this intent is derived from, if any.
-
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
User utterances that trigger this 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:
- User utterances that trigger this intent.
-
dialogCodeHook
The Lambda function called during each turn of a conversation with the intent.
- Returns:
- The Lambda function called during each turn of a conversation with the intent.
-
fulfillmentCodeHook
The Lambda function called when the intent is complete and ready for fulfillment.
- Returns:
- The Lambda function called when the intent is complete and ready for fulfillment.
-
hasSlotPriorities
public final boolean hasSlotPriorities()For responses, this returns true if the service returned a value for the SlotPriorities 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. -
slotPriorities
The list that determines the priority that slots should be elicited from 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
hasSlotPriorities()
method.- Returns:
- The list that determines the priority that slots should be elicited from the user.
-
intentConfirmationSetting
Prompts that Amazon Lex sends to the user to confirm completion of an intent.
- Returns:
- Prompts that Amazon Lex sends to the user to confirm completion of an intent.
-
intentClosingSetting
The response that Amazon Lex sends to when the intent is closed.
- Returns:
- The response that Amazon Lex sends to when the intent is closed.
-
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
A list of contexts that must be active for the intent to be considered for sending to 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:
- A list of contexts that must be active for the intent to be considered for sending to 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
A list of contexts that are activated 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:
- A list of contexts that are activated when the intent is fulfilled.
-
kendraConfiguration
Configuration information required to use the
AMAZON.KendraSearchIntent
intent.- Returns:
- Configuration information required to use the
AMAZON.KendraSearchIntent
intent.
-
botId
The identifier of the bot associated with the intent.
- Returns:
- The identifier of the bot associated with the intent.
-
botVersion
The version of the bot associated with the intent.
- Returns:
- The version of the bot associated with the intent.
-
localeId
The language and locale specified for the intent.
- Returns:
- The language and locale specified for the intent.
-
creationDateTime
A timestamp of the date and time that the intent was created.
- Returns:
- A timestamp of the date and time that the intent was created.
-
lastUpdatedDateTime
A timestamp of the date and time that the intent was last updated.
- Returns:
- A timestamp of the date and time that the intent was last updated.
-
initialResponseSetting
Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.
- Returns:
- Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.
-
qnAIntentConfiguration
Details about the configuration of the built-in
Amazon.QnAIntent
.- Returns:
- Details about the configuration of the built-in
Amazon.QnAIntent
.
-
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<DescribeIntentResponse.Builder,
DescribeIntentResponse> - 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
-