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

Class CreateLoadBalancerOptions

java.lang.Object

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

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

All Implemented Interfaces:

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

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

The createLoadBalancer options.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CreateLoadBalancerOptions.Builder	Builder.

Method Summary

Modifier and Type	Method	Description
LoadBalancerDNSPrototype	dns()	Gets the dns.
Boolean	isPublic()	Gets the isPublic.
List<LoadBalancerListenerPrototypeLoadBalancerContext>	listeners()	Gets the listeners.
LoadBalancerLoggingPrototype	logging()	Gets the logging.
String	name()	Gets the name.
CreateLoadBalancerOptions.Builder	newBuilder()	New builder.
List<LoadBalancerPoolPrototype>	pools()	Gets the pools.
LoadBalancerProfileIdentity	profile()	Gets the profile.
ResourceGroupIdentity	resourceGroup()	Gets the resourceGroup.
Boolean	routeMode()	Gets the routeMode.
List<SecurityGroupIdentity>	securityGroups()	Gets the securityGroups.
List<SubnetIdentity>	subnets()	Gets the subnets.

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 CreateLoadBalancerOptions.Builder newBuilder()

New builder.

Returns:

a CreateLoadBalancerOptions builder

isPublic

public Boolean isPublic()

Gets the isPublic. Indicates whether this load balancer is public. At present, if route mode is enabled, the load balancer must not be public.

Returns:

the isPublic

subnets

public List<SubnetIdentity> subnets()

Gets the subnets. The subnets to provision this load balancer in. The subnets must be in the same VPC. The load balancer's availability will depend on the availability of the zones that the subnets reside in. Load balancers in the `network` family allow only one subnet to be specified.

Returns:

the subnets

dns

public LoadBalancerDNSPrototype dns()

Gets the dns. The DNS configuration for this load balancer. If unspecified, DNS `A` records for this load balancer's `hostname` property will be added to the public DNS zone `lb.appdomain.cloud`. Otherwise, those DNS `A` records will be added to the specified `zone`.

Returns:

the dns

listeners

public List<LoadBalancerListenerPrototypeLoadBalancerContext> listeners()

Gets the listeners. The listeners of this load balancer.

Returns:

the listeners

logging

public LoadBalancerLoggingPrototype logging()

Gets the logging. The logging configuration to use for this load balancer. See [VPC Datapath Logging](https://cloud.ibm.com/docs/vpc?topic=vpc-datapath-logging) on the logging format, fields and permitted values. If unspecified, `datapath.active` will be `false`. To activate logging, the load balancer profile must support the specified logging type.

Returns:

the logging

name

public String name()

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

Returns:

the name

pools

public List<LoadBalancerPoolPrototype> pools()

Gets the pools. The pools of this load balancer.

Returns:

the pools

profile

public LoadBalancerProfileIdentity profile()

Gets the profile. The profile to use for this load balancer. If unspecified, `application` will be used.

Returns:

the profile

resourceGroup

public ResourceGroupIdentity resourceGroup()

Gets the resourceGroup. The resource group to use. If unspecified, the account's [default resource group](https://cloud.ibm.com/apidocs/resource-manager#introduction) will be used.

Returns:

the resourceGroup

routeMode

public Boolean routeMode()

Gets the routeMode. Indicates whether route mode is enabled for this load balancer. At present, public load balancers are not supported with route mode enabled.

Returns:

the routeMode

securityGroups

public List<SecurityGroupIdentity> securityGroups()

Gets the securityGroups. The security groups to use for this load balancer. If unspecified, the VPC's default security group is used. The load balancer profile must support security groups.

Returns:

the securityGroups