software.amazon.awssdk.services.globalaccelerator.model

Class Listener

java.lang.Object

software.amazon.awssdk.services.globalaccelerator.model.Listener

All Implemented Interfaces:

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

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

A complex type for a listener.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Listener.Builder

Method Summary

Modifier and Type	Method and Description
static Listener.Builder	builder()
ClientAffinity	clientAffinity() Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request.
String	clientAffinityAsString() Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPortRanges() Returns true if the PortRanges property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	listenerArn() The Amazon Resource Name (ARN) of the listener.
List<PortRange>	portRanges() The list of port ranges for the connections from clients to the accelerator.
Protocol	protocol() The protocol for the connections from clients to the accelerator.
String	protocolAsString() The protocol for the connections from clients to the accelerator.
List<SdkField<?>>	sdkFields()
static Class<? extends Listener.Builder>	serializableBuilderClass()
Listener.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

listenerArn

public final String listenerArn()

The Amazon Resource Name (ARN) of the listener.

Returns:

The Amazon Resource Name (ARN) of the listener.

hasPortRanges

public final boolean hasPortRanges()

Returns true if the PortRanges property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

portRanges

public final List<PortRange> portRanges()

The list of port ranges for the connections from clients to the accelerator.

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

You can use hasPortRanges() to see if a value was sent in this field.

Returns:

The list of port ranges for the connections from clients to the accelerator.

protocol

public final Protocol protocol()

The protocol for the connections from clients to the accelerator.

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

Returns:

The protocol for the connections from clients to the accelerator.

See Also:

Protocol

protocolAsString

public final String protocolAsString()

The protocol for the connections from clients to the accelerator.

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

Returns:

The protocol for the connections from clients to the accelerator.

See Also:

Protocol

clientAffinity

public final ClientAffinity clientAffinity()

Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Client affinity gives you control over whether to always route each client to the same specific endpoint.

AWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is NONE, Global Accelerator uses the "five-tuple" (5-tuple) properties—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes.

If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the "two-tuple" (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value.

The default value is NONE.

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

Returns:

Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Client affinity gives you control over whether to always route each client to the same specific endpoint.

AWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is NONE, Global Accelerator uses the "five-tuple" (5-tuple) properties—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes.

If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the "two-tuple" (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value.

The default value is NONE.

See Also:

ClientAffinity

clientAffinityAsString

public final String clientAffinityAsString()

Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Client affinity gives you control over whether to always route each client to the same specific endpoint.

AWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is NONE, Global Accelerator uses the "five-tuple" (5-tuple) properties—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes.

If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the "two-tuple" (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value.

The default value is NONE.

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

Returns:

Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Client affinity gives you control over whether to always route each client to the same specific endpoint.

AWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is NONE, Global Accelerator uses the "five-tuple" (5-tuple) properties—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes.

If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the "two-tuple" (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value.

The default value is NONE.

See Also:

ClientAffinity

toBuilder

public Listener.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Listener.Builder,Listener>

builder

public static Listener.Builder builder()

serializableBuilderClass

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