Interface TextMessage.Builder

All Superinterfaces:

Buildable, CopyableBuilder<TextMessage.Builder,TextMessage>, SdkBuilder<TextMessage.Builder,TextMessage>, SdkPojo

Enclosing class:

TextMessage

@Mutable
@NotThreadSafe
public static interface TextMessage.Builder
extends SdkPojo, CopyableBuilder<TextMessage.Builder,TextMessage>

Method Summary

Modifier and Type	Method	Description
default TextMessage.Builder	aiGuardrailAssessment(Consumer<AIGuardrailAssessment.Builder> aiGuardrailAssessment)	The AI Guardrail assessment for the text message.
TextMessage.Builder	aiGuardrailAssessment(AIGuardrailAssessment aiGuardrailAssessment)	The AI Guardrail assessment for the text message.
TextMessage.Builder	citations(Collection<Citation> citations)	The citations associated with the text message.
TextMessage.Builder	citations(Consumer<Citation.Builder>... citations)	The citations associated with the text message.
TextMessage.Builder	citations(Citation... citations)	The citations associated with the text message.
TextMessage.Builder	value(String value)	The value of the message data in text type.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

value

TextMessage.Builder value(String value)

The value of the message data in text type.

Parameters:

value - The value of the message data in text type.

Returns:

Returns a reference to this object so that method calls can be chained together.

citations

TextMessage.Builder citations(Collection<Citation> citations)

The citations associated with the text message.

Parameters:

citations - The citations associated with the text message.

Returns:

Returns a reference to this object so that method calls can be chained together.

citations

TextMessage.Builder citations(Citation... citations)

The citations associated with the text message.

Parameters:

citations - The citations associated with the text message.

Returns:

Returns a reference to this object so that method calls can be chained together.

citations

TextMessage.Builder citations(Consumer<Citation.Builder>... citations)

The citations associated with the text message.

This is a convenience method that creates an instance of the Citation.Builder avoiding the need to create one manually via Citation.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to citations(List<Citation>).

Parameters:

citations - a consumer that will call methods on Citation.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• citations(java.util.Collection<Citation>)

aiGuardrailAssessment

TextMessage.Builder aiGuardrailAssessment(AIGuardrailAssessment aiGuardrailAssessment)

The AI Guardrail assessment for the text message.

Parameters:

aiGuardrailAssessment - The AI Guardrail assessment for the text message.

Returns:

Returns a reference to this object so that method calls can be chained together.

aiGuardrailAssessment

default TextMessage.Builder aiGuardrailAssessment(Consumer<AIGuardrailAssessment.Builder> aiGuardrailAssessment)

The AI Guardrail assessment for the text message.

This is a convenience method that creates an instance of the AIGuardrailAssessment.Builder avoiding the need to create one manually via AIGuardrailAssessment.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to aiGuardrailAssessment(AIGuardrailAssessment).

Parameters:

aiGuardrailAssessment - a consumer that will call methods on AIGuardrailAssessment.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• aiGuardrailAssessment(AIGuardrailAssessment)