software.amazon.awssdk.services.pinpoint.model

Class MessageResponse

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.MessageResponse

All Implemented Interfaces:

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

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

Provides information about the results of a request to send a message to an endpoint address.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MessageResponse.Builder

Method Summary

Modifier and Type	Method and Description
String	applicationId() The unique identifier for the application that was used to send the message.
static MessageResponse.Builder	builder()
Map<String,EndpointMessageResult>	endpointResult() A map that contains a multipart response for each address that the message was sent to.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEndpointResult() For responses, this returns true if the service returned a value for the EndpointResult property.
int	hashCode()
boolean	hasResult() For responses, this returns true if the service returned a value for the Result property.
String	requestId() The identifier for the original request that the message was delivered for.
Map<String,MessageResult>	result() A map that contains a multipart response for each address (email address, phone number, or push notification token) that the message was sent to.
List<SdkField<?>>	sdkFields()
static Class<? extends MessageResponse.Builder>	serializableBuilderClass()
MessageResponse.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.

hasEndpointResult

public final boolean hasEndpointResult()

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

endpointResult

public final Map<String,EndpointMessageResult> endpointResult()

A map that contains a multipart response for each address that the message was sent to. In the map, the endpoint ID is the key and the result is the value.

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

Returns:

A map that contains a multipart response for each address that the message was sent to. In the map, the endpoint ID is the key and the result is the value.

requestId

public final String requestId()

The identifier for the original request that the message was delivered for.

Returns:

The identifier for the original request that the message was delivered for.

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,MessageResult> result()

A map that contains a multipart response for each address (email address, phone number, or push notification token) that the message was sent to. In the map, the address is the key and the result is the value.

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:

A map that contains a multipart response for each address (email address, phone number, or push notification token) that the message was sent to. In the map, the address is the key and the result is the value.

toBuilder

public MessageResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MessageResponse.Builder,MessageResponse>

builder

public static MessageResponse.Builder builder()

serializableBuilderClass

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