Package software.amazon.awssdk.services.bedrockagentruntime.model

Class Message

java.lang.Object

software.amazon.awssdk.services.bedrockagentruntime.model.Message

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Message.Builder,Message>

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

Details about a message.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Message.Builder

Method Summary

Modifier and Type	Method	Description
static Message.Builder	builder()
List<ContentBlock>	content()	The message's content.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasContent()	For responses, this returns true if the service returned a value for the Content property.
int	hashCode()
ConversationRole	role()	The message's role.
String	roleAsString()	The message's role.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Message.Builder>	serializableBuilderClass()
Message.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.utils.builder.ToCopyableBuilder

copy

Method Detail

hasContent

public final boolean hasContent()

For responses, this returns true if the service returned a value for the Content property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

content

public final List<ContentBlock> content()

The message's content.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasContent() method.

Returns:

The message's content.

role

public final ConversationRole role()

The message's role.

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 message's role.

See Also:

ConversationRole

roleAsString

public final String roleAsString()

The message's role.

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 message's role.

See Also:

ConversationRole

toBuilder

public Message.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Message.Builder,Message>

builder

public static Message.Builder builder()

serializableBuilderClass

public static Class<? extends Message.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)

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