Package com.oracle.bmc.loadbalancer.model

Class Listener

java.lang.Object

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

com.oracle.bmc.loadbalancer.model.Listener

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

The listener’s configuration.

For more information on backend set configuration, see Managing Load Balancer Listeners.
Note: Objects should always be created or deserialized using the Listener.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 Listener.Builder, which maintain a set of all explicitly set fields called Listener.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	Listener.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
Listener(String name, String defaultBackendSetName, Integer port, String protocol, List<String> hostnameNames, String pathRouteSetName, SSLConfiguration sslConfiguration, ConnectionConfiguration connectionConfiguration, List<String> ruleSetNames, String routingPolicyName)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static Listener.Builder	builder()	Create a new builder.
boolean	equals(Object o)
ConnectionConfiguration	getConnectionConfiguration()
String	getDefaultBackendSetName()	The name of the associated backend set.
List<String>	getHostnameNames()	An array of hostname resource names.
String	getName()	A friendly name for the listener.
String	getPathRouteSetName()	Deprecated.
Integer	getPort()	The communication port for the listener.
String	getProtocol()	The protocol on which the listener accepts connection requests.
String	getRoutingPolicyName()	The name of the routing policy applied to this listener’s traffic.
List<String>	getRuleSetNames()	The names of the RuleSet to apply to the listener.
SSLConfiguration	getSslConfiguration()
int	hashCode()
Listener.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

Listener

@Deprecated
@ConstructorProperties({"name","defaultBackendSetName","port","protocol","hostnameNames","pathRouteSetName","sslConfiguration","connectionConfiguration","ruleSetNames","routingPolicyName"})
public Listener(String name,
                String defaultBackendSetName,
                Integer port,
                String protocol,
                List<String> hostnameNames,
                String pathRouteSetName,
                SSLConfiguration sslConfiguration,
                ConnectionConfiguration connectionConfiguration,
                List<String> ruleSetNames,
                String routingPolicyName)

Deprecated.

Method Detail

builder

public static Listener.Builder builder()

Create a new builder.

toBuilder

public Listener.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

getPort

public Integer getPort()

The communication port for the listener.

Example: 80

Returns:

the value

getProtocol

public String getProtocol()

The protocol on which the listener accepts connection requests.

The supported protocols are HTTP, HTTP2, TCP, and GRPC. You can also use the listProtocols operation to get a list of valid protocols.

Example: HTTP

Returns:

the value

getHostnameNames

public List<String> getHostnameNames()

An array of hostname resource names.

Returns:

the value

getPathRouteSetName

public String getPathRouteSetName()

Deprecated.

Please use routingPolicies instead.

The name of the set of path-based routing rules, PathRouteSet, applied to this listener's traffic.

Example: example_path_route_set

Returns:

the value

getSslConfiguration

public SSLConfiguration getSslConfiguration()

getConnectionConfiguration

public ConnectionConfiguration getConnectionConfiguration()

getRuleSetNames

public List<String> getRuleSetNames()

The names of the RuleSet to apply to the listener.

Example: ["example_rule_set"]

Returns:

the value

getRoutingPolicyName

public String getRoutingPolicyName()

The name of the routing policy applied to this listener’s traffic.

Example: example_routing_policy_name

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