software.amazon.awssdk.services.lexruntimev2.model

Class DTMFInputEvent

java.lang.Object

software.amazon.awssdk.services.lexruntimev2.model.DTMFInputEvent

All Implemented Interfaces:

Serializable, SdkPojo, StartConversationRequestEventStream, ToCopyableBuilder<DTMFInputEvent.Builder,DTMFInputEvent>

Direct Known Subclasses:

DefaultDTMFInputEvent

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

A DTMF character sent from the client application. DTMF characters are typically sent from a phone keypad to represent numbers. For example, you can have Amazon Lex V2 process a credit card number input from a phone.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from interface software.amazon.awssdk.services.lexruntimev2.model.StartConversationRequestEventStream

StartConversationRequestEventStream.EventType

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static DTMFInputEvent.Builder	builder()
Long	clientTimestampMillis() A timestamp set by the client of the date and time that the event was sent to Amazon Lex V2.
DTMFInputEvent	copy(Consumer<? super DTMFInputEvent.Builder> modifier)
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	eventId() A unique identifier that your application assigns to the event.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	inputCharacter() The DTMF character that the user pressed.
List<SdkField<?>>	sdkFields()
static Class<? extends DTMFInputEvent.Builder>	serializableBuilderClass()
DTMFInputEvent.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.StartConversationRequestEventStream

audioInputEventBuilder, configurationEventBuilder, disconnectionEventBuilder, dTMFInputEventBuilder, playbackCompletionEventBuilder, sdkEventType, textInputEventBuilder

Constructor Detail

DTMFInputEvent

protected DTMFInputEvent(DTMFInputEvent.BuilderImpl builder)

Method Detail

inputCharacter

public final String inputCharacter()

The DTMF character that the user pressed. The allowed characters are A - D, 0 - 9, # and *.

Returns:

The DTMF character that the user pressed. The allowed characters are A - D, 0 - 9, # and *.

eventId

public final String eventId()

A unique identifier that your application assigns to the event. You can use this to identify events in logs.

Returns:

A unique identifier that your application assigns to the event. You can use this to identify events in logs.

clientTimestampMillis

public final Long clientTimestampMillis()

A timestamp set by the client of the date and time that the event was sent to Amazon Lex V2.

Returns:

A timestamp set by the client of the date and time that the event was sent to Amazon Lex V2.

toBuilder

public DTMFInputEvent.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DTMFInputEvent.Builder,DTMFInputEvent>

builder

public static DTMFInputEvent.Builder builder()

serializableBuilderClass

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

Specified by:

copy in interface ToCopyableBuilder<DTMFInputEvent.Builder,DTMFInputEvent>

sdkFields

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

Specified by:

sdkFields in interface SdkPojo