Class MessageResponse

java.lang.Object
software.amazon.awssdk.services.pinpoint.model.MessageResponse
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<MessageResponse.Builder,MessageResponse>
@Generated("software.amazon.awssdk:codegen") public final class MessageResponse extends Object implements SdkPojo, Serializable, ToCopyableBuilder<MessageResponse.Builder,MessageResponse>

Provides information about the results of a request to send a message to an endpoint address.

See Also:

  • Method Details

    • applicationId

      public final String applicationId()

      The unique identifier for the application that was used to send the message.

      Returns:
      The unique identifier for the application that was used to send the message.

    • hasEndpointResult

      public final boolean hasEndpointResult()
      For responses, this returns true if the service returned a value for the EndpointResult property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • endpointResult

      public final Map<String,EndpointMessageResult> endpointResult()

      A map that contains a multipart response for each address that the message was sent to. In the map, the endpoint ID is the key and the result is the value.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEndpointResult() method.

      Returns:
      A map that contains a multipart response for each address that the message was sent to. In the map, the endpoint ID is the key and the result is the value.

    • requestId

      public final String requestId()

      The identifier for the original request that the message was delivered for.

      Returns:
      The identifier for the original request that the message was delivered for.

    • hasResult

      public final boolean hasResult()
      For responses, this returns true if the service returned a value for the Result property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • result

      public final Map<String,MessageResult> result()

      A map that contains a multipart response for each address (email address, phone number, or push notification token) that the message was sent to. In the map, the address is the key and the result is the value.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasResult() method.

      Returns:
      A map that contains a multipart response for each address (email address, phone number, or push notification token) that the message was sent to. In the map, the address is the key and the result is the value.

    • toBuilder

      public MessageResponse.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<MessageResponse.Builder,MessageResponse>
      Returns:
      a builder for type T

    • builder

      public static MessageResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends MessageResponse.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.