@Generated(value="OracleSDKGenerator", comments="API Version: 20200501") public final class Backend extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
The configuration of a backend server that is a member of a network load balancer backend set.
For more information, see Managing Backend
Servers.
Note: Objects should always be created or deserialized using the Backend.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 Backend.Builder
, which maintain a
set of all explicitly set fields called ExplicitlySetBmcModel.__explicitlySet__
. The hashCode()
and
equals(Object)
methods are implemented to take ExplicitlySetBmcModel.__explicitlySet__
into account.
The constructor, on the other hand, does not set ExplicitlySetBmcModel.__explicitlySet__
(since the
constructor cannot distinguish explicit null
from unset null
).
Modifier and Type | Class and Description |
---|---|
static class |
Backend.Builder |
Constructor and Description |
---|
Backend(String name,
String ipAddress,
String targetId,
Integer port,
Integer weight,
Boolean isDrain,
Boolean isBackup,
Boolean isOffline)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static Backend.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
String |
getIpAddress()
The IP address of the backend server.
|
Boolean |
getIsBackup()
Whether the network load balancer should treat this server as a backup unit.
|
Boolean |
getIsDrain()
Whether the network load balancer should drain this server.
|
Boolean |
getIsOffline()
Whether the network load balancer should treat this server as offline.
|
String |
getName()
A read-only field showing the IP address/IP OCID and port that uniquely identify this backend
server in the backend set.
|
Integer |
getPort()
The communication port for the backend server.
|
String |
getTargetId()
The IP OCID/Instance OCID associated with the backend server.
|
Integer |
getWeight()
The network load balancing policy weight assigned to the server.
|
int |
hashCode() |
Backend.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet
public static Backend.Builder builder()
Create a new builder.
public Backend.Builder toBuilder()
public String getName()
A read-only field showing the IP address/IP OCID and port that uniquely identify this backend server in the backend set.
Example: 10.0.0.3:8080
, or ocid1.privateip..oc1.<var><unique_ID></var>:443
or 10.0.0.3:0
public String getIpAddress()
The IP address of the backend server. Example: 10.0.0.3
public String getTargetId()
The IP OCID/Instance OCID associated with the backend server. Example: ocid1.privateip..oc1.<var><unique_ID></var>
public Integer getPort()
The communication port for the backend server.
Example: 8080
public Integer getWeight()
The network 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 three times the number of new connections as a server weighted ‘1’. For more information about load balancing policies, see How Network Load Balancing Policies Work.
Example: 3
public Boolean getIsDrain()
Whether the network load balancer should drain this server. Servers marked “isDrain” receive no incoming traffic.
Example: false
public Boolean getIsBackup()
Whether the network load balancer should treat this server as a backup unit. If true
,
then the network load balancer forwards no ingress traffic to this backend server unless all
other backend servers not marked as “isBackup” fail the health check policy.
Example: false
public Boolean getIsOffline()
Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic.
Example: false
public String toString()
toString
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
public String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents
- true to include the full contents of byte arrayspublic boolean equals(Object o)
equals
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
public int hashCode()
hashCode
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Copyright © 2016–2023. All rights reserved.