Package com.oracle.bmc.loadbalancer.model

Class Backend.Builder

java.lang.Object

com.oracle.bmc.loadbalancer.model.Backend.Builder

Enclosing class:

Backend

public static class Backend.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Backend.Builder	backup(Boolean backup)	Whether the load balancer should treat this server as a backup unit.
Backend	build()
Backend.Builder	copy(Backend model)
Backend.Builder	drain(Boolean drain)	Whether the load balancer should drain this server.
Backend.Builder	ipAddress(String ipAddress)	The IP address of the backend server.
Backend.Builder	maxConnections(Integer maxConnections)	The maximum number of simultaneous connections the load balancer can make to the backend.
Backend.Builder	name(String name)	A read-only field showing the IP address and port that uniquely identify this backend server in the backend set.
Backend.Builder	offline(Boolean offline)	Whether the load balancer should treat this server as offline.
Backend.Builder	port(Integer port)	The communication port for the backend server.
Backend.Builder	weight(Integer weight)	The load balancing policy weight assigned to the server.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

name

public Backend.Builder name(String name)

A read-only field showing the IP address and port that uniquely identify this backend server in the backend set.

Example: 10.0.0.3:8080

Parameters:

name - the value to set

Returns:

this builder

ipAddress

public Backend.Builder ipAddress(String ipAddress)

The IP address of the backend server.

Example: 10.0.0.3

Parameters:

ipAddress - the value to set

Returns:

this builder

port

public Backend.Builder port(Integer port)

The communication port for the backend server.

Example: 8080

Parameters:

port - the value to set

Returns:

this builder

weight

public Backend.Builder weight(Integer weight)

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

Parameters:

weight - the value to set

Returns:

this builder

maxConnections

public Backend.Builder maxConnections(Integer maxConnections)

The maximum number of simultaneous connections the load balancer can make to the backend.

If this is not set or set to 0 then the maximum number of simultaneous connections the load balancer can make to the backend is unlimited.

Example: 300

Parameters:

maxConnections - the value to set

Returns:

this builder

drain

public Backend.Builder drain(Boolean drain)

Whether the load balancer should drain this server.

Servers marked “drain” receive no new incoming traffic.

Example: false

Parameters:

drain - the value to set

Returns:

this builder

backup

public Backend.Builder backup(Boolean backup)

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

Parameters:

backup - the value to set

Returns:

this builder

offline

public Backend.Builder offline(Boolean offline)

Whether the load balancer should treat this server as offline.

Offline servers receive no incoming traffic.

Example: false

Parameters:

offline - the value to set

Returns:

this builder

build

public Backend build()

copy

public Backend.Builder copy(Backend model)