software.amazon.awssdk.services.pinpoint.model

Class MessageResult

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.MessageResult

All Implemented Interfaces:

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

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

Provides information about the results of sending a message directly to an endpoint address.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MessageResult.Builder

Method Summary

Modifier and Type	Method and Description
static MessageResult.Builder	builder()
DeliveryStatus	deliveryStatus() The delivery status of the message.
String	deliveryStatusAsString() The delivery status of the message.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	messageId() The unique identifier for the message that was sent.
List<SdkField<?>>	sdkFields()
static Class<? extends MessageResult.Builder>	serializableBuilderClass()
Integer	statusCode() The downstream service status code for delivering the message.
String	statusMessage() The status message for delivering the message.
MessageResult.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	updatedToken() For push notifications that are sent through the GCM channel, specifies whether the endpoint's device registration token was updated as part of delivering the message.

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

deliveryStatus

public final DeliveryStatus deliveryStatus()

The delivery status of the message. Possible values are:

• DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.

• OPT_OUT - The user who's associated with the endpoint address has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.

• PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint address. Amazon Pinpoint won't attempt to send the message again.

• SUCCESSFUL - The message was successfully delivered to the endpoint address.

• TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.

• THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint address.

• TIMEOUT - The message couldn't be sent within the timeout period.

• UNKNOWN_FAILURE - An unknown error occurred.

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

Returns:

The delivery status of the message. Possible values are:

• DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.

• OPT_OUT - The user who's associated with the endpoint address has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.

• PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint address. Amazon Pinpoint won't attempt to send the message again.

• SUCCESSFUL - The message was successfully delivered to the endpoint address.

• TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.

• THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint address.

• TIMEOUT - The message couldn't be sent within the timeout period.

• UNKNOWN_FAILURE - An unknown error occurred.

See Also:

DeliveryStatus

deliveryStatusAsString

public final String deliveryStatusAsString()

The delivery status of the message. Possible values are:

• DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.

• OPT_OUT - The user who's associated with the endpoint address has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.

• PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint address. Amazon Pinpoint won't attempt to send the message again.

• SUCCESSFUL - The message was successfully delivered to the endpoint address.

• TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.

• THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint address.

• TIMEOUT - The message couldn't be sent within the timeout period.

• UNKNOWN_FAILURE - An unknown error occurred.

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

Returns:

The delivery status of the message. Possible values are:

• DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.

• OPT_OUT - The user who's associated with the endpoint address has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.

• PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint address. Amazon Pinpoint won't attempt to send the message again.

• SUCCESSFUL - The message was successfully delivered to the endpoint address.

• TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.

• THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint address.

• TIMEOUT - The message couldn't be sent within the timeout period.

• UNKNOWN_FAILURE - An unknown error occurred.

See Also:

DeliveryStatus

messageId

public final String messageId()

The unique identifier for the message that was sent.

Returns:

The unique identifier for the message that was sent.

statusCode

public final Integer statusCode()

The downstream service status code for delivering the message.

Returns:

The downstream service status code for delivering the message.

statusMessage

public final String statusMessage()

The status message for delivering the message.

Returns:

The status message for delivering the message.

updatedToken

public final String updatedToken()

For push notifications that are sent through the GCM channel, specifies whether the endpoint's device registration token was updated as part of delivering the message.

Returns:

For push notifications that are sent through the GCM channel, specifies whether the endpoint's device registration token was updated as part of delivering the message.

toBuilder

public MessageResult.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MessageResult.Builder,MessageResult>

builder

public static MessageResult.Builder builder()

serializableBuilderClass

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