Listener¶

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

Bases: object

The congfiguration of the listener. For more information about backend set configuration, see Managing Load Balancer Listeners.

Attributes

`IP_VERSION_IPV4`	A constant which can be used with the ip_version property of a Listener.
`IP_VERSION_IPV6`	A constant which can be used with the ip_version property of a Listener.
`PROTOCOL_ANY`	A constant which can be used with the protocol property of a Listener.
`PROTOCOL_TCP`	A constant which can be used with the protocol property of a Listener.
`PROTOCOL_TCP_AND_UDP`	A constant which can be used with the protocol property of a Listener.
`PROTOCOL_UDP`	A constant which can be used with the protocol property of a Listener.
`default_backend_set_name`	[Required] Gets the default_backend_set_name of this Listener.
`ip_version`	Gets the ip_version of this Listener.
`is_ppv2_enabled`	Gets the is_ppv2_enabled of this Listener.
`name`	[Required] Gets the name of this Listener.
`port`	[Required] Gets the port of this Listener.
`protocol`	[Required] Gets the protocol of this Listener.
`tcp_idle_timeout`	Gets the tcp_idle_timeout of this Listener.
`udp_idle_timeout`	Gets the udp_idle_timeout of this Listener.

Methods

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

IP_VERSION_IPV4 = 'IPV4'¶: A constant which can be used with the ip_version property of a Listener. This constant has a value of “IPV4”

IP_VERSION_IPV6 = 'IPV6'¶: A constant which can be used with the ip_version property of a Listener. This constant has a value of “IPV6”

PROTOCOL_ANY = 'ANY'¶: A constant which can be used with the protocol property of a Listener. This constant has a value of “ANY”

PROTOCOL_TCP = 'TCP'¶: A constant which can be used with the protocol property of a Listener. This constant has a value of “TCP”

PROTOCOL_TCP_AND_UDP = 'TCP_AND_UDP'¶: A constant which can be used with the protocol property of a Listener. This constant has a value of “TCP_AND_UDP”

PROTOCOL_UDP = 'UDP'¶: A constant which can be used with the protocol property of a Listener. This constant has a value of “UDP”

__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. Allowed values for this property are: “ANY”, “TCP”, “UDP”, “TCP_AND_UDP”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
ip_version (str) – The value to assign to the ip_version property of this Listener. Allowed values for this property are: “IPV4”, “IPV6”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
is_ppv2_enabled (bool) – The value to assign to the is_ppv2_enabled property of this Listener.
tcp_idle_timeout (int) – The value to assign to the tcp_idle_timeout property of this Listener.
udp_idle_timeout (int) – The value to assign to the udp_idle_timeout property of this Listener.

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

ip_version¶

Gets the ip_version of this Listener. IP version associated with the listener.

Allowed values for this property are: “IPV4”, “IPV6”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

is_ppv2_enabled¶

Gets the is_ppv2_enabled of this Listener. Property to enable/disable PPv2 feature for this listener.

Returns:	The is_ppv2_enabled of this Listener.
Return type:	bool

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

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

Allowed values for this property are: “ANY”, “TCP”, “UDP”, “TCP_AND_UDP”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

tcp_idle_timeout¶

Gets the tcp_idle_timeout of this Listener. The duration for TCP idle timeout in seconds. Example: 300

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

udp_idle_timeout¶

Gets the udp_idle_timeout of this Listener. The duration for UDP idle timeout in seconds. Example: 120

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