DescribeIntentResponse (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.lexmodelsv2.model.LexModelsV2Response
    - - software.amazon.awssdk.services.lexmodelsv2.model.DescribeIntentResponse

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DescribeIntentResponse.Builder,DescribeIntentResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeIntentResponse
extends LexModelsV2Response
implements ToCopyableBuilder<DescribeIntentResponse.Builder,DescribeIntentResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeIntentResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DescribeIntentResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`botId()` The identifier of the bot associated with the intent.
`String`	`botVersion()` The version of the bot associated with the intent.
`static DescribeIntentResponse.Builder`	`builder()`
`Instant`	`creationDateTime()` A timestamp of the date and time that the intent was created.
`String`	`description()` The description of the intent.
`DialogCodeHookSettings`	`dialogCodeHook()` The Lambda function called during each turn of a conversation with the intent.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`FulfillmentCodeHookSettings`	`fulfillmentCodeHook()` The Lambda function called when the intent is complete and ready for fulfillment.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasInputContexts()` For responses, this returns true if the service returned a value for the InputContexts property.
`boolean`	`hasOutputContexts()` For responses, this returns true if the service returned a value for the OutputContexts property.
`boolean`	`hasSampleUtterances()` For responses, this returns true if the service returned a value for the SampleUtterances property.
`boolean`	`hasSlotPriorities()` For responses, this returns true if the service returned a value for the SlotPriorities property.
`List<InputContext>`	`inputContexts()` A list of contexts that must be active for the intent to be considered for sending to the user.
`IntentClosingSetting`	`intentClosingSetting()` The response that Amazon Lex sends to when the intent is closed.
`IntentConfirmationSetting`	`intentConfirmationSetting()` Prompts that Amazon Lex sends to the user to confirm completion of an intent.
`String`	`intentId()` The unique identifier assigned to the intent when it was created.
`String`	`intentName()` The name specified for the intent.
`KendraConfiguration`	`kendraConfiguration()` Configuration information required to use the `AMAZON.KendraSearchIntent` intent.
`Instant`	`lastUpdatedDateTime()` A timestamp of the date and time that the intent was last updated.
`String`	`localeId()` The language and locale specified for the intent.
`List<OutputContext>`	`outputContexts()` A list of contexts that are activated when the intent is fulfilled.
`String`	`parentIntentSignature()` The identifier of the built-in intent that this intent is derived from, if any.
`List<SampleUtterance>`	`sampleUtterances()` User utterances that trigger this intent.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeIntentResponse.Builder>`	`serializableBuilderClass()`
`List<SlotPriority>`	`slotPriorities()` The list that determines the priority that slots should be elicited from the user.
`DescribeIntentResponse.Builder`	`toBuilder()`
`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 class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - intentId
```
public final String 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
```
public final String intentName()
```
    The name specified for the intent.
    
    Returns:
    
    The name specified for the intent.
  - description
```
public final String description()
```
    The description of the intent.
    
    Returns:
    
    The description of the intent.
  - parentIntentSignature
```
public final String 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 the isEmpty() 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
```
public final List<SampleUtterance> 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
```
public final DialogCodeHookSettings 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
```
public final FulfillmentCodeHookSettings 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 the isEmpty() 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
```
public final List<SlotPriority> 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
```
public final IntentConfirmationSetting 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
```
public final IntentClosingSetting 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 the isEmpty() 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
```
public final List<InputContext> 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 the isEmpty() 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
```
public final List<OutputContext> 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
```
public final KendraConfiguration kendraConfiguration()
```
    Configuration information required to use the AMAZON.KendraSearchIntent intent.
    
    Returns:
    
    Configuration information required to use the AMAZON.KendraSearchIntent intent.
  - botId
```
public final String botId()
```
    The identifier of the bot associated with the intent.
    
    Returns:
    
    The identifier of the bot associated with the intent.
  - botVersion
```
public final String botVersion()
```
    The version of the bot associated with the intent.
    
    Returns:
    
    The version of the bot associated with the intent.
  - localeId
```
public final String localeId()
```
    The language and locale specified for the intent.
    
    Returns:
    
    The language and locale specified for the intent.
  - creationDateTime
```
public final Instant 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
```
public final Instant 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.
  - toBuilder
```
public DescribeIntentResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeIntentResponse.Builder,DescribeIntentResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static DescribeIntentResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeIntentResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DescribeIntentResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.lexmodelsv2.model.LexModelsV2Response

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

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

Method Detail

intentId

intentName

description

parentIntentSignature

hasSampleUtterances

sampleUtterances

dialogCodeHook

fulfillmentCodeHook

hasSlotPriorities

slotPriorities

intentConfirmationSetting

intentClosingSetting

hasInputContexts

inputContexts

hasOutputContexts

outputContexts

kendraConfiguration

botId

botVersion

localeId

creationDateTime

lastUpdatedDateTime

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields