@Generated(value="OracleSDKGenerator", comments="API Version: 20170115") public final class BackendDetails extends Object
The load balancing configuration details of a backend server.
Note: Objects should always be created or deserialized using the BackendDetails.Builder
. This model distinguishes fields
that are null
because they are unset from fields that are explicitly set to null
. This is done in
the setter methods of the BackendDetails.Builder
, which maintain a set of all explicitly set fields called
__explicitlySet__
. The hashCode()
and equals(Object)
methods are implemented to take
__explicitlySet__
into account. The constructor, on the other hand, does not set __explicitlySet__
(since the constructor cannot distinguish explicit null
from unset null
).
Modifier and Type | Class and Description |
---|---|
static class |
BackendDetails.Builder |
Constructor and Description |
---|
BackendDetails(String ipAddress,
Integer port,
Integer weight,
Boolean backup,
Boolean drain,
Boolean offline)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static BackendDetails.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Set<String> |
get__explicitlySet__() |
Boolean |
getBackup()
Whether the load balancer should treat this server as a backup unit.
|
Boolean |
getDrain()
Whether the load balancer should drain this server.
|
String |
getIpAddress()
The IP address of the backend server.
|
Boolean |
getOffline()
Whether the load balancer should treat this server as offline.
|
Integer |
getPort()
The communication port for the backend server.
|
Integer |
getWeight()
The load balancing policy weight assigned to the server.
|
int |
hashCode() |
BackendDetails.Builder |
toBuilder() |
String |
toString() |
@Deprecated @ConstructorProperties(value={"ipAddress","port","weight","backup","drain","offline"}) public BackendDetails(String ipAddress, Integer port, Integer weight, Boolean backup, Boolean drain, Boolean offline)
public static BackendDetails.Builder builder()
Create a new builder.
public BackendDetails.Builder toBuilder()
public String getIpAddress()
The IP address of the backend server.
Example: 10.0.0.3
public Integer getPort()
The communication port for the backend server.
Example: 8080
public Integer getWeight()
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
public Boolean getBackup()
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
public Boolean getDrain()
Whether the load balancer should drain this server. Servers marked “drain” receive no new incoming traffic.
Example: false
public Boolean getOffline()
Whether the load balancer should treat this server as offline. Offline servers receive no incoming traffic.
Example: false
Copyright © 2016–2022. All rights reserved.