Class DedicatedIp
- java.lang.Object
-
- software.amazon.awssdk.services.sesv2.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 SES account.
To learn more about requesting dedicated IP addresses, see Requesting and Relinquishing Dedicated IP Addresses in the Amazon SES Developer Guide.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceDedicatedIp.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DedicatedIp.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()Stringip()An IPv4 address.StringpoolName()The name of the dedicated IP pool that the IP address is associated with.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends DedicatedIp.Builder>serializableBuilderClass()DedicatedIp.BuildertoBuilder()StringtoString()Returns a string representation of this object.IntegerwarmupPercentage()Indicates the progress of your dedicated IP warm-up:WarmupStatuswarmupStatus()The warm-up status of a dedicated IP address.StringwarmupStatusAsString()The warm-up status of a dedicated IP address.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
ip
public final String ip()
An IPv4 address.
- Returns:
- An IPv4 address.
-
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. -
NOT_APPLICABLE– The warm-up status doesn't apply to this IP address. This status is used for IP addresses in managed dedicated IP pools, where Amazon SES automatically handles the warm-up process.
If the service returns an enum value that is not available in the current SDK version,
warmupStatuswill returnWarmupStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromwarmupStatusAsString().- 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. -
NOT_APPLICABLE– The warm-up status doesn't apply to this IP address. This status is used for IP addresses in managed dedicated IP pools, where Amazon SES automatically handles the warm-up process.
-
- See Also:
WarmupStatus
-
-
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. -
NOT_APPLICABLE– The warm-up status doesn't apply to this IP address. This status is used for IP addresses in managed dedicated IP pools, where Amazon SES automatically handles the warm-up process.
If the service returns an enum value that is not available in the current SDK version,
warmupStatuswill returnWarmupStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromwarmupStatusAsString().- 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. -
NOT_APPLICABLE– The warm-up status doesn't apply to this IP address. This status is used for IP addresses in managed dedicated IP pools, where Amazon SES automatically handles the warm-up process.
-
- See Also:
WarmupStatus
-
-
warmupPercentage
public final Integer warmupPercentage()
Indicates the progress of your dedicated IP warm-up:
-
0-100– For standard dedicated IP addresses, this shows the warm-up completion percentage. A value of 100 means the IP address is fully warmed up and ready for use. -
-1– Appears for IP addresses in managed dedicated pools where Amazon SES automatically handles the warm-up process, making the percentage not applicable.
- Returns:
- Indicates the progress of your dedicated IP warm-up:
-
0-100– For standard dedicated IP addresses, this shows the warm-up completion percentage. A value of 100 means the IP address is fully warmed up and ready for use. -
-1– Appears for IP addresses in managed dedicated pools where Amazon SES automatically handles the warm-up process, making the percentage not applicable.
-
-
-
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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<DedicatedIp.Builder,DedicatedIp>
-
builder
public static DedicatedIp.Builder builder()
-
serializableBuilderClass
public static Class<? extends DedicatedIp.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-