Listener¶

class oci.load_balancer.models.Listener(**kwargs)¶

Bases: object

The listener’s configuration. For more information on backend set configuration, see Managing Load Balancer Listeners.

Methods

__init__(**kwargs) Initializes a new Listener object with values from keyword arguments.

Attributes

`connection_configuration`	Gets the connection_configuration of this Listener.
`default_backend_set_name`	[Required] Gets the default_backend_set_name of this Listener.
`hostname_names`	Gets the hostname_names of this Listener.
`name`	[Required] Gets the name of this Listener.
`path_route_set_name`	Gets the path_route_set_name of this Listener.
`port`	[Required] Gets the port of this Listener.
`protocol`	[Required] Gets the protocol of this Listener.
`routing_policy_name`	Gets the routing_policy_name of this Listener.
`rule_set_names`	Gets the rule_set_names of this Listener.
`ssl_configuration`	Gets the ssl_configuration of this Listener.

__init__(**kwargs)¶

Initializes a new Listener object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

name (str) – The value to assign to the name property of this Listener.
default_backend_set_name (str) – The value to assign to the default_backend_set_name property of this Listener.
port (int) – The value to assign to the port property of this Listener.
protocol (str) – The value to assign to the protocol property of this Listener.
hostname_names (list[str]) – The value to assign to the hostname_names property of this Listener.
path_route_set_name (str) – The value to assign to the path_route_set_name property of this Listener.
ssl_configuration (oci.load_balancer.models.SSLConfiguration) – The value to assign to the ssl_configuration property of this Listener.
connection_configuration (oci.load_balancer.models.ConnectionConfiguration) – The value to assign to the connection_configuration property of this Listener.
rule_set_names (list[str]) – The value to assign to the rule_set_names property of this Listener.
routing_policy_name (str) – The value to assign to the routing_policy_name property of this Listener.

connection_configuration¶

Gets the connection_configuration of this Listener.

Returns:	The connection_configuration of this Listener.
Return type:	oci.load_balancer.models.ConnectionConfiguration

default_backend_set_name¶

[Required] Gets the default_backend_set_name of this Listener. The name of the associated backend set.

Example: example_backend_set

Returns:	The default_backend_set_name of this Listener.
Return type:	str

hostname_names¶

Gets the hostname_names of this Listener. An array of hostname resource names.

Returns:	The hostname_names of this Listener.
Return type:	list[str]

name¶

[Required] Gets the name of this Listener. A friendly name for the listener. It must be unique and it cannot be changed.

Example: example_listener

Returns:	The name of this Listener.
Return type:	str

path_route_set_name¶

Gets the path_route_set_name of this Listener. 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 path_route_set_name of this Listener.
Return type:	str

port¶

[Required] Gets the port of this Listener. The communication port for the listener.

Example: 80

Returns:	The port of this Listener.
Return type:	int

protocol¶

[Required] Gets the protocol of this Listener. The protocol on which the listener accepts connection requests. To get a list of valid protocols, use the list_protocols() operation.

Example: HTTP

Returns:	The protocol of this Listener.
Return type:	str

routing_policy_name¶

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

Example: example_routing_policy_name

Returns:	The routing_policy_name of this Listener.
Return type:	str

rule_set_names¶

Gets the rule_set_names of this Listener. The names of the RuleSet to apply to the listener.

Example: [“example_rule_set”]

Returns:	The rule_set_names of this Listener.
Return type:	list[str]

ssl_configuration¶

Gets the ssl_configuration of this Listener.

Returns:	The ssl_configuration of this Listener.
Return type:	oci.load_balancer.models.SSLConfiguration