java.lang.Object
- software.amazon.awssdk.services.lexmodelsv2.model.PromptSpecification

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<PromptSpecification.Builder,PromptSpecification>
```
@Generated("software.amazon.awssdk:codegen")
public final class PromptSpecification
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<PromptSpecification.Builder,PromptSpecification>
```
Specifies a list of message groups that Amazon Lex sends to a user to elicit a response.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface PromptSpecification.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Boolean`	`allowInterrupt()`	Indicates whether the user can interrupt a speech prompt from the bot.
`static PromptSpecification.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasMessageGroups()`	For responses, this returns true if the service returned a value for the MessageGroups property.
`boolean`	`hasPromptAttemptsSpecification()`	For responses, this returns true if the service returned a value for the PromptAttemptsSpecification property.
`Integer`	`maxRetries()`	The maximum number of times the bot tries to elicit a response from the user using this prompt.
`List<MessageGroup>`	`messageGroups()`	A collection of messages that Amazon Lex can send to the user.
`MessageSelectionStrategy`	`messageSelectionStrategy()`	Indicates how a message is selected from a message group among retries.
`String`	`messageSelectionStrategyAsString()`	Indicates how a message is selected from a message group among retries.
`Map<PromptAttempt,PromptAttemptSpecification>`	`promptAttemptsSpecification()`	Specifies the advanced settings on each attempt of the prompt.
`Map<String,PromptAttemptSpecification>`	`promptAttemptsSpecificationAsStrings()`	Specifies the advanced settings on each attempt of the prompt.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends PromptSpecification.Builder>`	`serializableBuilderClass()`
`PromptSpecification.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

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
  - hasMessageGroups
```
public final boolean hasMessageGroups()
```
    For responses, this returns true if the service returned a value for the MessageGroups 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.
  - messageGroups
```
public final List<MessageGroup> messageGroups()
```
    A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.
    
    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 hasMessageGroups() method.
    
    Returns:
    
    A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.
  - maxRetries
```
public final Integer maxRetries()
```
    The maximum number of times the bot tries to elicit a response from the user using this prompt.
    
    Returns:
    
    The maximum number of times the bot tries to elicit a response from the user using this prompt.
  - allowInterrupt
```
public final Boolean allowInterrupt()
```
    Indicates whether the user can interrupt a speech prompt from the bot.
    
    Returns:
    
    Indicates whether the user can interrupt a speech prompt from the bot.
  - messageSelectionStrategy
```
public final MessageSelectionStrategy messageSelectionStrategy()
```
    Indicates how a message is selected from a message group among retries.
    
    If the service returns an enum value that is not available in the current SDK version, messageSelectionStrategy will return MessageSelectionStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from messageSelectionStrategyAsString().
    
    Returns:
    
    Indicates how a message is selected from a message group among retries.
    
    See Also:
    
    MessageSelectionStrategy
  - messageSelectionStrategyAsString
```
public final String messageSelectionStrategyAsString()
```
    Indicates how a message is selected from a message group among retries.
    
    If the service returns an enum value that is not available in the current SDK version, messageSelectionStrategy will return MessageSelectionStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from messageSelectionStrategyAsString().
    
    Returns:
    
    Indicates how a message is selected from a message group among retries.
    
    See Also:
    
    MessageSelectionStrategy
  - promptAttemptsSpecification
```
public final Map<PromptAttempt,PromptAttemptSpecification> promptAttemptsSpecification()
```
    Specifies the advanced settings on each attempt of the prompt.
    
    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 hasPromptAttemptsSpecification() method.
    
    Returns:
    
    Specifies the advanced settings on each attempt of the prompt.
  - hasPromptAttemptsSpecification
```
public final boolean hasPromptAttemptsSpecification()
```
    For responses, this returns true if the service returned a value for the PromptAttemptsSpecification 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.
  - promptAttemptsSpecificationAsStrings
```
public final Map<String,PromptAttemptSpecification> promptAttemptsSpecificationAsStrings()
```
    Specifies the advanced settings on each attempt of the prompt.
    
    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 hasPromptAttemptsSpecification() method.
    
    Returns:
    
    Specifies the advanced settings on each attempt of the prompt.
  - toBuilder
```
public PromptSpecification.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<PromptSpecification.Builder,PromptSpecification>
  - builder
```
public static PromptSpecification.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends PromptSpecification.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class PromptSpecification

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

hasMessageGroups

messageGroups

maxRetries

allowInterrupt

messageSelectionStrategy

messageSelectionStrategyAsString

promptAttemptsSpecification

hasPromptAttemptsSpecification

promptAttemptsSpecificationAsStrings

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields