Class HeartbeatEvent

java.lang.Object
software.amazon.awssdk.services.lexruntimev2.model.HeartbeatEvent
All Implemented Interfaces:
Serializable, SdkPojo, StartConversationResponseEventStream, ToCopyableBuilder<HeartbeatEvent.Builder,HeartbeatEvent>
Direct Known Subclasses:
DefaultHeartbeatEvent
@Generated("software.amazon.awssdk:codegen") public class HeartbeatEvent extends Object implements SdkPojo, Serializable, ToCopyableBuilder<HeartbeatEvent.Builder,HeartbeatEvent>, StartConversationResponseEventStream

Event that Amazon Lex V2 sends to indicate that the stream is still open between the client application and Amazon Lex V2

See Also:

  • Method Details

    • 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 HeartbeatEvent.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<HeartbeatEvent.Builder,HeartbeatEvent>
      Returns:
      a builder for type T

    • builder

      public static HeartbeatEvent.Builder builder()

    • serializableBuilderClass

      public static Class<? extends HeartbeatEvent.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 HeartbeatEvent copy(Consumer<? super HeartbeatEvent.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<HeartbeatEvent.Builder,HeartbeatEvent>
      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 HeartbeatEvent.
      Specified by:
      accept in interface StartConversationResponseEventStream
      Parameters:
      visitor - Visitor to invoke.