Class MessageResult
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<MessageResult.Builder,
MessageResult>
Provides information about the results of sending a message directly to an endpoint address.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic MessageResult.Builder
builder()
final DeliveryStatus
The delivery status of the message.final String
The delivery status of the message.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
The unique identifier for the message that was sent.static Class
<? extends MessageResult.Builder> final Integer
The downstream service status code for delivering the message.final String
The status message for delivering the message.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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.
-
UNKNOWN_FAILURE - An unknown error occurred.
If the service returns an enum value that is not available in the current SDK version,
deliveryStatus
will returnDeliveryStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdeliveryStatusAsString()
.- 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.
-
UNKNOWN_FAILURE - An unknown error occurred.
-
- See Also:
-
-
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.
-
UNKNOWN_FAILURE - An unknown error occurred.
If the service returns an enum value that is not available in the current SDK version,
deliveryStatus
will returnDeliveryStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdeliveryStatusAsString()
.- 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.
-
UNKNOWN_FAILURE - An unknown error occurred.
-
- See Also:
-
-
messageId
The unique identifier for the message that was sent.
- Returns:
- The unique identifier for the message that was sent.
-
statusCode
The downstream service status code for delivering the message.
- Returns:
- The downstream service status code for delivering the message.
-
statusMessage
The status message for delivering the message.
- Returns:
- The status message for 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.
- 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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<MessageResult.Builder,
MessageResult> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-