Class Listener

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

Inheritance
object
Listener
Inherited Members
Namespace: Oci.LoadbalancerService.Models
Assembly: OCI.DotNetSDK.Loadbalancer.dll
Syntax
public class Listener

Properties

ConnectionConfiguration

Declaration
[JsonProperty(PropertyName = "connectionConfiguration")]
public ConnectionConfiguration ConnectionConfiguration { get; set; }
Property Value
Type Description
ConnectionConfiguration

DefaultBackendSetName

Declaration
[Required(ErrorMessage = "DefaultBackendSetName is required.")]
[JsonProperty(PropertyName = "defaultBackendSetName")]
public string DefaultBackendSetName { get; set; }
Property Value
Type Description
string

The name of the associated backend set.
Example: example_backend_set
Remarks

Required

HostnameNames

Declaration
[JsonProperty(PropertyName = "hostnameNames")]
public List<string> HostnameNames { get; set; }
Property Value
Type Description
List<string>

An array of hostname resource names.

Name

Declaration
[Required(ErrorMessage = "Name is required.")]
[JsonProperty(PropertyName = "name")]
public string Name { get; set; }
Property Value
Type Description
string

A friendly name for the listener. It must be unique and it cannot be changed.
Example: example_listener
Remarks

Required

PathRouteSetName

Declaration
[JsonProperty(PropertyName = "pathRouteSetName")]
public string PathRouteSetName { get; set; }
Property Value
Type Description
string

Deprecated. Please use routingPolicies instead.
The name of the set of path-based routing rules, {@link PathRouteSet}, applied to this listener's traffic.
Example: example_path_route_set

Port

Declaration
[Required(ErrorMessage = "Port is required.")]
[JsonProperty(PropertyName = "port")]
public int? Port { get; set; }
Property Value
Type Description
int?

The communication port for the listener.
Example: 80
Remarks

Required

Protocol

Declaration
[Required(ErrorMessage = "Protocol is required.")]
[JsonProperty(PropertyName = "protocol")]
public string Protocol { get; set; }
Property Value
Type Description
string

The protocol on which the listener accepts connection requests. The supported protocols are HTTP, HTTP2, TCP, and GRPC. You can also use the {@link #listProtocols(ListProtocolsRequest) listProtocols} operation to get a list of valid protocols.
Example: HTTP
Remarks

Required

RoutingPolicyName

Declaration
[JsonProperty(PropertyName = "routingPolicyName")]
public string RoutingPolicyName { get; set; }
Property Value
Type Description
string

The name of the routing policy applied to this listener's traffic.
Example: example_routing_policy_name

RuleSetNames

Declaration
[JsonProperty(PropertyName = "ruleSetNames")]
public List<string> RuleSetNames { get; set; }
Property Value
Type Description
List<string>

The names of the {@link RuleSet} to apply to the listener.
Example: ["example_rule_set"]

SslConfiguration

Declaration
[JsonProperty(PropertyName = "sslConfiguration")]
public SSLConfiguration SslConfiguration { get; set; }
Property Value
Type Description
SSLConfiguration