Class DedicatedIp
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic DedicatedIp.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
ip()
An IPv4 address.final String
poolName()
The name of the dedicated IP pool that the IP address is associated with.static Class
<? extends DedicatedIp.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Integer
Indicates the progress of your dedicated IP warm-up:final WarmupStatus
The warm-up status of a dedicated IP address.final String
The warm-up status of a dedicated IP address.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
ip
-
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,
warmupStatus
will 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:
-
-
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,
warmupStatus
will 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:
-
-
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
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
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 interfaceToCopyableBuilder<DedicatedIp.Builder,
DedicatedIp> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-