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("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:
-
Nested Class Summary
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 TypeMethodDescriptionvoid
Calls the appropriate visit method depending on the subtype ofAudioResponseEvent
.final SdkBytes
A chunk of the audio to play.static AudioResponseEvent.Builder
builder()
final String
The encoding of the audio chunk.final AudioResponseEvent
copy
(Consumer<? super AudioResponseEvent.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.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
static Class
<? extends AudioResponseEvent.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
-
audioChunk
A chunk of the audio to play.
- Returns:
- A chunk of the audio to play.
-
contentType
The encoding of the audio chunk. This is the same as the encoding configure in the
contentType
field of theConfigurationEvent
.- Returns:
- The encoding of the audio chunk. This is the same as the encoding configure in the
contentType
field of theConfigurationEvent
.
-
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<AudioResponseEvent.Builder,
AudioResponseEvent> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int 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
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. -
getValueForField
-
copy
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<AudioResponseEvent.Builder,
AudioResponseEvent> - 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
-
accept
Calls the appropriate visit method depending on the subtype ofAudioResponseEvent
.- Specified by:
accept
in interfaceStartConversationResponseEventStream
- Parameters:
visitor
- Visitor to invoke.
-