UpdateLoadBalancerDetails¶

class oci.load_balancer.models.UpdateLoadBalancerDetails(**kwargs)¶

Bases: object

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.

Methods

__init__(**kwargs) Initializes a new UpdateLoadBalancerDetails object with values from keyword arguments.

Attributes

`defined_tags`	Gets the defined_tags of this UpdateLoadBalancerDetails.
`display_name`	Gets the display_name of this UpdateLoadBalancerDetails.
`freeform_tags`	Gets the freeform_tags of this UpdateLoadBalancerDetails.
`is_delete_protection_enabled`	Gets the is_delete_protection_enabled of this UpdateLoadBalancerDetails.
`is_request_id_enabled`	Gets the is_request_id_enabled of this UpdateLoadBalancerDetails.
`request_id_header`	Gets the request_id_header of this UpdateLoadBalancerDetails.

__init__(**kwargs)¶

Initializes a new UpdateLoadBalancerDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

display_name (str) – The value to assign to the display_name property of this UpdateLoadBalancerDetails.
is_delete_protection_enabled (bool) – The value to assign to the is_delete_protection_enabled property of this UpdateLoadBalancerDetails.
is_request_id_enabled (bool) – The value to assign to the is_request_id_enabled property of this UpdateLoadBalancerDetails.
request_id_header (str) – The value to assign to the request_id_header property of this UpdateLoadBalancerDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this UpdateLoadBalancerDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this UpdateLoadBalancerDetails.

defined_tags¶

Gets the defined_tags of this UpdateLoadBalancerDetails. 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 defined_tags of this UpdateLoadBalancerDetails.
Return type:	dict(str, dict(str, object))

display_name¶

Gets the display_name of this UpdateLoadBalancerDetails. 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 display_name of this UpdateLoadBalancerDetails.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this UpdateLoadBalancerDetails. 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 freeform_tags of this UpdateLoadBalancerDetails.
Return type:	dict(str, str)

is_delete_protection_enabled¶

Gets the is_delete_protection_enabled of this UpdateLoadBalancerDetails. 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 is_delete_protection_enabled of this UpdateLoadBalancerDetails.
Return type:	bool

is_request_id_enabled¶

Gets the is_request_id_enabled of this UpdateLoadBalancerDetails. 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 is_request_id_enabled of this UpdateLoadBalancerDetails.
Return type:	bool

request_id_header¶

Gets the request_id_header of this UpdateLoadBalancerDetails. 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 request_id_header of this UpdateLoadBalancerDetails.
Return type:	str