UpdateHealthCheckerDetails¶
-
class
oci.network_load_balancer.models.
UpdateHealthCheckerDetails
(**kwargs)¶ Bases:
object
The configuration details of the health checker.
Attributes
PROTOCOL_DNS
A constant which can be used with the protocol property of a UpdateHealthCheckerDetails. PROTOCOL_HTTP
A constant which can be used with the protocol property of a UpdateHealthCheckerDetails. PROTOCOL_HTTPS
A constant which can be used with the protocol property of a UpdateHealthCheckerDetails. PROTOCOL_TCP
A constant which can be used with the protocol property of a UpdateHealthCheckerDetails. PROTOCOL_UDP
A constant which can be used with the protocol property of a UpdateHealthCheckerDetails. dns
Gets the dns of this UpdateHealthCheckerDetails. interval_in_millis
Gets the interval_in_millis of this UpdateHealthCheckerDetails. port
Gets the port of this UpdateHealthCheckerDetails. protocol
Gets the protocol of this UpdateHealthCheckerDetails. request_data
Gets the request_data of this UpdateHealthCheckerDetails. response_body_regex
Gets the response_body_regex of this UpdateHealthCheckerDetails. response_data
Gets the response_data of this UpdateHealthCheckerDetails. retries
Gets the retries of this UpdateHealthCheckerDetails. return_code
Gets the return_code of this UpdateHealthCheckerDetails. timeout_in_millis
Gets the timeout_in_millis of this UpdateHealthCheckerDetails. url_path
Gets the url_path of this UpdateHealthCheckerDetails. Methods
__init__
(**kwargs)Initializes a new UpdateHealthCheckerDetails object with values from keyword arguments. -
PROTOCOL_DNS
= 'DNS'¶ A constant which can be used with the protocol property of a UpdateHealthCheckerDetails. This constant has a value of “DNS”
-
PROTOCOL_HTTP
= 'HTTP'¶ A constant which can be used with the protocol property of a UpdateHealthCheckerDetails. This constant has a value of “HTTP”
-
PROTOCOL_HTTPS
= 'HTTPS'¶ A constant which can be used with the protocol property of a UpdateHealthCheckerDetails. This constant has a value of “HTTPS”
-
PROTOCOL_TCP
= 'TCP'¶ A constant which can be used with the protocol property of a UpdateHealthCheckerDetails. This constant has a value of “TCP”
-
PROTOCOL_UDP
= 'UDP'¶ A constant which can be used with the protocol property of a UpdateHealthCheckerDetails. This constant has a value of “UDP”
-
__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. Allowed values for this property are: “HTTP”, “HTTPS”, “TCP”, “UDP”, “DNS”
- port (int) – The value to assign to the port 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.
- url_path (str) – The value to assign to the url_path property of this UpdateHealthCheckerDetails.
- response_body_regex (str) – The value to assign to the response_body_regex property of this UpdateHealthCheckerDetails.
- return_code (int) – The value to assign to the return_code property of this UpdateHealthCheckerDetails.
- request_data (str) – The value to assign to the request_data property of this UpdateHealthCheckerDetails.
- response_data (str) – The value to assign to the response_data property of this UpdateHealthCheckerDetails.
- dns (oci.network_load_balancer.models.DnsHealthCheckerDetails) – The value to assign to the dns property of this UpdateHealthCheckerDetails.
-
dns
¶ Gets the dns of this UpdateHealthCheckerDetails.
Returns: The dns of this UpdateHealthCheckerDetails. Return type: oci.network_load_balancer.models.DnsHealthCheckerDetails
-
interval_in_millis
¶ 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
¶ 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
¶ Gets the protocol of this UpdateHealthCheckerDetails. The protocol that the health check must use; either HTTP, UDP, or TCP.
Example: HTTP
Allowed values for this property are: “HTTP”, “HTTPS”, “TCP”, “UDP”, “DNS”
Returns: The protocol of this UpdateHealthCheckerDetails. Return type: str
-
request_data
¶ Gets the request_data of this UpdateHealthCheckerDetails. Base64 encoded pattern to be sent as UDP or TCP health check probe.
Returns: The request_data of this UpdateHealthCheckerDetails. Return type: str
-
response_body_regex
¶ 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
-
response_data
¶ Gets the response_data of this UpdateHealthCheckerDetails. Base64 encoded pattern to be validated as UDP or TCP health check probe response.
Returns: The response_data of this UpdateHealthCheckerDetails. Return type: str
-
retries
¶ 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
¶ Gets the return_code of this UpdateHealthCheckerDetails. The status code a healthy backend server should return. If you configure the health check policy to use the HTTP protocol, then you can use common HTTP status codes such as “200”.
Example: 200
Returns: The return_code of this UpdateHealthCheckerDetails. Return type: int
-
timeout_in_millis
¶ 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
-