Class DedicatedIp
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DedicatedIp.Builder,
DedicatedIp>
Contains information about a dedicated IP address that is associated with your Amazon Pinpoint account.
- See Also:
-
Nested Class Summary
-
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 IP address that is reserved for use by your Amazon Pinpoint account.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 how complete the dedicated IP warm-up process is.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
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
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 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.
-
- 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.
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.
-
- See Also:
-
-
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
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
public final int 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
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. -
getValueForField
-
sdkFields
-