UpdateHealthCheckerDetails

class oci.load_balancer.models.UpdateHealthCheckerDetails(**kwargs)

Bases: object

The health checker's configuration details.

__init__(**kwargs)

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

Parameters:
  • protocol (str) -- The value to assign to the protocol property of this UpdateHealthCheckerDetails.
  • url_path (str) -- The value to assign to the url_path property of this UpdateHealthCheckerDetails.
  • port (int) -- The value to assign to the port property of this UpdateHealthCheckerDetails.
  • return_code (int) -- The value to assign to the return_code property of this UpdateHealthCheckerDetails.
  • retries (int) -- The value to assign to the retries property of this UpdateHealthCheckerDetails.
  • timeout_in_millis (int) -- The value to assign to the timeout_in_millis property of this UpdateHealthCheckerDetails.
  • interval_in_millis (int) -- The value to assign to the interval_in_millis property of this UpdateHealthCheckerDetails.
  • response_body_regex (str) -- The value to assign to the response_body_regex property of this UpdateHealthCheckerDetails.
interval_in_millis

[Required] Gets the interval_in_millis of this UpdateHealthCheckerDetails. The interval between health checks, in milliseconds.

Example: 10000

Returns:The interval_in_millis of this UpdateHealthCheckerDetails.
Return type:int
port

[Required] Gets the port of this UpdateHealthCheckerDetails. The backend server port against which to run the health check.

Example: 8080

Returns:The port of this UpdateHealthCheckerDetails.
Return type:int
protocol

[Required] Gets the protocol of this UpdateHealthCheckerDetails. The protocol the health check must use; either HTTP or TCP.

Example: HTTP

Returns:The protocol of this UpdateHealthCheckerDetails.
Return type:str
response_body_regex

[Required] Gets the response_body_regex of this UpdateHealthCheckerDetails. A regular expression for parsing the response body from the backend server.

Example: ^((?!false).|s)*$

Returns:The response_body_regex of this UpdateHealthCheckerDetails.
Return type:str
retries

[Required] Gets the retries of this UpdateHealthCheckerDetails. The number of retries to attempt before a backend server is considered "unhealthy". This number also applies when recovering a server to the "healthy" state.

Example: 3

Returns:The retries of this UpdateHealthCheckerDetails.
Return type:int
return_code

[Required] Gets the return_code of this UpdateHealthCheckerDetails. The status code a healthy backend server should return.

Example: 200

Returns:The return_code of this UpdateHealthCheckerDetails.
Return type:int
timeout_in_millis

[Required] Gets the timeout_in_millis of this UpdateHealthCheckerDetails. The maximum time, in milliseconds, to wait for a reply to a health check. A health check is successful only if a reply returns within this timeout period.

Example: 3000

Returns:The timeout_in_millis of this UpdateHealthCheckerDetails.
Return type:int
url_path

Gets the url_path of this UpdateHealthCheckerDetails. The path against which to run the health check.

Example: /healthcheck

Returns:The url_path of this UpdateHealthCheckerDetails.
Return type:str