Package software.amazon.awssdk.services.chime.model

Class SendChannelMessageRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.chime.model.ChimeRequest

software.amazon.awssdk.services.chime.model.SendChannelMessageRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SendChannelMessageRequest.Builder,SendChannelMessageRequest>

@Generated("software.amazon.awssdk:codegen")
public final class SendChannelMessageRequest
extends ChimeRequest
implements ToCopyableBuilder<SendChannelMessageRequest.Builder,SendChannelMessageRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SendChannelMessageRequest.Builder

Method Summary

Modifier and Type	Method	Description
static SendChannelMessageRequest.Builder	builder()
String	channelArn()	The ARN of the channel.
String	chimeBearer()	The AppInstanceUserArn of the user that makes the API call.
String	clientRequestToken()	The Idempotency token for each client request.
String	content()	The content of the message.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	metadata()	The optional metadata for each message.
ChannelMessagePersistenceType	persistence()	Boolean that controls whether the message is persisted on the back end.
String	persistenceAsString()	Boolean that controls whether the message is persisted on the back end.
List<SdkField<?>>	sdkFields()
static Class<? extends SendChannelMessageRequest.Builder>	serializableBuilderClass()
SendChannelMessageRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
ChannelMessageType	type()	The type of message, STANDARD or CONTROL.
String	typeAsString()	The type of message, STANDARD or CONTROL.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

channelArn

public final String channelArn()

The ARN of the channel.

Returns:

The ARN of the channel.

content

public final String content()

The content of the message.

Returns:

The content of the message.

type

public final ChannelMessageType type()

The type of message, STANDARD or CONTROL.

If the service returns an enum value that is not available in the current SDK version, type will return ChannelMessageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of message, STANDARD or CONTROL.

See Also:

ChannelMessageType

typeAsString

public final String typeAsString()

The type of message, STANDARD or CONTROL.

If the service returns an enum value that is not available in the current SDK version, type will return ChannelMessageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of message, STANDARD or CONTROL.

See Also:

ChannelMessageType

persistence

public final ChannelMessagePersistenceType persistence()

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

If the service returns an enum value that is not available in the current SDK version, persistence will return ChannelMessagePersistenceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from persistenceAsString().

Returns:

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

See Also:

ChannelMessagePersistenceType

persistenceAsString

public final String persistenceAsString()

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

If the service returns an enum value that is not available in the current SDK version, persistence will return ChannelMessagePersistenceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from persistenceAsString().

Returns:

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

See Also:

ChannelMessagePersistenceType

metadata

public final String metadata()

The optional metadata for each message.

Returns:

The optional metadata for each message.

clientRequestToken

public final String clientRequestToken()

The Idempotency token for each client request.

Returns:

The Idempotency token for each client request.

chimeBearer

public final String chimeBearer()

The AppInstanceUserArn of the user that makes the API call.

Returns:

The AppInstanceUserArn of the user that makes the API call.

toBuilder

public SendChannelMessageRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SendChannelMessageRequest.Builder,SendChannelMessageRequest>

Specified by:

toBuilder in class ChimeRequest

builder

public static SendChannelMessageRequest.Builder builder()

serializableBuilderClass

public static Class<? extends SendChannelMessageRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo