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("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	Description
static interface	PlaybackInterruptionEvent.Builder

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

Method Summary

Modifier and Type	Method	Description
void	accept(StartConversationResponseHandler.Visitor visitor)	Calls the appropriate visit method depending on the subtype of PlaybackInterruptionEvent.
static PlaybackInterruptionEvent.Builder	builder()
final String	causedByEventId()	The identifier of the event that contained the audio, DTMF, or text that caused the interruption.
final PlaybackInterruptionEvent	copy(Consumer<? super PlaybackInterruptionEvent.Builder> modifier)	A convenience method for calling ToCopyableBuilder.toBuilder(), updating the returned builder and then calling SdkBuilder.build().
final boolean	equals(Object obj)
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.
final PlaybackInterruptionReason	eventReason()	Indicates the type of user input that Amazon Lex V2 detected.
final String	eventReasonAsString()	Indicates the type of user input that Amazon Lex V2 detected.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends PlaybackInterruptionEvent.Builder>	serializableBuilderClass()
PlaybackInterruptionEvent.Builder	toBuilder()	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 java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.services.lexruntimev2.model.StartConversationResponseEventStream

sdkEventType

Method Details

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()

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 interface ToCopyableBuilder<PlaybackInterruptionEvent.Builder,PlaybackInterruptionEvent>

Returns:

a builder for type T

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)

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 an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

Description copied from interface: ToCopyableBuilder

A convenience method for calling ToCopyableBuilder.toBuilder(), updating the returned builder and then calling SdkBuilder.build(). This is useful for making small modifications to the existing object.

Specified by:

copy in interface ToCopyableBuilder<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

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

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo

Returns:

The mapping between the field name and its corresponding field.

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.