Package com.oracle.bmc.networkloadbalancer.model

Class BackendSetSummary

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.networkloadbalancer.model.BackendSetSummary

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200501")
public final class BackendSetSummary
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

The configuration of a network load balancer backend set.

For more information about backend set configuration, see Backend Sets for Network Load Balancers.

*Caution:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
Note: Objects should always be created or deserialized using the BackendSetSummary.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 BackendSetSummary.Builder, which maintain a set of all explicitly set fields called BackendSetSummary.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	Description
static class	BackendSetSummary.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	Description
BackendSetSummary(String name, NetworkLoadBalancingPolicy policy, Boolean isPreserveSource, Boolean isFailOpen, Boolean isInstantFailoverEnabled, Boolean isInstantFailoverTcpResetEnabled, Boolean areOperationallyActiveBackendsPreferred, IpVersion ipVersion, List<Backend> backends, HealthChecker healthChecker)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static BackendSetSummary.Builder	builder()	Create a new builder.
boolean	equals(Object o)
Boolean	getAreOperationallyActiveBackendsPreferred()	If enabled, NLB supports active-standby backends.
List<Backend>	getBackends()	An array of backends.
HealthChecker	getHealthChecker()
IpVersion	getIpVersion()	IP version associated with the backend set.
Boolean	getIsFailOpen()	If enabled, the network load balancer will continue to distribute traffic in the configured distribution in the event all backends are unhealthy.
Boolean	getIsInstantFailoverEnabled()	If enabled existing connections will be forwarded to an alternative healthy backend as soon as current backend becomes unhealthy.
Boolean	getIsInstantFailoverTcpResetEnabled()	If enabled along with instant failover, the network load balancer will send TCP RST to the clients for the existing connections instead of failing over to a healthy backend.
Boolean	getIsPreserveSource()	If this parameter is enabled, the network load balancer preserves the source IP of the packet forwarded to the backend servers.
String	getName()	A user-friendly name for the backend set that must be unique and cannot be changed.
NetworkLoadBalancingPolicy	getPolicy()	The network load balancer policy for the backend set.
int	hashCode()
BackendSetSummary.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

BackendSetSummary

@Deprecated
@ConstructorProperties({"name","policy","isPreserveSource","isFailOpen","isInstantFailoverEnabled","isInstantFailoverTcpResetEnabled","areOperationallyActiveBackendsPreferred","ipVersion","backends","healthChecker"})
public BackendSetSummary(String name,
                         NetworkLoadBalancingPolicy policy,
                         Boolean isPreserveSource,
                         Boolean isFailOpen,
                         Boolean isInstantFailoverEnabled,
                         Boolean isInstantFailoverTcpResetEnabled,
                         Boolean areOperationallyActiveBackendsPreferred,
                         IpVersion ipVersion,
                         List<Backend> backends,
                         HealthChecker healthChecker)

Deprecated.

Method Detail

builder

public static BackendSetSummary.Builder builder()

Create a new builder.

toBuilder

public BackendSetSummary.Builder toBuilder()

getName

public String getName()

A user-friendly name for the backend set that must be unique and cannot be changed.

Valid backend set names include only alphanumeric characters, dashes, and underscores. Backend set names cannot contain spaces. Avoid entering confidential information.

Example: example_backend_set

Returns:

the value

getPolicy

public NetworkLoadBalancingPolicy getPolicy()

The network load balancer policy for the backend set.

Example: FIVE_TUPLE

Returns:

the value

getIsPreserveSource

public Boolean getIsPreserveSource()

If this parameter is enabled, the network load balancer preserves the source IP of the packet forwarded to the backend servers.

Backend servers see the original source IP. If the isPreserveSourceDestination parameter is enabled for the network load balancer resource, this parameter cannot be disabled. The value is true by default.

Returns:

the value

getIsFailOpen

public Boolean getIsFailOpen()

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 value

getIsInstantFailoverEnabled

public Boolean getIsInstantFailoverEnabled()

If enabled existing connections will be forwarded to an alternative healthy backend as soon as current backend becomes unhealthy.

Returns:

the value

getIsInstantFailoverTcpResetEnabled

public Boolean getIsInstantFailoverTcpResetEnabled()

If enabled along with instant failover, the network load balancer will send TCP RST to the clients for the existing connections instead of failing over to a healthy backend.

This only applies when using the instant failover. By default, TCP RST is enabled.

Returns:

the value

getAreOperationallyActiveBackendsPreferred

public Boolean getAreOperationallyActiveBackendsPreferred()

If enabled, NLB supports active-standby backends.

The standby backend takes over the traffic when the active node fails, and continues to serve the traffic even when the old active node is back healthy.

Returns:

the value

getIpVersion

public IpVersion getIpVersion()

IP version associated with the backend set.

Returns:

the value

getBackends

public List<Backend> getBackends()

An array of backends.

Returns:

the value

getHealthChecker

public HealthChecker getHealthChecker()

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