Package software.amazon.awssdk.services.globalaccelerator.model

Class IpSet

java.lang.Object

software.amazon.awssdk.services.globalaccelerator.model.IpSet

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<IpSet.Builder,IpSet>

@Generated("software.amazon.awssdk:codegen")
public final class IpSet
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<IpSet.Builder,IpSet>

A complex type for the set of IP addresses for an accelerator.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	IpSet.Builder

Method Summary

Modifier and Type	Method	Description
static IpSet.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasIpAddresses()	For responses, this returns true if the service returned a value for the IpAddresses property.
List<String>	ipAddresses()	The array of IP addresses in the IP address set.
IpAddressFamily	ipAddressFamily()	The types of IP addresses included in this IP set.
String	ipAddressFamilyAsString()	The types of IP addresses included in this IP set.
String	ipFamily()	Deprecated. IpFamily has been replaced by IpAddressFamily
List<SdkField<?>>	sdkFields()
static Class<? extends IpSet.Builder>	serializableBuilderClass()
IpSet.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

ipFamily

@Deprecated
public final String ipFamily()

Deprecated.

IpFamily has been replaced by IpAddressFamily

IpFamily is deprecated and has been replaced by IpAddressFamily.

Returns:

IpFamily is deprecated and has been replaced by IpAddressFamily.

hasIpAddresses

public final boolean hasIpAddresses()

For responses, this returns true if the service returned a value for the IpAddresses property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

ipAddresses

public final List<String> ipAddresses()

The array of IP addresses in the IP address set. An IP address set can have a maximum of two IP addresses.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIpAddresses() method.

Returns:

The array of IP addresses in the IP address set. An IP address set can have a maximum of two IP addresses.

ipAddressFamily

public final IpAddressFamily ipAddressFamily()

The types of IP addresses included in this IP set.

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

Returns:

The types of IP addresses included in this IP set.

See Also:

IpAddressFamily

ipAddressFamilyAsString

public final String ipAddressFamilyAsString()

The types of IP addresses included in this IP set.

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

Returns:

The types of IP addresses included in this IP set.

See Also:

IpAddressFamily

toBuilder

public IpSet.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<IpSet.Builder,IpSet>

builder

public static IpSet.Builder builder()

serializableBuilderClass

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