software.amazon.awssdk.services.pinpoint.model

Class SendUsersMessageRequest

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.SendUsersMessageRequest

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SendUsersMessageRequest.Builder,SendUsersMessageRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class SendUsersMessageRequest
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SendUsersMessageRequest.Builder,SendUsersMessageRequest>

Send message request.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SendUsersMessageRequest.Builder

Method Summary

Modifier and Type	Method and Description
static SendUsersMessageRequest.Builder	builder()
Map<String,String>	context() A map of custom attribute-value pairs.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
DirectMessageConfiguration	messageConfiguration() Message definitions for the default message and any messages that are tailored for specific channels.
List<SdkField<?>>	sdkFields()
static Class<? extends SendUsersMessageRequest.Builder>	serializableBuilderClass()
SendUsersMessageRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	traceId() A unique ID that you can use to trace a message.
Map<String,EndpointSendConfiguration>	users() A map that associates user IDs with EndpointSendConfiguration objects.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

context

public Map<String,String> context()

A map of custom attribute-value pairs. Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the push notification payload. Amazon Pinpoint also provides these attributes in the events that it generates for users-messages deliveries.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A map of custom attribute-value pairs. Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the push notification payload. Amazon Pinpoint also provides these attributes in the events that it generates for users-messages deliveries.

messageConfiguration

public DirectMessageConfiguration messageConfiguration()

Message definitions for the default message and any messages that are tailored for specific channels.

Returns:

Message definitions for the default message and any messages that are tailored for specific channels.

traceId

public String traceId()

A unique ID that you can use to trace a message. This ID is visible to recipients.

Returns:

A unique ID that you can use to trace a message. This ID is visible to recipients.

users

public Map<String,EndpointSendConfiguration> users()

A map that associates user IDs with EndpointSendConfiguration objects. Within an EndpointSendConfiguration object, you can tailor the message for a user by specifying message overrides or substitutions.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A map that associates user IDs with EndpointSendConfiguration objects. Within an EndpointSendConfiguration object, you can tailor the message for a user by specifying message overrides or substitutions.

toBuilder

public SendUsersMessageRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<SendUsersMessageRequest.Builder,SendUsersMessageRequest>

Returns:

a builder for type T

builder

public static SendUsersMessageRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.