com.oracle.bmc.loadbalancer.model

Class CreateLoadBalancerDetails.Builder

java.lang.Object

com.oracle.bmc.loadbalancer.model.CreateLoadBalancerDetails.Builder

Enclosing class:

CreateLoadBalancerDetails

public static class CreateLoadBalancerDetails.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CreateLoadBalancerDetails.Builder	backendSets(Map<String,BackendSetDetails> backendSets)
CreateLoadBalancerDetails	build()
CreateLoadBalancerDetails.Builder	certificates(Map<String,CertificateDetails> certificates)
CreateLoadBalancerDetails.Builder	compartmentId(String compartmentId) The OCID of the compartment in which to create the load balancer.
CreateLoadBalancerDetails.Builder	copy(CreateLoadBalancerDetails model)
CreateLoadBalancerDetails.Builder	definedTags(Map<String,Map<String,Object>> definedTags) Defined tags for this resource.
CreateLoadBalancerDetails.Builder	displayName(String displayName) A user-friendly name.
CreateLoadBalancerDetails.Builder	freeformTags(Map<String,String> freeformTags) Free-form tags for this resource.
CreateLoadBalancerDetails.Builder	hostnames(Map<String,HostnameDetails> hostnames)
CreateLoadBalancerDetails.Builder	ipMode(CreateLoadBalancerDetails.IpMode ipMode) Whether the load balancer has an IPv4 or IPv6 IP address.
CreateLoadBalancerDetails.Builder	isDeleteProtectionEnabled(Boolean isDeleteProtectionEnabled) Whether or not the load balancer has delete protection enabled.
CreateLoadBalancerDetails.Builder	isPrivate(Boolean isPrivate) Whether the load balancer has a VCN-local (private) IP address.
CreateLoadBalancerDetails.Builder	isRequestIdEnabled(Boolean isRequestIdEnabled) Whether or not the load balancer has the Request Id feature enabled for HTTP listeners.
CreateLoadBalancerDetails.Builder	listeners(Map<String,ListenerDetails> listeners)
CreateLoadBalancerDetails.Builder	networkSecurityGroupIds(List<String> networkSecurityGroupIds) An array of NSG OCIDs associated with this load balancer.
CreateLoadBalancerDetails.Builder	pathRouteSets(Map<String,PathRouteSetDetails> pathRouteSets)
CreateLoadBalancerDetails.Builder	requestIdHeader(String requestIdHeader) If isRequestIdEnabled is true then this field contains the name of the header field that contains the unique request id that is attached to every request from the load balancer to the load balancer backends and to every response from the load balancer.
CreateLoadBalancerDetails.Builder	reservedIps(List<ReservedIP> reservedIps) An array of reserved Ips.
CreateLoadBalancerDetails.Builder	ruleSets(Map<String,RuleSetDetails> ruleSets)
CreateLoadBalancerDetails.Builder	shapeDetails(ShapeDetails shapeDetails) The configuration details to create load balancer using Flexible shape.
CreateLoadBalancerDetails.Builder	shapeName(String shapeName) A template that determines the total pre-provisioned bandwidth (ingress plus egress).
CreateLoadBalancerDetails.Builder	sslCipherSuites(Map<String,SSLCipherSuiteDetails> sslCipherSuites)
CreateLoadBalancerDetails.Builder	subnetIds(List<String> subnetIds) An array of subnet OCIDs.
CreateLoadBalancerDetails.Builder	zprTags(Map<String,Map<String,Object>> zprTags) Extended Defined tags for ZPR for this resource.

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

compartmentId

public CreateLoadBalancerDetails.Builder compartmentId(String compartmentId)

The OCID of the compartment in which to create the load balancer.

Parameters:

compartmentId - the value to set

Returns:

this builder

displayName

public CreateLoadBalancerDetails.Builder displayName(String displayName)

A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.

Example: example_load_balancer

Parameters:

displayName - the value to set

Returns:

this builder

shapeName

public CreateLoadBalancerDetails.Builder shapeName(String shapeName)

A template that determines the total pre-provisioned bandwidth (ingress plus egress). To get a list of available shapes, use the listShapes operation.

Example: flexible NOTE: After May 2023, Fixed shapes - 10Mbps, 100Mbps, 400Mbps, 8000Mbps would be deprecated and only shape allowed would be Flexible

Parameters:

shapeName - the value to set

Returns:

this builder

shapeDetails

public CreateLoadBalancerDetails.Builder shapeDetails(ShapeDetails shapeDetails)

The configuration details to create load balancer using Flexible shape. This is required only if shapeName is Flexible.

Parameters:

shapeDetails - the value to set

Returns:

this builder

isPrivate

public CreateLoadBalancerDetails.Builder isPrivate(Boolean isPrivate)

Whether the load balancer has a VCN-local (private) IP address.

If "true", the service assigns a private IP address to the load balancer.

If "false", the service assigns a public IP address to the load balancer.

A public load balancer is accessible from the internet, depending on your VCN's [security list rules](https://docs.cloud.oracle.com/Content/Network/Concepts/securitylists.htm). For more information about public and private load balancers, see [How Load Balancing Works](https://docs.cloud.oracle.com/Content/Balance/Concepts/balanceoverview.htm#how-load-balancing-works).

Example: true

Parameters:

isPrivate - the value to set

Returns:

this builder

