software.amazon.awssdk.services.elasticloadbalancingv2.model

Class Listener

java.lang.Object

software.amazon.awssdk.services.elasticloadbalancingv2.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>

Information about 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
List<String>	alpnPolicy() [TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) policy.
static Listener.Builder	builder()
List<Certificate>	certificates() [HTTPS or TLS listener] The default certificate for the listener.
List<Action>	defaultActions() The default actions for the listener.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAlpnPolicy() For responses, this returns true if the service returned a value for the AlpnPolicy property.
boolean	hasCertificates() For responses, this returns true if the service returned a value for the Certificates property.
boolean	hasDefaultActions() For responses, this returns true if the service returned a value for the DefaultActions property.
int	hashCode()
String	listenerArn() The Amazon Resource Name (ARN) of the listener.
String	loadBalancerArn() The Amazon Resource Name (ARN) of the load balancer.
Integer	port() The port on which the load balancer is listening.
ProtocolEnum	protocol() The protocol for connections from clients to the load balancer.
String	protocolAsString() The protocol for connections from clients to the load balancer.
List<SdkField<?>>	sdkFields()
static Class<? extends Listener.Builder>	serializableBuilderClass()
String	sslPolicy() [HTTPS or TLS listener] The security policy that defines which protocols and ciphers are supported.
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.

loadBalancerArn

public final String loadBalancerArn()

The Amazon Resource Name (ARN) of the load balancer.

Returns:

The Amazon Resource Name (ARN) of the load balancer.

port

public final Integer port()

The port on which the load balancer is listening.

Returns:

The port on which the load balancer is listening.

protocol

public final ProtocolEnum protocol()

The protocol for connections from clients to the load balancer.

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

Returns:

The protocol for connections from clients to the load balancer.

See Also:

ProtocolEnum

protocolAsString

public final String protocolAsString()

The protocol for connections from clients to the load balancer.

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

Returns:

The protocol for connections from clients to the load balancer.

See Also:

ProtocolEnum

hasCertificates

public final boolean hasCertificates()

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

certificates

public final List<Certificate> certificates()

[HTTPS or TLS listener] The default certificate for the listener.

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

Returns:

[HTTPS or TLS listener] The default certificate for the listener.

sslPolicy

public final String sslPolicy()

[HTTPS or TLS listener] The security policy that defines which protocols and ciphers are supported.

Returns:

[HTTPS or TLS listener] The security policy that defines which protocols and ciphers are supported.

hasDefaultActions

public final boolean hasDefaultActions()

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

defaultActions

public final List<Action> defaultActions()

The default actions for the listener.

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

Returns:

The default actions for the listener.

hasAlpnPolicy

public final boolean hasAlpnPolicy()

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

alpnPolicy

public final List<String> alpnPolicy()

[TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) policy.

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

Returns:

[TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) policy.

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