software.amazon.awssdk.services.globalaccelerator.model

Class DestinationPortMapping

java.lang.Object

software.amazon.awssdk.services.globalaccelerator.model.DestinationPortMapping

All Implemented Interfaces:

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

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

The port mappings for a specified endpoint IP address (destination).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DestinationPortMapping.Builder

Method Summary

Modifier and Type	Method and Description
String	acceleratorArn() The Amazon Resource Name (ARN) of the custom routing accelerator that you have port mappings for.
List<SocketAddress>	acceleratorSocketAddresses() The IP address/port combinations (sockets) that map to a given destination socket address.
static DestinationPortMapping.Builder	builder()
SocketAddress	destinationSocketAddress() The endpoint IP address/port combination for traffic received on the accelerator socket address.
CustomRoutingDestinationTrafficState	destinationTrafficState() Indicates whether or not a port mapping destination can receive traffic.
String	destinationTrafficStateAsString() Indicates whether or not a port mapping destination can receive traffic.
String	endpointGroupArn() The Amazon Resource Name (ARN) of the endpoint group.
String	endpointGroupRegion() The Amazon Web Services Region for the endpoint group.
String	endpointId() The ID for the virtual private cloud (VPC) subnet.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAcceleratorSocketAddresses() For responses, this returns true if the service returned a value for the AcceleratorSocketAddresses property.
int	hashCode()
IpAddressType	ipAddressType() The IP address type that an accelerator supports.
String	ipAddressTypeAsString() The IP address type that an accelerator supports.
List<SdkField<?>>	sdkFields()
static Class<? extends DestinationPortMapping.Builder>	serializableBuilderClass()
DestinationPortMapping.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

acceleratorArn

public final String acceleratorArn()

The Amazon Resource Name (ARN) of the custom routing accelerator that you have port mappings for.

Returns:

The Amazon Resource Name (ARN) of the custom routing accelerator that you have port mappings for.

hasAcceleratorSocketAddresses

public final boolean hasAcceleratorSocketAddresses()

For responses, this returns true if the service returned a value for the AcceleratorSocketAddresses 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.

acceleratorSocketAddresses

public final List<SocketAddress> acceleratorSocketAddresses()

The IP address/port combinations (sockets) that map to a given destination socket address.

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 hasAcceleratorSocketAddresses() method.

Returns:

The IP address/port combinations (sockets) that map to a given destination socket address.

endpointGroupArn

public final String endpointGroupArn()

The Amazon Resource Name (ARN) of the endpoint group.

Returns:

The Amazon Resource Name (ARN) of the endpoint group.

endpointId

public final String endpointId()

The ID for the virtual private cloud (VPC) subnet.

Returns:

The ID for the virtual private cloud (VPC) subnet.

endpointGroupRegion

public final String endpointGroupRegion()

The Amazon Web Services Region for the endpoint group.

Returns:

The Amazon Web Services Region for the endpoint group.

destinationSocketAddress

public final SocketAddress destinationSocketAddress()

The endpoint IP address/port combination for traffic received on the accelerator socket address.

Returns:

The endpoint IP address/port combination for traffic received on the accelerator socket address.

ipAddressType

public final IpAddressType ipAddressType()

The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.

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

Returns:

The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.

See Also:

IpAddressType

ipAddressTypeAsString

public final String ipAddressTypeAsString()

The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.

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

Returns:

The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.

See Also:

IpAddressType

destinationTrafficState

public final CustomRoutingDestinationTrafficState destinationTrafficState()

Indicates whether or not a port mapping destination can receive traffic. The value is either ALLOW, if traffic is allowed to the destination, or DENY, if traffic is not allowed to the destination.

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

Returns:

Indicates whether or not a port mapping destination can receive traffic. The value is either ALLOW, if traffic is allowed to the destination, or DENY, if traffic is not allowed to the destination.

See Also:

CustomRoutingDestinationTrafficState

destinationTrafficStateAsString

public final String destinationTrafficStateAsString()

Indicates whether or not a port mapping destination can receive traffic. The value is either ALLOW, if traffic is allowed to the destination, or DENY, if traffic is not allowed to the destination.

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

Returns:

Indicates whether or not a port mapping destination can receive traffic. The value is either ALLOW, if traffic is allowed to the destination, or DENY, if traffic is not allowed to the destination.

See Also:

CustomRoutingDestinationTrafficState

toBuilder

public DestinationPortMapping.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DestinationPortMapping.Builder,DestinationPortMapping>

builder

public static DestinationPortMapping.Builder builder()

serializableBuilderClass

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