com.oracle.bmc.loadbalancer.model

Class UpdateLoadBalancerDetails

java.lang.Object

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

com.oracle.bmc.loadbalancer.model.UpdateLoadBalancerDetails

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

Configuration details to update a load balancer.

*Warning:** 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 UpdateLoadBalancerDetails.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 UpdateLoadBalancerDetails.Builder, which maintain a set of all explicitly set fields called UpdateLoadBalancerDetails.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 and Description
static class	UpdateLoadBalancerDetails.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 and Description
UpdateLoadBalancerDetails(String displayName, Boolean isDeleteProtectionEnabled, Boolean isRequestIdEnabled, String requestIdHeader, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> zprTags) Deprecated.

Method Summary

Modifier and Type	Method and Description
static UpdateLoadBalancerDetails.Builder	builder() Create a new builder.
boolean	equals(Object o)
Map<String,Map<String,Object>>	getDefinedTags() Defined tags for this resource.
String	getDisplayName() The user-friendly display name for the load balancer.
Map<String,String>	getFreeformTags() Free-form tags for this resource.
Boolean	getIsDeleteProtectionEnabled() Whether or not the load balancer has delete protection enabled.
Boolean	getIsRequestIdEnabled() Whether or not the load balancer has the Request Id feature enabled for HTTP listeners.
String	getRequestIdHeader() 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.
Map<String,Map<String,Object>>	getZprTags() Extended Defined tags for ZPR for this resource.
int	hashCode()
UpdateLoadBalancerDetails.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

UpdateLoadBalancerDetails

@Deprecated
 @ConstructorProperties(value={"displayName","isDeleteProtectionEnabled","isRequestIdEnabled","requestIdHeader","freeformTags","definedTags","zprTags"})
public UpdateLoadBalancerDetails(String displayName,
                                                                                                                                                                                                      Boolean isDeleteProtectionEnabled,
                                                                                                                                                                                                      Boolean isRequestIdEnabled,
                                                                                                                                                                                                      String requestIdHeader,
                                                                                                                                                                                                      Map<String,String> freeformTags,
                                                                                                                                                                                                      Map<String,Map<String,Object>> definedTags,
                                                                                                                                                                                                      Map<String,Map<String,Object>> zprTags)

Deprecated.

Method Detail

builder

public static UpdateLoadBalancerDetails.Builder builder()

Create a new builder.

toBuilder

public UpdateLoadBalancerDetails.Builder toBuilder()

getDisplayName

public String getDisplayName()

The user-friendly display name for the load balancer. It does not have to be unique, and it is changeable. Avoid entering confidential information.

Example: example_load_balancer

Returns:

the value

getIsDeleteProtectionEnabled

public Boolean getIsDeleteProtectionEnabled()

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.

If null or unset, the value for delete protection will not be changed.

Example: true

Returns:

the value

getIsRequestIdEnabled

public Boolean getIsRequestIdEnabled()

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 enabled unless isRequestIdEnabled is set to False.

Example: true

Returns:

the value

getRequestIdHeader

public String getRequestIdHeader()

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.

*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.

Returns:

the value

getFreeformTags

public Map<String,String> getFreeformTags()

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"}

Returns:

the value

getDefinedTags

public Map<String,Map<String,Object>> getDefinedTags()

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

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

Returns:

the value

getZprTags

public Map<String,Map<String,Object>> getZprTags()

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"}}}

Returns:

the value

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