Package software.amazon.awssdk.services.pinpointemail.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DedicatedIp.Builder

Method Summary

Modifier and Type	Method	Description
static DedicatedIp.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	ip()	An IP address that is reserved for use by your Amazon Pinpoint account.
String	poolName()	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.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Integer	warmupPercentage()	Indicates how complete the dedicated IP warm-up process is.
WarmupStatus	warmupStatus()	The warm-up status of a dedicated IP address.
String	warmupStatusAsString()	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 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:

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.

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:

WarmupStatus

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()

Specified by:

toBuilder in interface ToCopyableBuilder<DedicatedIp.Builder,DedicatedIp>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo