Class MessageStopEvent

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

The stop event for a message.

See Also:

  • Method Details

    • stopReason

      public final StopReason stopReason()

      The reason why the model stopped generating output.

      If the service returns an enum value that is not available in the current SDK version, stopReason will return StopReason.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stopReasonAsString().

      Returns:
      The reason why the model stopped generating output.
      See Also:

    • stopReasonAsString

      public final String stopReasonAsString()

      The reason why the model stopped generating output.

      If the service returns an enum value that is not available in the current SDK version, stopReason will return StopReason.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stopReasonAsString().

      Returns:
      The reason why the model stopped generating output.
      See Also:

    • additionalModelResponseFields

      public final Document additionalModelResponseFields()

      The additional model response fields.

      Returns:
      The additional model response fields.

    • toBuilder

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

    • builder

      public static MessageStopEvent.Builder builder()

    • serializableBuilderClass

      public static Class<? extends MessageStopEvent.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 MessageStopEvent copy(Consumer<? super MessageStopEvent.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<MessageStopEvent.Builder,MessageStopEvent>
      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(ConverseStreamResponseHandler.Visitor visitor)
      Calls the appropriate visit method depending on the subtype of MessageStopEvent.
      Specified by:
      accept in interface ConverseStreamOutput
      Parameters:
      visitor - Visitor to invoke.