Package software.amazon.awssdk.services.sns.model

Class ListPhoneNumbersOptedOutResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.sns.model.SnsResponse
software.amazon.awssdk.services.sns.model.ListPhoneNumbersOptedOutResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListPhoneNumbersOptedOutResponse.Builder,ListPhoneNumbersOptedOutResponse>
@Generated("software.amazon.awssdk:codegen") public final class ListPhoneNumbersOptedOutResponse extends SnsResponse implements ToCopyableBuilder<ListPhoneNumbersOptedOutResponse.Builder,ListPhoneNumbersOptedOutResponse>

The response from the ListPhoneNumbersOptedOut action.

  • Method Details

    • hasPhoneNumbers

      public final boolean hasPhoneNumbers()
      For responses, this returns true if the service returned a value for the PhoneNumbers 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.

    • phoneNumbers

      public final List<String> phoneNumbers()

      A list of phone numbers that are opted out of receiving SMS messages. The list is paginated, and each page can contain up to 100 phone numbers.

      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 hasPhoneNumbers() method.

      Returns:
      A list of phone numbers that are opted out of receiving SMS messages. The list is paginated, and each page can contain up to 100 phone numbers.

    • nextToken

      public final String nextToken()

      A NextToken string is returned when you call the ListPhoneNumbersOptedOut action if additional records are available after the first page of results.

      Returns:
      A NextToken string is returned when you call the ListPhoneNumbersOptedOut action if additional records are available after the first page of results.

    • toBuilder

      public ListPhoneNumbersOptedOutResponse.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<ListPhoneNumbersOptedOutResponse.Builder,ListPhoneNumbersOptedOutResponse>
      Specified by:
      toBuilder in class AwsResponse

    • builder

      public static ListPhoneNumbersOptedOutResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ListPhoneNumbersOptedOutResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Overrides:
      getValueForField in class SdkResponse

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo