software.amazon.awssdk.services.chimesdkmessaging.model

Interface SendChannelMessageRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, ChimeSdkMessagingRequest.Builder, CopyableBuilder<SendChannelMessageRequest.Builder,SendChannelMessageRequest>, SdkBuilder<SendChannelMessageRequest.Builder,SendChannelMessageRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

SendChannelMessageRequest

public static interface SendChannelMessageRequest.Builder
extends ChimeSdkMessagingRequest.Builder, SdkPojo, CopyableBuilder<SendChannelMessageRequest.Builder,SendChannelMessageRequest>

Method Summary

Modifier and Type	Method and Description
SendChannelMessageRequest.Builder	channelArn(String channelArn) The ARN of the channel.
SendChannelMessageRequest.Builder	chimeBearer(String chimeBearer) The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
SendChannelMessageRequest.Builder	clientRequestToken(String clientRequestToken) The Idempotency token for each client request.
SendChannelMessageRequest.Builder	content(String content) The content of the message.
SendChannelMessageRequest.Builder	contentType(String contentType) The content type of the channel message.
SendChannelMessageRequest.Builder	messageAttributes(Map<String,MessageAttributeValue> messageAttributes) The attributes for the message, used for message filtering along with a FilterRule defined in the PushNotificationPreferences.
SendChannelMessageRequest.Builder	metadata(String metadata) The optional metadata for each message.
SendChannelMessageRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
SendChannelMessageRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
SendChannelMessageRequest.Builder	persistence(ChannelMessagePersistenceType persistence) Boolean that controls whether the message is persisted on the back end.
SendChannelMessageRequest.Builder	persistence(String persistence) Boolean that controls whether the message is persisted on the back end.
default SendChannelMessageRequest.Builder	pushNotification(Consumer<PushNotificationConfiguration.Builder> pushNotification) The push notification configuration of the message.
SendChannelMessageRequest.Builder	pushNotification(PushNotificationConfiguration pushNotification) The push notification configuration of the message.
SendChannelMessageRequest.Builder	subChannelId(String subChannelId) The ID of the SubChannel in the request.
SendChannelMessageRequest.Builder	type(ChannelMessageType type) The type of message, STANDARD or CONTROL.
SendChannelMessageRequest.Builder	type(String type) The type of message, STANDARD or CONTROL.

Methods inherited from interface software.amazon.awssdk.services.chimesdkmessaging.model.ChimeSdkMessagingRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

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

content

SendChannelMessageRequest.Builder content(String content)

The content of the message.

Parameters:

content - The content of the message.

Returns:

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

type

SendChannelMessageRequest.Builder type(String type)

The type of message, STANDARD or CONTROL.

Parameters:

type - The type of message, STANDARD or CONTROL.

Returns:

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

See Also:

ChannelMessageType, ChannelMessageType

type

SendChannelMessageRequest.Builder type(ChannelMessageType type)

The type of message, STANDARD or CONTROL.

Parameters:

type - The type of message, STANDARD or CONTROL.

Returns:

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

See Also:

ChannelMessageType, ChannelMessageType

persistence

SendChannelMessageRequest.Builder persistence(String persistence)

Boolean that controls whether the message is persisted on the back end. Required.

Parameters:

persistence - Boolean that controls whether the message is persisted on the back end. Required.

Returns:

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

See Also:

ChannelMessagePersistenceType, ChannelMessagePersistenceType

persistence

SendChannelMessageRequest.Builder persistence(ChannelMessagePersistenceType persistence)

Boolean that controls whether the message is persisted on the back end. Required.

Parameters:

persistence - Boolean that controls whether the message is persisted on the back end. Required.

Returns:

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

See Also:

ChannelMessagePersistenceType, ChannelMessagePersistenceType

metadata

SendChannelMessageRequest.Builder metadata(String metadata)

The optional metadata for each message.

Parameters:

metadata - The optional metadata for each message.

Returns:

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

clientRequestToken

SendChannelMessageRequest.Builder clientRequestToken(String clientRequestToken)

The Idempotency token for each client request.

Parameters:

clientRequestToken - The Idempotency token for each client request.

Returns:

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

chimeBearer

SendChannelMessageRequest.Builder chimeBearer(String chimeBearer)

The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

Parameters:

chimeBearer - The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

Returns:

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

pushNotification

SendChannelMessageRequest.Builder pushNotification(PushNotificationConfiguration pushNotification)

The push notification configuration of the message.

Parameters:

pushNotification - The push notification configuration of the message.

Returns:

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

pushNotification

default SendChannelMessageRequest.Builder pushNotification(Consumer<PushNotificationConfiguration.Builder> pushNotification)

The push notification configuration of the message.

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

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

Parameters:

pushNotification - a consumer that will call methods on PushNotificationConfiguration.Builder

Returns:

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

See Also:

pushNotification(PushNotificationConfiguration)

messageAttributes

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

SendChannelMessageRequest.Builder subChannelId(String subChannelId)

The ID of the SubChannel in the request.

Parameters:

subChannelId - The ID of the SubChannel in the request.

Returns:

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

contentType

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

overrideConfiguration

SendChannelMessageRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

SendChannelMessageRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder