Interface Message.Builder

All Superinterfaces:

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

Enclosing class:

Message

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

Method Summary

Modifier and Type	Method	Description
default Message.Builder	customPayload(Consumer<CustomPayload.Builder> customPayload)	A message in a custom format defined by the client application.
Message.Builder	customPayload(CustomPayload customPayload)	A message in a custom format defined by the client application.
default Message.Builder	imageResponseCard(Consumer<ImageResponseCard.Builder> imageResponseCard)	A message that defines a response card that the client application can show to the user.
Message.Builder	imageResponseCard(ImageResponseCard imageResponseCard)	A message that defines a response card that the client application can show to the user.
default Message.Builder	plainTextMessage(Consumer<PlainTextMessage.Builder> plainTextMessage)	A message in plain text format.
Message.Builder	plainTextMessage(PlainTextMessage plainTextMessage)	A message in plain text format.
default Message.Builder	ssmlMessage(Consumer<SSMLMessage.Builder> ssmlMessage)	A message in Speech Synthesis Markup Language (SSML).
Message.Builder	ssmlMessage(SSMLMessage ssmlMessage)	A message in Speech Synthesis Markup Language (SSML).

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

plainTextMessage

Message.Builder plainTextMessage(PlainTextMessage plainTextMessage)

A message in plain text format.

Parameters:

plainTextMessage - A message in plain text format.

Returns:

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

plainTextMessage

default Message.Builder plainTextMessage(Consumer<PlainTextMessage.Builder> plainTextMessage)

A message in plain text format.

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

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

Parameters:

plainTextMessage - a consumer that will call methods on PlainTextMessage.Builder

Returns:

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

See Also:

• plainTextMessage(PlainTextMessage)

customPayload

Message.Builder customPayload(CustomPayload customPayload)

A message in a custom format defined by the client application.

Parameters:

customPayload - A message in a custom format defined by the client application.

Returns:

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

customPayload

default Message.Builder customPayload(Consumer<CustomPayload.Builder> customPayload)

A message in a custom format defined by the client application.

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

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

Parameters:

customPayload - a consumer that will call methods on CustomPayload.Builder

Returns:

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

See Also:

• customPayload(CustomPayload)

ssmlMessage

Message.Builder ssmlMessage(SSMLMessage ssmlMessage)

A message in Speech Synthesis Markup Language (SSML).

Parameters:

ssmlMessage - A message in Speech Synthesis Markup Language (SSML).

Returns:

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

ssmlMessage

default Message.Builder ssmlMessage(Consumer<SSMLMessage.Builder> ssmlMessage)

A message in Speech Synthesis Markup Language (SSML).

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

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

Parameters:

ssmlMessage - a consumer that will call methods on SSMLMessage.Builder

Returns:

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

See Also:

• ssmlMessage(SSMLMessage)

imageResponseCard

Message.Builder imageResponseCard(ImageResponseCard imageResponseCard)

A message that defines a response card that the client application can show to the user.

Parameters:

imageResponseCard - A message that defines a response card that the client application can show to the user.

Returns:

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

imageResponseCard

default Message.Builder imageResponseCard(Consumer<ImageResponseCard.Builder> imageResponseCard)

A message that defines a response card that the client application can show to the user.

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

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

Parameters:

imageResponseCard - a consumer that will call methods on ImageResponseCard.Builder

Returns:

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

See Also:

• imageResponseCard(ImageResponseCard)