Package software.amazon.awssdk.services.bedrockruntime.model

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:

Serialized Form

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from interface software.amazon.awssdk.services.bedrockruntime.model.ConverseStreamOutput

ConverseStreamOutput.EventType

Field Summary

Fields inherited from interface software.amazon.awssdk.services.bedrockruntime.model.ConverseStreamOutput

UNKNOWN

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MessageStopEvent(MessageStopEvent.BuilderImpl builder)

Method Summary

Modifier and Type	Method	Description
void	accept(ConverseStreamResponseHandler.Visitor visitor)	Calls the appropriate visit method depending on the subtype of MessageStopEvent.
Document	additionalModelResponseFields()	The additional model response fields.
static MessageStopEvent.Builder	builder()
MessageStopEvent	copy(Consumer<? super MessageStopEvent.Builder> modifier)
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends MessageStopEvent.Builder>	serializableBuilderClass()
StopReason	stopReason()	The reason why the model stopped generating output.
String	stopReasonAsString()	The reason why the model stopped generating output.
MessageStopEvent.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.bedrockruntime.model.ConverseStreamOutput

sdkEventType

Constructor Detail

MessageStopEvent

protected MessageStopEvent(MessageStopEvent.BuilderImpl builder)

Method Detail

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:

StopReason

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:

StopReason

additionalModelResponseFields

public final Document additionalModelResponseFields()

The additional model response fields.

Returns:

The additional model response fields.

toBuilder

public MessageStopEvent.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MessageStopEvent.Builder,MessageStopEvent>

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)

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 MessageStopEvent copy(Consumer<? super MessageStopEvent.Builder> modifier)

Specified by:

copy in interface ToCopyableBuilder<MessageStopEvent.Builder,MessageStopEvent>

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo

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.