software.amazon.awssdk.services.lexruntimev2.model

Class PlaybackInterruptionEvent

java.lang.Object

software.amazon.awssdk.services.lexruntimev2.model.PlaybackInterruptionEvent

All Implemented Interfaces:

Serializable, SdkPojo, StartConversationResponseEventStream, ToCopyableBuilder<PlaybackInterruptionEvent.Builder,PlaybackInterruptionEvent>

Direct Known Subclasses:

DefaultPlaybackInterruptionEvent

@Generated(value="software.amazon.awssdk:codegen")
public class PlaybackInterruptionEvent
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<PlaybackInterruptionEvent.Builder,PlaybackInterruptionEvent>, StartConversationResponseEventStream

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PlaybackInterruptionEvent.Builder
protected static class	PlaybackInterruptionEvent.BuilderImpl

Nested 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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PlaybackInterruptionEvent(PlaybackInterruptionEvent.BuilderImpl builder)

Method Summary

Modifier and Type	Method and Description
void	accept(StartConversationResponseHandler.Visitor visitor) Calls the appropriate visit method depending on the subtype of PlaybackInterruptionEvent.
static PlaybackInterruptionEvent.Builder	builder()
String	causedByEventId() The identifier of the event that contained the audio, DTMF, or text that caused the interruption.
PlaybackInterruptionEvent	copy(Consumer<? super PlaybackInterruptionEvent.Builder> modifier)
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	eventId() A unique identifier of the event sent by Amazon Lex V2.
PlaybackInterruptionReason	eventReason() Indicates the type of user input that Amazon Lex V2 detected.
String	eventReasonAsString() Indicates the type of user input that Amazon Lex V2 detected.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends PlaybackInterruptionEvent.Builder>	serializableBuilderClass()
PlaybackInterruptionEvent.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.services.lexruntimev2.model.StartConversationResponseEventStream

audioResponseEventBuilder, heartbeatEventBuilder, intentResultEventBuilder, playbackInterruptionEventBuilder, sdkEventType, textResponseEventBuilder, transcriptEventBuilder

Constructor Detail

PlaybackInterruptionEvent

protected PlaybackInterruptionEvent(PlaybackInterruptionEvent.BuilderImpl builder)

Method Detail

eventReason

public final PlaybackInterruptionReason 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 return PlaybackInterruptionReason.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from eventReasonAsString().

Returns:

Indicates the type of user input that Amazon Lex V2 detected.

See Also:

PlaybackInterruptionReason

eventReasonAsString

public final String 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 return PlaybackInterruptionReason.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from eventReasonAsString().

Returns:

Indicates the type of user input that Amazon Lex V2 detected.

See Also:

PlaybackInterruptionReason

causedByEventId

public final String 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

public final String 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

public PlaybackInterruptionEvent.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PlaybackInterruptionEvent.Builder,PlaybackInterruptionEvent>

builder

public static PlaybackInterruptionEvent.Builder builder()

serializableBuilderClass

public static Class<? extends PlaybackInterruptionEvent.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)

copy

public final PlaybackInterruptionEvent copy(Consumer<? super PlaybackInterruptionEvent.Builder> modifier)

Specified by:

copy in interface ToCopyableBuilder<PlaybackInterruptionEvent.Builder,PlaybackInterruptionEvent>

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

accept

public void accept(StartConversationResponseHandler.Visitor visitor)

Calls the appropriate visit method depending on the subtype of PlaybackInterruptionEvent.

Specified by:

accept in interface StartConversationResponseEventStream

Parameters:

visitor - Visitor to invoke.