UpdateBackendSetDetails¶

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

Bases: object

The configuration details for updating a load balancer backend set. For more information about backend set configuration, see Managing Backend Sets.

Caution: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Attributes

`IP_VERSION_IPV4`	A constant which can be used with the ip_version property of a UpdateBackendSetDetails.
`IP_VERSION_IPV6`	A constant which can be used with the ip_version property of a UpdateBackendSetDetails.
`backends`	Gets the backends of this UpdateBackendSetDetails.
`health_checker`	Gets the health_checker of this UpdateBackendSetDetails.
`ip_version`	Gets the ip_version of this UpdateBackendSetDetails.
`is_fail_open`	Gets the is_fail_open of this UpdateBackendSetDetails.
`is_instant_failover_enabled`	Gets the is_instant_failover_enabled of this UpdateBackendSetDetails.
`is_preserve_source`	Gets the is_preserve_source of this UpdateBackendSetDetails.
`policy`	Gets the policy of this UpdateBackendSetDetails.

Methods

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

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

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

__init__(**kwargs)¶

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

Parameters:

policy (str) – The value to assign to the policy property of this UpdateBackendSetDetails.
is_preserve_source (bool) – The value to assign to the is_preserve_source property of this UpdateBackendSetDetails.
is_fail_open (bool) – The value to assign to the is_fail_open property of this UpdateBackendSetDetails.
is_instant_failover_enabled (bool) – The value to assign to the is_instant_failover_enabled property of this UpdateBackendSetDetails.
ip_version (str) – The value to assign to the ip_version property of this UpdateBackendSetDetails. Allowed values for this property are: “IPV4”, “IPV6”
backends (list[oci.network_load_balancer.models.BackendDetails]) – The value to assign to the backends property of this UpdateBackendSetDetails.
health_checker (oci.network_load_balancer.models.HealthCheckerDetails) – The value to assign to the health_checker property of this UpdateBackendSetDetails.

backends¶

Gets the backends of this UpdateBackendSetDetails. An array of backends associated with the backend set.

Returns:	The backends of this UpdateBackendSetDetails.
Return type:	list[oci.network_load_balancer.models.BackendDetails]

health_checker¶

Gets the health_checker of this UpdateBackendSetDetails.

Returns:	The health_checker of this UpdateBackendSetDetails.
Return type:	oci.network_load_balancer.models.HealthCheckerDetails

ip_version¶

Gets the ip_version of this UpdateBackendSetDetails. The IP version associated with the backend set.

Allowed values for this property are: “IPV4”, “IPV6”

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

is_fail_open¶

Gets the is_fail_open of this UpdateBackendSetDetails. If enabled, the network load balancer will continue to distribute traffic in the configured distribution in the event all backends are unhealthy. The value is false by default.

Returns:	The is_fail_open of this UpdateBackendSetDetails.
Return type:	bool

is_instant_failover_enabled¶

Gets the is_instant_failover_enabled of this UpdateBackendSetDetails. If enabled existing connections will be forwarded to an alternative healthy backend as soon as current backend becomes unhealthy.

Returns:	The is_instant_failover_enabled of this UpdateBackendSetDetails.
Return type:	bool

is_preserve_source¶

Gets the is_preserve_source of this UpdateBackendSetDetails. If this parameter is enabled, then the network load balancer preserves the source IP of the packet when it is forwarded to backends. Backends see the original source IP. If the isPreserveSourceDestination parameter is enabled for the network load balancer resource, then this parameter cannot be disabled. The value is true by default.

Returns:	The is_preserve_source of this UpdateBackendSetDetails.
Return type:	bool

policy¶

Gets the policy of this UpdateBackendSetDetails. The network load balancer policy for the backend set. To get a list of available policies, use the list_network_load_balancers_policies() operation.

Example: FIVE_TUPLE

Returns:	The policy of this UpdateBackendSetDetails.
Return type:	str