Class EndpointMessageResult

java.lang.Object
software.amazon.awssdk.services.pinpoint.model.EndpointMessageResult
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<EndpointMessageResult.Builder,EndpointMessageResult>
@Generated("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:

  • Method Details

    • 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.

      • 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.

      • UNKNOWN_FAILURE - An unknown error occurred.

      See Also:

    • 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.

      • 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.

      • UNKNOWN_FAILURE - An unknown error occurred.

      See Also:

    • 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()
      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 interface ToCopyableBuilder<EndpointMessageResult.Builder,EndpointMessageResult>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.