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

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

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()
final MessageStartEvent	copy(Consumer<? super MessageStartEvent.Builder> modifier)	A convenience method for calling ToCopyableBuilder.toBuilder(), updating the returned builder and then calling SdkBuilder.build().
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final ConversationRole	role()	The role for the message.
final String	roleAsString()	The role for the message.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends MessageStartEvent.Builder>	serializableBuilderClass()
MessageStartEvent.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

sdkEventType

Method Details

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()

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

Returns:

a builder for type T

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)

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 MessageStartEvent copy(Consumer<? super MessageStartEvent.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<MessageStartEvent.Builder,MessageStartEvent>

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

Specified by:

accept in interface ConverseStreamOutput

Parameters:

visitor - Visitor to invoke.