BackendSummary (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- - com.oracle.bmc.networkloadbalancer.model.BackendSummary

```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200501")
public final class BackendSummary
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 BackendSummary.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 BackendSummary.Builder, which maintain a set of all explicitly set fields called BackendSummary.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class BackendSummary.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`BackendSummary.Builder`

Field Summary
- Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
  EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors
Constructor and Description
`BackendSummary(String name, String ipAddress, String targetId, Integer port, Integer weight, Boolean isDrain, Boolean isBackup, Boolean isOffline)` Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static BackendSummary.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()`
`BackendSummary.Builder`	`toBuilder()`
`String`	`toString()`
`String`	`toString(boolean includeByteArrayContents)` Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BackendSummary

@Deprecated
 @ConstructorProperties(value={"name","ipAddress","targetId","port","weight","isDrain","isBackup","isOffline"})
public BackendSummary(String name,
                                                                                                                                                  String ipAddress,
                                                                                                                                                  String targetId,
                                                                                                                                                  Integer port,
                                                                                                                                                  Integer weight,
                                                                                                                                                  Boolean isDrain,
                                                                                                                                                  Boolean isBackup,
                                                                                                                                                  Boolean isOffline)

Deprecated.

Method Detail
- builder
```
public static BackendSummary.Builder builder()
```
  Create a new builder.
- toBuilder
```
public BackendSummary.Builder toBuilder()
```
- getName
```
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
  
  Returns:
  
  the value
- getIpAddress
```
public String getIpAddress()
```
  The IP address of the backend server. Example: 10.0.0.3
  
  Returns:
  
  the value
- getTargetId
```
public String getTargetId()
```
  The IP OCID/Instance OCID associated with the backend server. Example: ocid1.privateip..oc1.<var><unique_ID></var>
  
  Returns:
  
  the value
- getPort
```
public Integer getPort()
```
  The communication port for the backend server.
  
  Example: 8080
  
  Returns:
  
  the value
- getWeight
```
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
  
  Returns:
  
  the value
- getIsDrain
```
public Boolean getIsDrain()
```
  Whether the network load balancer should drain this server. Servers marked “isDrain” receive no incoming traffic.
  
  Example: false
  
  Returns:
  
  the value
- getIsBackup
```
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
  
  Returns:
  
  the value
- getIsOffline
```
public Boolean getIsOffline()
```
  Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic.
  
  Example: false
  
  Returns:
  
  the value
- toString
```
public String toString()
```
  Overrides:
  
  toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- toString
```
public String toString(boolean includeByteArrayContents)
```
  Return a string representation of the object.
  
  Parameters:
  
  includeByteArrayContents - true to include the full contents of byte arrays
  
  Returns:
  
  string representation
- equals
```
public boolean equals(Object o)
```
  Overrides:
  
  equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Class BackendSummary

Nested Class Summary

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Constructor Summary

Method Summary

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Methods inherited from class java.lang.Object

Constructor Detail

BackendSummary

Method Detail

builder

toBuilder

getName

getIpAddress

getTargetId

getPort

getWeight

getIsDrain

getIsBackup

getIsOffline

toString

toString

equals

hashCode