java.lang.Object
- software.amazon.awssdk.services.pinpoint.model.SendUsersMessageRequest

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SendUsersMessageRequest.Builder,SendUsersMessageRequest>
```
@Generated("software.amazon.awssdk:codegen")
public final class SendUsersMessageRequest
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SendUsersMessageRequest.Builder,SendUsersMessageRequest>
```
Specifies the configuration and other settings for a message to send to all the endpoints that are associated with a list of users.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface SendUsersMessageRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static SendUsersMessageRequest.Builder`	`builder()`
`Map<String,String>`	`context()`	A map of custom attribute-value pairs.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasContext()`	For responses, this returns true if the service returned a value for the Context property.
`int`	`hashCode()`
`boolean`	`hasUsers()`	For responses, this returns true if the service returned a value for the Users property.
`DirectMessageConfiguration`	`messageConfiguration()`	The settings and content for the default message and any default messages that you defined for specific channels.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends SendUsersMessageRequest.Builder>`	`serializableBuilderClass()`
`TemplateConfiguration`	`templateConfiguration()`	The message template to use for the message.
`SendUsersMessageRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`traceId()`	The unique identifier for tracing the message.
`Map<String,EndpointSendConfiguration>`	`users()`	A map that associates user IDs with EndpointSendConfiguration objects.

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
  - hasContext
```
public final boolean hasContext()
```
    For responses, this returns true if the service returned a value for the Context property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - context
```
public final Map<String,String> context()
```
    A map of custom attribute-value pairs. For a push notification, Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the 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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasContext() method.
    
    Returns:
    
    A map of custom attribute-value pairs. For a push notification, Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the notification payload. Amazon Pinpoint also provides these attributes in the events that it generates for users-messages deliveries.
  - messageConfiguration
```
public final DirectMessageConfiguration messageConfiguration()
```
    The settings and content for the default message and any default messages that you defined for specific channels.
    
    Returns:
    
    The settings and content for the default message and any default messages that you defined for specific channels.
  - templateConfiguration
```
public final TemplateConfiguration templateConfiguration()
```
    The message template to use for the message.
    
    Returns:
    
    The message template to use for the message.
  - traceId
```
public final String traceId()
```
    The unique identifier for tracing the message. This identifier is visible to message recipients.
    
    Returns:
    
    The unique identifier for tracing the message. This identifier is visible to message recipients.
  - hasUsers
```
public final boolean hasUsers()
```
    For responses, this returns true if the service returned a value for the Users property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - users
```
public final Map<String,EndpointSendConfiguration> users()
```
    A map that associates user IDs with EndpointSendConfiguration objects. You can use an EndpointSendConfiguration object to tailor the message for a user by specifying settings such as content overrides and message variables.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasUsers() method.
    
    Returns:
    
    A map that associates user IDs with EndpointSendConfiguration objects. You can use an EndpointSendConfiguration object to tailor the message for a user by specifying settings such as content overrides and message variables.
  - toBuilder
```
public SendUsersMessageRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SendUsersMessageRequest.Builder,SendUsersMessageRequest>
  - builder
```
public static SendUsersMessageRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SendUsersMessageRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class SendUsersMessageRequest

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

hasContext

context

messageConfiguration

templateConfiguration

traceId

hasUsers

users

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields