Class PutOptedOutNumberResponse

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

  • Method Details

    • optOutListArn

      public final String optOutListArn()

      The OptOutListArn that the phone number was removed from.

      Returns:
      The OptOutListArn that the phone number was removed from.

    • optOutListName

      public final String optOutListName()

      The OptOutListName that the phone number was removed from.

      Returns:
      The OptOutListName that the phone number was removed from.

    • optedOutNumber

      public final String optedOutNumber()

      The phone number that was added to the OptOutList.

      Returns:
      The phone number that was added to the OptOutList.

    • optedOutTimestamp

      public final Instant optedOutTimestamp()

      The time that the phone number was added to the OptOutList, in UNIX epoch time format.

      Returns:
      The time that the phone number was added to the OptOutList, in UNIX epoch time format.

    • endUserOptedOut

      public final Boolean endUserOptedOut()

      This is true if it was the end user who requested their phone number be removed.

      Returns:
      This is true if it was the end user who requested their phone number be removed.

    • toBuilder

      public PutOptedOutNumberResponse.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<PutOptedOutNumberResponse.Builder,PutOptedOutNumberResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static PutOptedOutNumberResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PutOptedOutNumberResponse.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)
      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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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