EndpointMessageResult (AWS Java SDK :: Services

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>
```
Provides information about the delivery status and results of sending a message directly to an endpoint.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface EndpointMessageResult.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`EndpointMessageResult.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`address()` The endpoint address that the 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)`
`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 EndpointMessageResult.Builder>`	`serializableBuilderClass()`
`Integer`	`statusCode()` The downstream service status code for delivering the message.
`String`	`statusMessage()` The status message for delivering the message.
`EndpointMessageResult.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
  - address
```
public final String address()
```
    The endpoint address that the message was delivered to.
    
    Returns:
    
    The endpoint address that the message was delivered to.
  - 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 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.
    - 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 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.
    
    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 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.
    - 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 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.
    
    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 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 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

Class EndpointMessageResult

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

address

deliveryStatus

deliveryStatusAsString

messageId

statusCode

statusMessage

updatedToken

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields