software.amazon.awssdk.services.chimesdkmessaging.model

Interface ChannelMessage.Builder

All Superinterfaces:

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

Enclosing class:

ChannelMessage

public static interface ChannelMessage.Builder
extends SdkPojo, CopyableBuilder<ChannelMessage.Builder,ChannelMessage>

Method Summary

Modifier and Type	Method and Description
ChannelMessage.Builder	channelArn(String channelArn) The ARN of the channel.
ChannelMessage.Builder	content(String content) The message content.
ChannelMessage.Builder	contentType(String contentType) The content type of the channel message.
ChannelMessage.Builder	createdTimestamp(Instant createdTimestamp) The time at which the message was created.
ChannelMessage.Builder	lastEditedTimestamp(Instant lastEditedTimestamp) The time at which a message was edited.
ChannelMessage.Builder	lastUpdatedTimestamp(Instant lastUpdatedTimestamp) The time at which a message was updated.
ChannelMessage.Builder	messageAttributes(Map<String,MessageAttributeValue> messageAttributes) The attributes for the message, used for message filtering along with a FilterRule defined in the PushNotificationPreferences.
ChannelMessage.Builder	messageId(String messageId) The ID of a message.
ChannelMessage.Builder	metadata(String metadata) The message metadata.
ChannelMessage.Builder	persistence(ChannelMessagePersistenceType persistence) The persistence setting for a channel message.
ChannelMessage.Builder	persistence(String persistence) The persistence setting for a channel message.
ChannelMessage.Builder	redacted(Boolean redacted) Hides the content of a message.
default ChannelMessage.Builder	sender(Consumer<Identity.Builder> sender) The message sender.
ChannelMessage.Builder	sender(Identity sender) The message sender.
ChannelMessage.Builder	status(ChannelMessageStatusStructure status) The status of the channel message.
default ChannelMessage.Builder	status(Consumer<ChannelMessageStatusStructure.Builder> status) The status of the channel message.
ChannelMessage.Builder	subChannelId(String subChannelId) The ID of the SubChannel.
ChannelMessage.Builder	type(ChannelMessageType type) The message type.
ChannelMessage.Builder	type(String type) The message type.

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

channelArn

ChannelMessage.Builder channelArn(String channelArn)

The ARN of the channel.

Parameters:

channelArn - The ARN of the channel.

Returns:

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

messageId

ChannelMessage.Builder messageId(String messageId)

The ID of a message.

Parameters:

messageId - The ID of a message.

Returns:

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

content

ChannelMessage.Builder content(String content)

The message content.

Parameters:

content - The message content.

Returns:

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

metadata

ChannelMessage.Builder metadata(String metadata)

The message metadata.

Parameters:

metadata - The message metadata.

Returns:

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

type

ChannelMessage.Builder type(String type)

The message type.

Parameters:

type - The message type.

Returns:

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

See Also:

ChannelMessageType, ChannelMessageType

type

ChannelMessage.Builder type(ChannelMessageType type)

The message type.

Parameters:

type - The message type.

Returns:

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

See Also:

ChannelMessageType, ChannelMessageType

createdTimestamp

ChannelMessage.Builder createdTimestamp(Instant createdTimestamp)

The time at which the message was created.

Parameters:

createdTimestamp - The time at which the message was created.

Returns:

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

lastEditedTimestamp

ChannelMessage.Builder lastEditedTimestamp(Instant lastEditedTimestamp)

The time at which a message was edited.

Parameters:

lastEditedTimestamp - The time at which a message was edited.

Returns:

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

lastUpdatedTimestamp

ChannelMessage.Builder lastUpdatedTimestamp(Instant lastUpdatedTimestamp)

The time at which a message was updated.

Parameters:

lastUpdatedTimestamp - The time at which a message was updated.

Returns:

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

sender

ChannelMessage.Builder sender(Identity sender)

The message sender.

Parameters:

sender - The message sender.

Returns:

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

sender

default ChannelMessage.Builder sender(Consumer<Identity.Builder> sender)

The message sender.

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

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

Parameters:

sender - a consumer that will call methods on Identity.Builder

Returns:

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

See Also:

sender(Identity)

redacted

ChannelMessage.Builder redacted(Boolean redacted)

Hides the content of a message.

Parameters:

redacted - Hides the content of a message.

Returns:

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

persistence

ChannelMessage.Builder persistence(String persistence)

The persistence setting for a channel message.

Parameters:

persistence - The persistence setting for a channel message.

Returns:

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

See Also:

ChannelMessagePersistenceType, ChannelMessagePersistenceType

persistence

ChannelMessage.Builder persistence(ChannelMessagePersistenceType persistence)

The persistence setting for a channel message.

Parameters:

persistence - The persistence setting for a channel message.

Returns:

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

See Also:

ChannelMessagePersistenceType, ChannelMessagePersistenceType

status

ChannelMessage.Builder status(ChannelMessageStatusStructure status)

The status of the channel message.

Parameters:

status - The status of the channel message.

Returns:

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

status

default ChannelMessage.Builder status(Consumer<ChannelMessageStatusStructure.Builder> status)

The status of the channel message.

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

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

Parameters:

status - a consumer that will call methods on ChannelMessageStatusStructure.Builder

Returns:

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

See Also:

status(ChannelMessageStatusStructure)

messageAttributes

ChannelMessage.Builder messageAttributes(Map<String,MessageAttributeValue> messageAttributes)

The attributes for the message, used for message filtering along with a FilterRule defined in the PushNotificationPreferences.

Parameters:

messageAttributes - The attributes for the message, used for message filtering along with a FilterRule defined in the PushNotificationPreferences.

Returns:

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

subChannelId

ChannelMessage.Builder subChannelId(String subChannelId)

The ID of the SubChannel.

Parameters:

subChannelId - The ID of the SubChannel.

Returns:

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

contentType

ChannelMessage.Builder contentType(String contentType)

The content type of the channel message.

Parameters:

contentType - The content type of the channel message.

Returns:

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