Class DedicatedIp

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

Contains information about a dedicated IP address that is associated with your Amazon Pinpoint account.

See Also:

  • Method Details

    • ip

      public final String ip()

      An IP address that is reserved for use by your Amazon Pinpoint account.

      Returns:
      An IP address that is reserved for use by your Amazon Pinpoint account.

    • warmupStatus

      public final WarmupStatus warmupStatus()

      The warm-up status of a dedicated IP address. The status can have one of the following values:

      • IN_PROGRESS – The IP address isn't ready to use because the dedicated IP warm-up process is ongoing.

      • DONE – The dedicated IP warm-up process is complete, and the IP address is ready to use.

      If the service returns an enum value that is not available in the current SDK version, warmupStatus will return WarmupStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from warmupStatusAsString().

      Returns:
      The warm-up status of a dedicated IP address. The status can have one of the following values:

      • IN_PROGRESS – The IP address isn't ready to use because the dedicated IP warm-up process is ongoing.

      • DONE – The dedicated IP warm-up process is complete, and the IP address is ready to use.

      See Also:

    • warmupStatusAsString

      public final String warmupStatusAsString()

      The warm-up status of a dedicated IP address. The status can have one of the following values:

      • IN_PROGRESS – The IP address isn't ready to use because the dedicated IP warm-up process is ongoing.

      • DONE – The dedicated IP warm-up process is complete, and the IP address is ready to use.

      If the service returns an enum value that is not available in the current SDK version, warmupStatus will return WarmupStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from warmupStatusAsString().

      Returns:
      The warm-up status of a dedicated IP address. The status can have one of the following values:

      • IN_PROGRESS – The IP address isn't ready to use because the dedicated IP warm-up process is ongoing.

      • DONE – The dedicated IP warm-up process is complete, and the IP address is ready to use.

      See Also:

    • warmupPercentage

      public final Integer warmupPercentage()

      Indicates how complete the dedicated IP warm-up process is. When this value equals 1, the address has completed the warm-up process and is ready for use.

      Returns:
      Indicates how complete the dedicated IP warm-up process is. When this value equals 1, the address has completed the warm-up process and is ready for use.

    • poolName

      public final String poolName()

      The name of the dedicated IP pool that the IP address is associated with.

      Returns:
      The name of the dedicated IP pool that the IP address is associated with.

    • toBuilder

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

    • builder

      public static DedicatedIp.Builder builder()

    • serializableBuilderClass

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