UpdateBackendDetails¶
-
class
oci.load_balancer.models.
UpdateBackendDetails
(**kwargs)¶ Bases:
object
The configuration details for updating a backend server.
Methods
__init__
(**kwargs)Initializes a new UpdateBackendDetails object with values from keyword arguments. Attributes
backup
[Required] Gets the backup of this UpdateBackendDetails. drain
[Required] Gets the drain of this UpdateBackendDetails. max_connections
Gets the max_connections of this UpdateBackendDetails. offline
[Required] Gets the offline of this UpdateBackendDetails. weight
[Required] Gets the weight of this UpdateBackendDetails. -
__init__
(**kwargs)¶ Initializes a new UpdateBackendDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
Parameters: - weight (int) – The value to assign to the weight property of this UpdateBackendDetails.
- max_connections (int) – The value to assign to the max_connections property of this UpdateBackendDetails.
- backup (bool) – The value to assign to the backup property of this UpdateBackendDetails.
- drain (bool) – The value to assign to the drain property of this UpdateBackendDetails.
- offline (bool) – The value to assign to the offline property of this UpdateBackendDetails.
-
backup
¶ [Required] Gets the backup of this UpdateBackendDetails. Whether the load balancer should treat this server as a backup unit. If true, the load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as “backup” fail the health check policy.
Note: You cannot add a backend server marked as backup to a backend set that uses the IP Hash policy.
Example: false
Returns: The backup of this UpdateBackendDetails. Return type: bool
-
drain
¶ [Required] Gets the drain of this UpdateBackendDetails. Whether the load balancer should drain this server. Servers marked “drain” receive no new incoming traffic.
Example: false
Returns: The drain of this UpdateBackendDetails. Return type: bool
-
max_connections
¶ Gets the max_connections of this UpdateBackendDetails. The maximum number of simultaneous connections the load balancer can make to the backend.
Example: 300
Returns: The max_connections of this UpdateBackendDetails. Return type: int
-
offline
¶ [Required] Gets the offline of this UpdateBackendDetails. Whether the load balancer should treat this server as offline. Offline servers receive no incoming traffic.
Example: false
Returns: The offline of this UpdateBackendDetails. Return type: bool
-
weight
¶ [Required] Gets the weight of this UpdateBackendDetails. The load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger proportion of incoming traffic. For example, a server weighted ‘3’ receives 3 times the number of new connections as a server weighted ‘1’. For more information on load balancing policies, see How Load Balancing Policies Work.
Example: 3
Returns: The weight of this UpdateBackendDetails. Return type: int
-