Listener (AWS Java SDK :: Services :: Elastic Load Balancing V2 2.13.61 API)

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Listener.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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()` Returns true if the AlpnPolicy property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasCertificates()` Returns true if the Certificates property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasDefaultActions()` Returns true if the DefaultActions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`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 String listenerArn()
```
    The Amazon Resource Name (ARN) of the listener.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the listener.
  - loadBalancerArn
```
public String loadBalancerArn()
```
    The Amazon Resource Name (ARN) of the load balancer.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the load balancer.
  - port
```
public Integer port()
```
    The port on which the load balancer is listening.
    
    Returns:
    
    The port on which the load balancer is listening.
  - protocol
```
public 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 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 boolean hasCertificates()
```
    Returns true if the Certificates 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.
  - certificates
```
public 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.
    
    You can use hasCertificates() to see if a value was sent in this field.
    
    Returns:
    
    [HTTPS or TLS listener] The default certificate for the listener.
  - sslPolicy
```
public 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 boolean hasDefaultActions()
```
    Returns true if the DefaultActions 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.
  - defaultActions
```
public List<Action> defaultActions()
```
    The default actions for the listener.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasDefaultActions() to see if a value was sent in this field.
    
    Returns:
    
    The default actions for the listener.
  - hasAlpnPolicy
```
public boolean hasAlpnPolicy()
```
    Returns true if the AlpnPolicy 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.
  - alpnPolicy
```
public 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.
    
    You can use hasAlpnPolicy() to see if a value was sent in this field.
    
    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 int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Listener

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

listenerArn

loadBalancerArn

port

protocol

protocolAsString

hasCertificates

certificates

sslPolicy

hasDefaultActions

defaultActions

hasAlpnPolicy

alpnPolicy

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields