@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class EndpointMessageResult extends Object implements Serializable, Cloneable, StructuredPojo
Provides information about the delivery status and results of sending a message directly to an endpoint.
Constructor and Description |
---|
EndpointMessageResult() |
Modifier and Type | Method and Description |
---|---|
EndpointMessageResult |
clone() |
boolean |
equals(Object obj) |
String |
getAddress()
The endpoint address that the message was delivered to.
|
String |
getDeliveryStatus()
The delivery status of the message.
|
String |
getMessageId()
The unique identifier for the message that was sent.
|
Integer |
getStatusCode()
The downstream service status code for delivering the message.
|
String |
getStatusMessage()
The status message for delivering the message.
|
String |
getUpdatedToken()
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.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAddress(String address)
The endpoint address that the message was delivered to.
|
void |
setDeliveryStatus(String deliveryStatus)
The delivery status of the message.
|
void |
setMessageId(String messageId)
The unique identifier for the message that was sent.
|
void |
setStatusCode(Integer statusCode)
The downstream service status code for delivering the message.
|
void |
setStatusMessage(String statusMessage)
The status message for delivering the message.
|
void |
setUpdatedToken(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.
|
String |
toString()
Returns a string representation of this object.
|
EndpointMessageResult |
withAddress(String address)
The endpoint address that the message was delivered to.
|
EndpointMessageResult |
withDeliveryStatus(DeliveryStatus deliveryStatus)
The delivery status of the message.
|
EndpointMessageResult |
withDeliveryStatus(String deliveryStatus)
The delivery status of the message.
|
EndpointMessageResult |
withMessageId(String messageId)
The unique identifier for the message that was sent.
|
EndpointMessageResult |
withStatusCode(Integer statusCode)
The downstream service status code for delivering the message.
|
EndpointMessageResult |
withStatusMessage(String statusMessage)
The status message for delivering the message.
|
EndpointMessageResult |
withUpdatedToken(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.
|
public void setAddress(String address)
The endpoint address that the message was delivered to.
address
- The endpoint address that the message was delivered to.public String getAddress()
The endpoint address that the message was delivered to.
public EndpointMessageResult withAddress(String address)
The endpoint address that the message was delivered to.
address
- The endpoint address that the message was delivered to.public void setDeliveryStatus(String 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 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. Amazon Pinpoint won't attempt to send the message again.
SUCCESSFUL - The message was successfully delivered to the endpoint.
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.
UNKNOWN_FAILURE - An unknown error occurred.
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 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. Amazon Pinpoint won't attempt to send the message again.
SUCCESSFUL - The message was successfully delivered to the endpoint.
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.
UNKNOWN_FAILURE - An unknown error occurred.
DeliveryStatus
public String getDeliveryStatus()
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 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. Amazon Pinpoint won't attempt to send the message again.
SUCCESSFUL - The message was successfully delivered to the endpoint.
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.
UNKNOWN_FAILURE - An unknown error occurred.
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 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. Amazon Pinpoint won't attempt to send the message again.
SUCCESSFUL - The message was successfully delivered to the endpoint.
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.
UNKNOWN_FAILURE - An unknown error occurred.
DeliveryStatus
public EndpointMessageResult withDeliveryStatus(String 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 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. Amazon Pinpoint won't attempt to send the message again.
SUCCESSFUL - The message was successfully delivered to the endpoint.
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.
UNKNOWN_FAILURE - An unknown error occurred.
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 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. Amazon Pinpoint won't attempt to send the message again.
SUCCESSFUL - The message was successfully delivered to the endpoint.
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.
UNKNOWN_FAILURE - An unknown error occurred.
DeliveryStatus
public EndpointMessageResult withDeliveryStatus(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 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. Amazon Pinpoint won't attempt to send the message again.
SUCCESSFUL - The message was successfully delivered to the endpoint.
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.
UNKNOWN_FAILURE - An unknown error occurred.
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 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. Amazon Pinpoint won't attempt to send the message again.
SUCCESSFUL - The message was successfully delivered to the endpoint.
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.
UNKNOWN_FAILURE - An unknown error occurred.
DeliveryStatus
public void setMessageId(String messageId)
The unique identifier for the message that was sent.
messageId
- The unique identifier for the message that was sent.public String getMessageId()
The unique identifier for the message that was sent.
public EndpointMessageResult withMessageId(String messageId)
The unique identifier for the message that was sent.
messageId
- The unique identifier for the message that was sent.public void setStatusCode(Integer statusCode)
The downstream service status code for delivering the message.
statusCode
- The downstream service status code for delivering the message.public Integer getStatusCode()
The downstream service status code for delivering the message.
public EndpointMessageResult withStatusCode(Integer statusCode)
The downstream service status code for delivering the message.
statusCode
- The downstream service status code for delivering the message.public void setStatusMessage(String statusMessage)
The status message for delivering the message.
statusMessage
- The status message for delivering the message.public String getStatusMessage()
The status message for delivering the message.
public EndpointMessageResult withStatusMessage(String statusMessage)
The status message for delivering the message.
statusMessage
- The status message for delivering the message.public void setUpdatedToken(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.
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.public String getUpdatedToken()
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.
public EndpointMessageResult withUpdatedToken(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.
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.public String toString()
toString
in class Object
Object.toString()
public EndpointMessageResult clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.