com.amazonaws.services.pinpoint.model

Class MessageResult

java.lang.Object

com.amazonaws.services.pinpoint.model.MessageResult

All Implemented Interfaces:

java.io.Serializable

public class MessageResult
extends java.lang.Object
implements java.io.Serializable

The result from sending a message to an address.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MessageResult()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getDeliveryStatus() The delivery status of the message.
java.lang.String	getMessageId() Unique message identifier associated with the message that was sent.
java.lang.Integer	getStatusCode() Downstream service status code.
java.lang.String	getStatusMessage() Status message for message delivery.
java.lang.String	getUpdatedToken() If token was updated as part of delivery.
int	hashCode()
void	setDeliveryStatus(DeliveryStatus deliveryStatus) The delivery status of the message.
void	setDeliveryStatus(java.lang.String deliveryStatus) The delivery status of the message.
void	setMessageId(java.lang.String messageId) Unique message identifier associated with the message that was sent.
void	setStatusCode(java.lang.Integer statusCode) Downstream service status code.
void	setStatusMessage(java.lang.String statusMessage) Status message for message delivery.
void	setUpdatedToken(java.lang.String updatedToken) If token was updated as part of delivery.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
MessageResult	withDeliveryStatus(DeliveryStatus deliveryStatus) The delivery status of the message.
MessageResult	withDeliveryStatus(java.lang.String deliveryStatus) The delivery status of the message.
MessageResult	withMessageId(java.lang.String messageId) Unique message identifier associated with the message that was sent.
MessageResult	withStatusCode(java.lang.Integer statusCode) Downstream service status code.
MessageResult	withStatusMessage(java.lang.String statusMessage) Status message for message delivery.
MessageResult	withUpdatedToken(java.lang.String updatedToken) If token was updated as part of delivery.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MessageResult

public MessageResult()

Method Detail

getDeliveryStatus

public java.lang.String getDeliveryStatus()

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.

Constraints:
Allowed Values: SUCCESSFUL, THROTTLED, TEMPORARY_FAILURE, PERMANENT_FAILURE, UNKNOWN_FAILURE, OPT_OUT, DUPLICATE

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

setDeliveryStatus

public void setDeliveryStatus(java.lang.String 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.

Constraints:
Allowed Values: SUCCESSFUL, THROTTLED, TEMPORARY_FAILURE, PERMANENT_FAILURE, UNKNOWN_FAILURE, OPT_OUT, DUPLICATE

Parameters:

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.

See Also:

DeliveryStatus

withDeliveryStatus

public MessageResult withDeliveryStatus(java.lang.String 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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: SUCCESSFUL, THROTTLED, TEMPORARY_FAILURE, PERMANENT_FAILURE, UNKNOWN_FAILURE, OPT_OUT, DUPLICATE

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

DeliveryStatus

setDeliveryStatus

public void setDeliveryStatus(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.

Constraints:
Allowed Values: SUCCESSFUL, THROTTLED, TEMPORARY_FAILURE, PERMANENT_FAILURE, UNKNOWN_FAILURE, OPT_OUT, DUPLICATE

Parameters:

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.

See Also:

DeliveryStatus

withDeliveryStatus

public MessageResult withDeliveryStatus(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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: SUCCESSFUL, THROTTLED, TEMPORARY_FAILURE, PERMANENT_FAILURE, UNKNOWN_FAILURE, OPT_OUT, DUPLICATE

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

DeliveryStatus

getMessageId

public java.lang.String getMessageId()

Unique message identifier associated with the message that was sent.

Returns:

Unique message identifier associated with the message that was sent.

setMessageId

public void setMessageId(java.lang.String messageId)

Unique message identifier associated with the message that was sent.

Parameters:

messageId - Unique message identifier associated with the message that was sent.

withMessageId

public MessageResult withMessageId(java.lang.String messageId)

Unique message identifier associated with the message that was sent.

Returns a reference to this object so that method calls can be chained together.

Parameters:

messageId - Unique message identifier associated with the message that was sent.

Returns:

A reference to this updated object so that method calls can be chained together.

getStatusCode

public java.lang.Integer getStatusCode()

Downstream service status code.

Returns:

Downstream service status code.

setStatusCode

public void setStatusCode(java.lang.Integer statusCode)

Downstream service status code.

Parameters:

statusCode - Downstream service status code.

withStatusCode

public MessageResult withStatusCode(java.lang.Integer statusCode)

Downstream service status code.

Returns a reference to this object so that method calls can be chained together.

Parameters:

statusCode - Downstream service status code.

Returns:

A reference to this updated object so that method calls can be chained together.

getStatusMessage

public java.lang.String getStatusMessage()

Status message for message delivery.

Returns:

Status message for message delivery.

setStatusMessage

public void setStatusMessage(java.lang.String statusMessage)

Status message for message delivery.

Parameters:

statusMessage - Status message for message delivery.

withStatusMessage

public MessageResult withStatusMessage(java.lang.String statusMessage)

Status message for message delivery.

Returns a reference to this object so that method calls can be chained together.

Parameters:

statusMessage - Status message for message delivery.

Returns:

A reference to this updated object so that method calls can be chained together.

getUpdatedToken

public java.lang.String getUpdatedToken()

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)

setUpdatedToken

public void setUpdatedToken(java.lang.String updatedToken)

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

Parameters:

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

withUpdatedToken

public MessageResult withUpdatedToken(java.lang.String updatedToken)

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object