Class PlaybackInterruptionEvent
- All Implemented Interfaces:
Serializable
,SdkPojo
,StartConversationResponseEventStream
,ToCopyableBuilder<PlaybackInterruptionEvent.Builder,
PlaybackInterruptionEvent>
- Direct Known Subclasses:
DefaultPlaybackInterruptionEvent
Event sent from Amazon Lex V2 to indicate to the client application should stop playback of audio. For example, if the client is playing a prompt that asks for the user's telephone number, the user might start to say the phone number before the prompt is complete. Amazon Lex V2 sends this event to the client application to indicate that the user is responding and that Amazon Lex V2 is processing their input.
- See Also:
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from interface software.amazon.awssdk.services.lexruntimev2.model.StartConversationResponseEventStream
StartConversationResponseEventStream.EventType
-
Field Summary
Fields inherited from interface software.amazon.awssdk.services.lexruntimev2.model.StartConversationResponseEventStream
UNKNOWN
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Calls the appropriate visit method depending on the subtype ofPlaybackInterruptionEvent
.builder()
final String
The identifier of the event that contained the audio, DTMF, or text that caused the interruption.copy
(Consumer<? super PlaybackInterruptionEvent.Builder> modifier) A convenience method for callingToCopyableBuilder.toBuilder()
, updating the returned builder and then callingSdkBuilder.build()
.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
eventId()
A unique identifier of the event sent by Amazon Lex V2.Indicates the type of user input that Amazon Lex V2 detected.final String
Indicates the type of user input that Amazon Lex V2 detected.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
static Class
<? extends PlaybackInterruptionEvent.Builder> 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 interface software.amazon.awssdk.services.lexruntimev2.model.StartConversationResponseEventStream
sdkEventType
-
Method Details
-
eventReason
Indicates the type of user input that Amazon Lex V2 detected.
If the service returns an enum value that is not available in the current SDK version,
eventReason
will returnPlaybackInterruptionReason.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromeventReasonAsString()
.- Returns:
- Indicates the type of user input that Amazon Lex V2 detected.
- See Also:
-
eventReasonAsString
Indicates the type of user input that Amazon Lex V2 detected.
If the service returns an enum value that is not available in the current SDK version,
eventReason
will returnPlaybackInterruptionReason.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromeventReasonAsString()
.- Returns:
- Indicates the type of user input that Amazon Lex V2 detected.
- See Also:
-
causedByEventId
The identifier of the event that contained the audio, DTMF, or text that caused the interruption.
- Returns:
- The identifier of the event that contained the audio, DTMF, or text that caused the interruption.
-
eventId
A unique identifier of the event sent by Amazon Lex V2. The identifier is in the form
RESPONSE-N
, where N is a number starting with one and incremented for each event sent by Amazon Lex V2 in the current session.- Returns:
- A unique identifier of the event sent by Amazon Lex V2. The identifier is in the form
RESPONSE-N
, where N is a number starting with one and incremented for each event sent by Amazon Lex V2 in the current session.
-
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<PlaybackInterruptionEvent.Builder,
PlaybackInterruptionEvent> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
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
-
getValueForField
-
copy
public final PlaybackInterruptionEvent copy(Consumer<? super PlaybackInterruptionEvent.Builder> modifier) Description copied from interface:ToCopyableBuilder
A convenience method for callingToCopyableBuilder.toBuilder()
, updating the returned builder and then callingSdkBuilder.build()
. This is useful for making small modifications to the existing object.- Specified by:
copy
in interfaceToCopyableBuilder<PlaybackInterruptionEvent.Builder,
PlaybackInterruptionEvent> - Parameters:
modifier
- A function that mutates this immutable object using the provided builder.- Returns:
- A new copy of this object with the requested modifications.
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-
accept
Calls the appropriate visit method depending on the subtype ofPlaybackInterruptionEvent
.- Specified by:
accept
in interfaceStartConversationResponseEventStream
- Parameters:
visitor
- Visitor to invoke.
-