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

Class MessageStartEvent

java.lang.Object

software.amazon.awssdk.services.bedrockruntime.model.MessageStartEvent

All Implemented Interfaces:

Serializable, SdkPojo, ConverseStreamOutput, ToCopyableBuilder<MessageStartEvent.Builder,MessageStartEvent>

Direct Known Subclasses:

DefaultMessageStart

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

The start of a message.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MessageStartEvent.Builder
protected static class	MessageStartEvent.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	MessageStartEvent(MessageStartEvent.BuilderImpl builder)

Method Summary

Modifier and Type	Method	Description
void	accept(ConverseStreamResponseHandler.Visitor visitor)	Calls the appropriate visit method depending on the subtype of MessageStartEvent.
static MessageStartEvent.Builder	builder()
MessageStartEvent	copy(Consumer<? super MessageStartEvent.Builder> modifier)
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
ConversationRole	role()	The role for the message.
String	roleAsString()	The role for the message.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends MessageStartEvent.Builder>	serializableBuilderClass()
MessageStartEvent.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

MessageStartEvent

protected MessageStartEvent(MessageStartEvent.BuilderImpl builder)

Method Detail

role

public final ConversationRole role()

The role for the message.

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

Returns:

The role for the message.

See Also:

ConversationRole

roleAsString

public final String roleAsString()

The role for the message.

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

Returns:

The role for the message.

See Also:

ConversationRole

toBuilder

public MessageStartEvent.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MessageStartEvent.Builder,MessageStartEvent>

builder

public static MessageStartEvent.Builder builder()

serializableBuilderClass

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

Specified by:

copy in interface ToCopyableBuilder<MessageStartEvent.Builder,MessageStartEvent>

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 MessageStartEvent.

Specified by:

accept in interface ConverseStreamOutput

Parameters:

visitor - Visitor to invoke.