Package com.oracle.bmc.networkloadbalancer.model

Class ListenerDetails

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.networkloadbalancer.model.ListenerDetails

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200501")
public final class ListenerDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

The listener’s configuration.

For more information about listener configuration, see Listeners for Network Load Balancers.
Note: Objects should always be created or deserialized using the ListenerDetails.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the ListenerDetails.Builder, which maintain a set of all explicitly set fields called ListenerDetails.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ListenerDetails.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
ListenerDetails(String name, String defaultBackendSetName, IpVersion ipVersion, Integer port, ListenerProtocols protocol, Boolean isPpv2Enabled, Integer tcpIdleTimeout, Integer udpIdleTimeout, Integer l3IpIdleTimeout)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static ListenerDetails.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getDefaultBackendSetName()	The name of the associated backend set.
IpVersion	getIpVersion()	IP version associated with the listener.
Boolean	getIsPpv2Enabled()	Property to enable/disable PPv2 feature for this listener.
Integer	getL3IpIdleTimeout()	The duration for L3IP idle timeout in seconds.
String	getName()	A friendly name for the listener.
Integer	getPort()	The communication port for the listener.
ListenerProtocols	getProtocol()	The protocol on which the listener accepts connection requests.
Integer	getTcpIdleTimeout()	The duration for TCP idle timeout in seconds.
Integer	getUdpIdleTimeout()	The duration for UDP idle timeout in seconds.
int	hashCode()
ListenerDetails.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListenerDetails

@Deprecated
@ConstructorProperties({"name","defaultBackendSetName","ipVersion","port","protocol","isPpv2Enabled","tcpIdleTimeout","udpIdleTimeout","l3IpIdleTimeout"})
public ListenerDetails(String name,
                       String defaultBackendSetName,
                       IpVersion ipVersion,
                       Integer port,
                       ListenerProtocols protocol,
                       Boolean isPpv2Enabled,
                       Integer tcpIdleTimeout,
                       Integer udpIdleTimeout,
                       Integer l3IpIdleTimeout)

Deprecated.

Method Detail

builder

public static ListenerDetails.Builder builder()

Create a new builder.

toBuilder

public ListenerDetails.Builder toBuilder()

getName

public String getName()

A friendly name for the listener.

It must be unique and it cannot be changed.

Example: example_listener

Returns:

the value

getDefaultBackendSetName

public String getDefaultBackendSetName()

The name of the associated backend set.

Example: example_backend_set

Returns:

the value

getIpVersion

public IpVersion getIpVersion()

IP version associated with the listener.

Returns:

the value

getPort

public Integer getPort()

The communication port for the listener.

Example: 80

Returns:

the value

getProtocol

public ListenerProtocols getProtocol()

The protocol on which the listener accepts connection requests.

For public network load balancers, ANY protocol refers to TCP/UDP with the wildcard port. For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true). “ListNetworkLoadBalancersProtocols” API is deprecated and it will not return the updated values. Use the allowed values for the protocol instead.

Example: TCP

Returns:

the value

getIsPpv2Enabled

public Boolean getIsPpv2Enabled()

Property to enable/disable PPv2 feature for this listener.

Returns:

the value

getTcpIdleTimeout

public Integer getTcpIdleTimeout()

The duration for TCP idle timeout in seconds.

Example: 300

Returns:

the value

getUdpIdleTimeout

public Integer getUdpIdleTimeout()

The duration for UDP idle timeout in seconds.

Example: 120

Returns:

the value

getL3IpIdleTimeout

public Integer getL3IpIdleTimeout()

The duration for L3IP idle timeout in seconds.

Example: 200

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel