ListenerDetails

class oci.network_load_balancer.models.ListenerDetails(**kwargs)

Bases: object

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

Attributes

PROTOCOL_ANY A constant which can be used with the protocol property of a ListenerDetails.
PROTOCOL_TCP A constant which can be used with the protocol property of a ListenerDetails.
PROTOCOL_UDP A constant which can be used with the protocol property of a ListenerDetails.
default_backend_set_name [Required] Gets the default_backend_set_name of this ListenerDetails.
name [Required] Gets the name of this ListenerDetails.
port [Required] Gets the port of this ListenerDetails.
protocol [Required] Gets the protocol of this ListenerDetails.

Methods

__init__(**kwargs) Initializes a new ListenerDetails object with values from keyword arguments.
PROTOCOL_ANY = 'ANY'

A constant which can be used with the protocol property of a ListenerDetails. This constant has a value of “ANY”

PROTOCOL_TCP = 'TCP'

A constant which can be used with the protocol property of a ListenerDetails. This constant has a value of “TCP”

PROTOCOL_UDP = 'UDP'

A constant which can be used with the protocol property of a ListenerDetails. This constant has a value of “UDP”

__init__(**kwargs)

Initializes a new ListenerDetails 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 ListenerDetails.
  • default_backend_set_name (str) – The value to assign to the default_backend_set_name property of this ListenerDetails.
  • port (int) – The value to assign to the port property of this ListenerDetails.
  • protocol (str) – The value to assign to the protocol property of this ListenerDetails. Allowed values for this property are: “ANY”, “TCP”, “UDP”
default_backend_set_name

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

Example: example_backend_set

Returns:The default_backend_set_name of this ListenerDetails.
Return type:str
name

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

Example: example_listener

Returns:The name of this ListenerDetails.
Return type:str
port

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

Example: 80

Returns:The port of this ListenerDetails.
Return type:int
protocol

[Required] Gets the protocol of this ListenerDetails. The protocol on which the listener accepts connection requests. For public network load balancers, ANY protocol refers to TCP/UDP. For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true). To get a list of valid protocols, use the list_network_load_balancers_protocols() operation.

Example: TCP

Allowed values for this property are: “ANY”, “TCP”, “UDP”

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