Package software.amazon.awssdk.services.bedrockagentcore.model

Class HarnessMessageStopEvent

java.lang.Object

software.amazon.awssdk.services.bedrockagentcore.model.HarnessMessageStopEvent

All Implemented Interfaces:

Serializable, SdkPojo, InvokeHarnessStreamOutput, ToCopyableBuilder<HarnessMessageStopEvent.Builder,HarnessMessageStopEvent>

Direct Known Subclasses:

DefaultMessageStop

@Generated("software.amazon.awssdk:codegen")
public class HarnessMessageStopEvent
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<HarnessMessageStopEvent.Builder,HarnessMessageStopEvent>, InvokeHarnessStreamOutput

Event indicating the end of a message.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from interface software.amazon.awssdk.services.bedrockagentcore.model.InvokeHarnessStreamOutput

InvokeHarnessStreamOutput.EventType

Field Summary

Fields inherited from interface software.amazon.awssdk.services.bedrockagentcore.model.InvokeHarnessStreamOutput

UNKNOWN

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HarnessMessageStopEvent(HarnessMessageStopEvent.BuilderImpl builder)

Method Summary

Modifier and Type	Method	Description
void	accept(InvokeHarnessResponseHandler.Visitor visitor)	Calls the appropriate visit method depending on the subtype of HarnessMessageStopEvent.
static HarnessMessageStopEvent.Builder	builder()
final HarnessMessageStopEvent	copy(Consumer<? super HarnessMessageStopEvent.Builder> modifier)
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends HarnessMessageStopEvent.Builder>	serializableBuilderClass()
final HarnessStopReason	stopReason()	The reason the agent stopped generating.
final String	stopReasonAsString()	The reason the agent stopped generating.
HarnessMessageStopEvent.Builder	toBuilder()
final 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.bedrockagentcore.model.InvokeHarnessStreamOutput

sdkEventType

Constructor Details

HarnessMessageStopEvent

protected HarnessMessageStopEvent(HarnessMessageStopEvent.BuilderImpl builder)

Method Details

stopReason

public final HarnessStopReason stopReason()

The reason the agent stopped generating.

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

Returns:

The reason the agent stopped generating.

See Also:

• HarnessStopReason

stopReasonAsString

public final String stopReasonAsString()

The reason the agent stopped generating.

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

Returns:

The reason the agent stopped generating.

See Also:

• HarnessStopReason

toBuilder

public HarnessMessageStopEvent.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<HarnessMessageStopEvent.Builder,HarnessMessageStopEvent>

builder

public static HarnessMessageStopEvent.Builder builder()

serializableBuilderClass

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

Specified by:

copy in interface ToCopyableBuilder<HarnessMessageStopEvent.Builder,HarnessMessageStopEvent>

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(InvokeHarnessResponseHandler.Visitor visitor)

Calls the appropriate visit method depending on the subtype of HarnessMessageStopEvent.

Specified by:

accept in interface InvokeHarnessStreamOutput

Parameters:

visitor - Visitor to invoke.