Package software.amazon.awssdk.services.pinpoint.model

Class SendUsersMessageResponse

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.SendUsersMessageResponse

All Implemented Interfaces:

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

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

Provides information about which users and endpoints a message was sent to.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SendUsersMessageResponse.Builder

Method Summary

Modifier and Type	Method	Description
String	applicationId()	The unique identifier for the application that was used to send the message.
static SendUsersMessageResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasResult()	For responses, this returns true if the service returned a value for the Result property.
String	requestId()	The unique identifier that was assigned to the message request.
Map<String,Map<String,EndpointMessageResult>>	result()	An object that indicates which endpoints the message was sent to, for each user.
List<SdkField<?>>	sdkFields()
static Class<? extends SendUsersMessageResponse.Builder>	serializableBuilderClass()
SendUsersMessageResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

applicationId

public final String applicationId()

The unique identifier for the application that was used to send the message.

Returns:

The unique identifier for the application that was used to send the message.

requestId

public final String requestId()

The unique identifier that was assigned to the message request.

Returns:

The unique identifier that was assigned to the message request.

hasResult

public final boolean hasResult()

For responses, this returns true if the service returned a value for the Result 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.

result

public final Map<String,Map<String,EndpointMessageResult>> result()

An object that indicates which endpoints the message was sent to, for each user. The object lists user IDs and, for each user ID, provides the endpoint IDs that the message was sent to. For each endpoint ID, it provides an EndpointMessageResult object.

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 hasResult() method.

Returns:

An object that indicates which endpoints the message was sent to, for each user. The object lists user IDs and, for each user ID, provides the endpoint IDs that the message was sent to. For each endpoint ID, it provides an EndpointMessageResult object.

toBuilder

public SendUsersMessageResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SendUsersMessageResponse.Builder,SendUsersMessageResponse>

builder

public static SendUsersMessageResponse.Builder builder()

serializableBuilderClass

public static Class<? extends SendUsersMessageResponse.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