Package com.ibm.cloud.is.vpc.v1.model

Class CreateLoadBalancerPoolOptions

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.cloud.is.vpc.v1.model.CreateLoadBalancerPoolOptions

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class CreateLoadBalancerPoolOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel

The createLoadBalancerPool options.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateLoadBalancerPoolOptions.Algorithm	The load balancing algorithm.
static class	CreateLoadBalancerPoolOptions.Builder	Builder.
static interface	CreateLoadBalancerPoolOptions.Protocol	The protocol used for this load balancer pool.
static interface	CreateLoadBalancerPoolOptions.ProxyProtocol	The PROXY protocol setting for this pool: - `v1`: Enabled with version 1 (human-readable header format) - `v2`: Enabled with version 2 (binary header format) - `disabled`: Disabled For load balancers in the `network` family, this property must be `disabled`.

Method Summary

Modifier and Type	Method	Description
String	algorithm()	Gets the algorithm.
LoadBalancerPoolHealthMonitorPrototype	healthMonitor()	Gets the healthMonitor.
String	loadBalancerId()	Gets the loadBalancerId.
List<LoadBalancerPoolMemberPrototype>	members()	Gets the members.
String	name()	Gets the name.
CreateLoadBalancerPoolOptions.Builder	newBuilder()	New builder.
String	protocol()	Gets the protocol.
String	proxyProtocol()	Gets the proxyProtocol.
LoadBalancerPoolSessionPersistencePrototype	sessionPersistence()	Gets the sessionPersistence.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

newBuilder

public CreateLoadBalancerPoolOptions.Builder newBuilder()

New builder.

Returns:

a CreateLoadBalancerPoolOptions builder

loadBalancerId

public String loadBalancerId()

Gets the loadBalancerId. The load balancer identifier.

Returns:

the loadBalancerId

algorithm

public String algorithm()

Gets the algorithm. The load balancing algorithm. The `least_connections` algorithm is only supported for load balancers that have `availability` with value `subnet` in the profile.

Returns:

the algorithm

healthMonitor

public LoadBalancerPoolHealthMonitorPrototype healthMonitor()

Gets the healthMonitor. The health monitor of this pool.

Returns:

the healthMonitor

protocol

public String protocol()

Gets the protocol. The protocol used for this load balancer pool. Load balancers in the `network` family support `tcp` and `udp` (if `udp_supported` is `true`). Load balancers in the `application` family support `tcp`, `http`, and `https`.

Returns:

the protocol

members

public List<LoadBalancerPoolMemberPrototype> members()

Gets the members. The members for this load balancer pool. For load balancers in the `network` family, the same `port` and `target` tuple cannot be shared by a pool member of any other load balancer in the same VPC.

Returns:

the members

name

public String name()

Gets the name. The name for this load balancer pool. The name must not be used by another pool for the load balancer. If unspecified, the name will be a hyphenated list of randomly-selected words.

Returns:

the name

proxyProtocol

public String proxyProtocol()

Gets the proxyProtocol. The PROXY protocol setting for this pool: - `v1`: Enabled with version 1 (human-readable header format) - `v2`: Enabled with version 2 (binary header format) - `disabled`: Disabled For load balancers in the `network` family, this property must be `disabled`.

Returns:

the proxyProtocol

sessionPersistence

public LoadBalancerPoolSessionPersistencePrototype sessionPersistence()

Gets the sessionPersistence. The session persistence of this pool. If specified, the load balancer must have `source_ip_session_persistence_supported` set to `true` in its profile. If unspecified, session persistence will be disabled, and traffic will be distributed across backend server members of the pool.

Returns:

the sessionPersistence