software.amazon.awssdk.services.pinpoint.model

Class EndpointMessageResult

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.EndpointMessageResult

All Implemented Interfaces:

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

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

The result from sending a message to an endpoint.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EndpointMessageResult.Builder

Method Summary

Modifier and Type	Method and Description
String	address() Address that endpoint message was delivered to.
static EndpointMessageResult.Builder	builder()
DeliveryStatus	deliveryStatus() The delivery status of the message.
String	deliveryStatusAsString() The delivery status of the message.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	messageId() Unique message identifier associated with the message that was sent.
List<SdkField<?>>	sdkFields()
static Class<? extends EndpointMessageResult.Builder>	serializableBuilderClass()
Integer	statusCode() Downstream service status code.
String	statusMessage() Status message for message delivery.
EndpointMessageResult.Builder	toBuilder()
String	toString()
String	updatedToken() If token was updated as part of delivery.

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

address

public String address()

Address that endpoint message was delivered to.

Returns:

Address that endpoint message was delivered to.

deliveryStatus

public DeliveryStatus deliveryStatus()

The delivery status of the message. Possible values: SUCCESS - The message was successfully delivered to the endpoint. TRANSIENT_FAILURE - A temporary error occurred. Amazon Pinpoint will attempt to deliver the message again later. FAILURE_PERMANENT - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again. TIMEOUT - The message couldn't be sent within the timeout period. QUIET_TIME - The local time for the endpoint was within the QuietTime for the campaign or app. DAILY_CAP - The endpoint has received the maximum number of messages it can receive within a 24-hour period. HOLDOUT - The endpoint was in a hold out treatment for the campaign. THROTTLED - Amazon Pinpoint throttled sending to this endpoint. EXPIRED - The endpoint address is expired. CAMPAIGN_CAP - The endpoint received the maximum number of messages allowed by the campaign. SERVICE_FAILURE - A service-level failure prevented Amazon Pinpoint from delivering the message. UNKNOWN - 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: SUCCESS - The message was successfully delivered to the endpoint. TRANSIENT_FAILURE - A temporary error occurred. Amazon Pinpoint will attempt to deliver the message again later. FAILURE_PERMANENT - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again. TIMEOUT - The message couldn't be sent within the timeout period. QUIET_TIME - The local time for the endpoint was within the QuietTime for the campaign or app. DAILY_CAP - The endpoint has received the maximum number of messages it can receive within a 24-hour period. HOLDOUT - The endpoint was in a hold out treatment for the campaign. THROTTLED - Amazon Pinpoint throttled sending to this endpoint. EXPIRED - The endpoint address is expired. CAMPAIGN_CAP - The endpoint received the maximum number of messages allowed by the campaign. SERVICE_FAILURE - A service-level failure prevented Amazon Pinpoint from delivering the message. UNKNOWN - An unknown error occurred.

See Also:

DeliveryStatus

deliveryStatusAsString

public String deliveryStatusAsString()

The delivery status of the message. Possible values: SUCCESS - The message was successfully delivered to the endpoint. TRANSIENT_FAILURE - A temporary error occurred. Amazon Pinpoint will attempt to deliver the message again later. FAILURE_PERMANENT - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again. TIMEOUT - The message couldn't be sent within the timeout period. QUIET_TIME - The local time for the endpoint was within the QuietTime for the campaign or app. DAILY_CAP - The endpoint has received the maximum number of messages it can receive within a 24-hour period. HOLDOUT - The endpoint was in a hold out treatment for the campaign. THROTTLED - Amazon Pinpoint throttled sending to this endpoint. EXPIRED - The endpoint address is expired. CAMPAIGN_CAP - The endpoint received the maximum number of messages allowed by the campaign. SERVICE_FAILURE - A service-level failure prevented Amazon Pinpoint from delivering the message. UNKNOWN - 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: SUCCESS - The message was successfully delivered to the endpoint. TRANSIENT_FAILURE - A temporary error occurred. Amazon Pinpoint will attempt to deliver the message again later. FAILURE_PERMANENT - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again. TIMEOUT - The message couldn't be sent within the timeout period. QUIET_TIME - The local time for the endpoint was within the QuietTime for the campaign or app. DAILY_CAP - The endpoint has received the maximum number of messages it can receive within a 24-hour period. HOLDOUT - The endpoint was in a hold out treatment for the campaign. THROTTLED - Amazon Pinpoint throttled sending to this endpoint. EXPIRED - The endpoint address is expired. CAMPAIGN_CAP - The endpoint received the maximum number of messages allowed by the campaign. SERVICE_FAILURE - A service-level failure prevented Amazon Pinpoint from delivering the message. UNKNOWN - An unknown error occurred.

See Also:

DeliveryStatus

messageId

public String messageId()

Unique message identifier associated with the message that was sent.

Returns:

Unique message identifier associated with the message that was sent.

statusCode

public Integer statusCode()

Downstream service status code.

Returns:

Downstream service status code.

statusMessage

public String statusMessage()

Status message for message delivery.

Returns:

Status message for message delivery.

updatedToken

public String updatedToken()

If token was updated as part of delivery. (This is GCM Specific)

Returns:

If token was updated as part of delivery. (This is GCM Specific)

toBuilder

public EndpointMessageResult.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EndpointMessageResult.Builder,EndpointMessageResult>

builder

public static EndpointMessageResult.Builder builder()

serializableBuilderClass

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