software.amazon.awssdk.services.lexruntimev2.model

Class AudioResponseEvent

java.lang.Object

software.amazon.awssdk.services.lexruntimev2.model.AudioResponseEvent

All Implemented Interfaces:

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

Direct Known Subclasses:

DefaultAudioResponseEvent

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

An event sent from Amazon Lex V2 to your client application containing audio to play to the user.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AudioResponseEvent.Builder
protected static class	AudioResponseEvent.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	AudioResponseEvent(AudioResponseEvent.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 AudioResponseEvent.
SdkBytes	audioChunk() A chunk of the audio to play.
static AudioResponseEvent.Builder	builder()
String	contentType() The encoding of the audio chunk.
AudioResponseEvent	copy(Consumer<? super AudioResponseEvent.Builder> modifier)
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	eventId() A unique identifier of the event sent by Amazon Lex V2.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends AudioResponseEvent.Builder>	serializableBuilderClass()
AudioResponseEvent.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

AudioResponseEvent

protected AudioResponseEvent(AudioResponseEvent.BuilderImpl builder)

Method Detail

audioChunk

public final SdkBytes audioChunk()

A chunk of the audio to play.

Returns:

A chunk of the audio to play.

contentType

public final String contentType()

The encoding of the audio chunk. This is the same as the encoding configure in the contentType field of the ConfigurationEvent.

Returns:

The encoding of the audio chunk. This is the same as the encoding configure in the contentType field of the ConfigurationEvent.

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 AudioResponseEvent.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AudioResponseEvent.Builder,AudioResponseEvent>

builder

public static AudioResponseEvent.Builder builder()

serializableBuilderClass

public static Class<? extends AudioResponseEvent.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 AudioResponseEvent copy(Consumer<? super AudioResponseEvent.Builder> modifier)

Specified by:

copy in interface ToCopyableBuilder<AudioResponseEvent.Builder,AudioResponseEvent>

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 AudioResponseEvent.

Specified by:

accept in interface StartConversationResponseEventStream

Parameters:

visitor - Visitor to invoke.