isDeleteProtectionEnabled

public CreateLoadBalancerDetails.Builder isDeleteProtectionEnabled(Boolean isDeleteProtectionEnabled)

Whether or not the load balancer has delete protection enabled.

If "true", the loadbalancer will be protected against deletion if configured to accept traffic.

If "false", the loadbalancer will not be protected against deletion.

Delete protection will not be enabled unless a value of "true" is provided. Example: true

Parameters:

isDeleteProtectionEnabled - the value to set

Returns:

this builder

ipMode

public CreateLoadBalancerDetails.Builder ipMode(CreateLoadBalancerDetails.IpMode ipMode)

Whether the load balancer has an IPv4 or IPv6 IP address.

If "IPV4", the service assigns an IPv4 address and the load balancer supports IPv4 traffic.

If "IPV6", the service assigns an IPv6 address and the load balancer supports IPv6 traffic.

Example: "ipMode":"IPV6"

Parameters:

ipMode - the value to set

Returns:

this builder

isRequestIdEnabled

public CreateLoadBalancerDetails.Builder isRequestIdEnabled(Boolean isRequestIdEnabled)

Whether or not the load balancer has the Request Id feature enabled for HTTP listeners.

If "true", the load balancer will attach a unique request id header to every request passed through from the load balancer to load balancer backends. This same request id header also will be added to the response the lb received from the backend handling the request before the load balancer returns the response to the requestor. The name of the unique request id header is set the by value of requestIdHeader.

If "false", the loadbalancer not add this unique request id header to either the request passed through to the load balancer backends nor to the reponse returned to the user.

New load balancers have the Request Id feature disabled unless isRequestIdEnabled is set to true.

Example: true

Parameters:

isRequestIdEnabled - the value to set

Returns:

this builder

requestIdHeader

public CreateLoadBalancerDetails.Builder requestIdHeader(String requestIdHeader)

If isRequestIdEnabled is true then this field contains the name of the header field that contains the unique request id that is attached to every request from the load balancer to the load balancer backends and to every response from the load balancer.

If a request to the load balancer already contains a header with same name as specified in requestIdHeader then the load balancer will not change the value of that field.

If isRequestIdEnabled is false then this field is ignored.

If this field is not set or is set to "" then this field defaults to X-Request-Id

*Notes:** * Unless the header name is "" it must start with "X-" prefix. * Setting the header name to "" will set it to the default: X-Request-Id.

Parameters:

requestIdHeader - the value to set

Returns:

this builder

reservedIps

public CreateLoadBalancerDetails.Builder reservedIps(List<ReservedIP> reservedIps)

An array of reserved Ips.

Parameters:

reservedIps - the value to set

Returns:

this builder

listeners

public CreateLoadBalancerDetails.Builder listeners(Map<String,ListenerDetails> listeners)

hostnames

public CreateLoadBalancerDetails.Builder hostnames(Map<String,HostnameDetails> hostnames)

backendSets

public CreateLoadBalancerDetails.Builder backendSets(Map<String,BackendSetDetails> backendSets)

networkSecurityGroupIds

public CreateLoadBalancerDetails.Builder networkSecurityGroupIds(List<String> networkSecurityGroupIds)

An array of NSG OCIDs associated with this load balancer.

During the load balancer's creation, the service adds the new load balancer to the specified NSGs.

The benefits of using NSGs with the load balancer include:

NSGs define network security rules to govern ingress and egress traffic for the load balancer.

The network security rules of other resources can reference the NSGs associated with the load balancer to ensure access.

Example: ["ocid1.nsg.oc1.phx.unique_ID"]

Parameters:

networkSecurityGroupIds - the value to set

Returns:

this builder

subnetIds

public CreateLoadBalancerDetails.Builder subnetIds(List<String> subnetIds)

An array of subnet OCIDs.

Parameters:

subnetIds - the value to set

Returns:

this builder

certificates

public CreateLoadBalancerDetails.Builder certificates(Map<String,CertificateDetails> certificates)

sslCipherSuites

public CreateLoadBalancerDetails.Builder sslCipherSuites(Map<String,SSLCipherSuiteDetails> sslCipherSuites)

pathRouteSets

public CreateLoadBalancerDetails.Builder pathRouteSets(Map<String,PathRouteSetDetails> pathRouteSets)

freeformTags

public CreateLoadBalancerDetails.Builder freeformTags(Map<String,String> freeformTags)

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {"Department": "Finance"}

Parameters:

freeformTags - the value to set

Returns:

this builder

definedTags

public CreateLoadBalancerDetails.Builder definedTags(Map<String,Map<String,Object>> definedTags)

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {"Operations": {"CostCenter": "42"}}

Parameters:

definedTags - the value to set

Returns:

this builder

zprTags

public CreateLoadBalancerDetails.Builder zprTags(Map<String,Map<String,Object>> zprTags)

Extended Defined tags for ZPR for this resource. Each key is predefined and scoped to a namespace.

Example: {"Oracle-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit", "usagetype" : "zpr"}}}

Parameters:

zprTags - the value to set

Returns:

this builder

ruleSets

public CreateLoadBalancerDetails.Builder ruleSets(Map<String,RuleSetDetails> ruleSets)

build

public CreateLoadBalancerDetails build()

copy

public CreateLoadBalancerDetails.Builder copy(CreateLoadBalancerDetails model)