Class SendUsersMessageResponse

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

Provides information about which users and endpoints a message was sent to.

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.

    • requestId

      public final String requestId()

      The unique identifier that was assigned to the message request.

      Returns:
      The unique identifier that was assigned to the message request.

    • 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,Map<String,EndpointMessageResult>> result()

      An object that indicates which endpoints the message was sent to, for each user. The object lists user IDs and, for each user ID, provides the endpoint IDs that the message was sent to. For each endpoint ID, it provides an EndpointMessageResult object.

      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:
      An object that indicates which endpoints the message was sent to, for each user. The object lists user IDs and, for each user ID, provides the endpoint IDs that the message was sent to. For each endpoint ID, it provides an EndpointMessageResult object.

    • toBuilder

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

    • builder

      public static SendUsersMessageResponse.Builder builder()

    • serializableBuilderClass

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