ContainerHttpHealthCheck¶
- class oci.container_instances.models.ContainerHttpHealthCheck(**kwargs)¶
Bases:
ContainerHealthCheckContainer Health Check HTTP type.
Attributes:
A constant which can be used with the failure_action property of a ContainerHealthCheck.
A constant which can be used with the failure_action property of a ContainerHealthCheck.
A constant which can be used with the health_check_type property of a ContainerHealthCheck.
A constant which can be used with the health_check_type property of a ContainerHealthCheck.
A constant which can be used with the status property of a ContainerHealthCheck.
A constant which can be used with the status property of a ContainerHealthCheck.
A constant which can be used with the status property of a ContainerHealthCheck.
Gets the failure_action of this ContainerHealthCheck.
Gets the failure_threshold of this ContainerHealthCheck.
Gets the headers of this ContainerHttpHealthCheck.
[Required] Gets the health_check_type of this ContainerHealthCheck.
Gets the initial_delay_in_seconds of this ContainerHealthCheck.
Gets the interval_in_seconds of this ContainerHealthCheck.
Gets the name of this ContainerHealthCheck.
[Required] Gets the path of this ContainerHttpHealthCheck.
[Required] Gets the port of this ContainerHttpHealthCheck.
Gets the status of this ContainerHealthCheck.
Gets the status_details of this ContainerHealthCheck.
Gets the success_threshold of this ContainerHealthCheck.
Gets the timeout_in_seconds of this ContainerHealthCheck.
Methods:
__init__(**kwargs)Initializes a new ContainerHttpHealthCheck object with values from keyword arguments.
get_subtype(object_dictionary)Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
- FAILURE_ACTION_KILL = 'KILL'¶
A constant which can be used with the failure_action property of a ContainerHealthCheck. This constant has a value of “KILL”
- FAILURE_ACTION_NONE = 'NONE'¶
A constant which can be used with the failure_action property of a ContainerHealthCheck. This constant has a value of “NONE”
- HEALTH_CHECK_TYPE_HTTP = 'HTTP'¶
A constant which can be used with the health_check_type property of a ContainerHealthCheck. This constant has a value of “HTTP”
- HEALTH_CHECK_TYPE_TCP = 'TCP'¶
A constant which can be used with the health_check_type property of a ContainerHealthCheck. This constant has a value of “TCP”
- STATUS_HEALTHY = 'HEALTHY'¶
A constant which can be used with the status property of a ContainerHealthCheck. This constant has a value of “HEALTHY”
- STATUS_UNHEALTHY = 'UNHEALTHY'¶
A constant which can be used with the status property of a ContainerHealthCheck. This constant has a value of “UNHEALTHY”
- STATUS_UNKNOWN = 'UNKNOWN'¶
A constant which can be used with the status property of a ContainerHealthCheck. This constant has a value of “UNKNOWN”
- __init__(**kwargs)¶
Initializes a new ContainerHttpHealthCheck object with values from keyword arguments. The default value of the
health_check_typeattribute of this class isHTTPand it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):- Parameters
name (str) – The value to assign to the name property of this ContainerHttpHealthCheck.
health_check_type (str) – The value to assign to the health_check_type property of this ContainerHttpHealthCheck. Allowed values for this property are: “HTTP”, “TCP”
initial_delay_in_seconds (int) – The value to assign to the initial_delay_in_seconds property of this ContainerHttpHealthCheck.
interval_in_seconds (int) – The value to assign to the interval_in_seconds property of this ContainerHttpHealthCheck.
failure_threshold (int) – The value to assign to the failure_threshold property of this ContainerHttpHealthCheck.
success_threshold (int) – The value to assign to the success_threshold property of this ContainerHttpHealthCheck.
timeout_in_seconds (int) – The value to assign to the timeout_in_seconds property of this ContainerHttpHealthCheck.
status (str) – The value to assign to the status property of this ContainerHttpHealthCheck. Allowed values for this property are: “HEALTHY”, “UNHEALTHY”, “UNKNOWN”
status_details (str) – The value to assign to the status_details property of this ContainerHttpHealthCheck.
failure_action (str) – The value to assign to the failure_action property of this ContainerHttpHealthCheck. Allowed values for this property are: “KILL”, “NONE”
path (str) – The value to assign to the path property of this ContainerHttpHealthCheck.
port (int) – The value to assign to the port property of this ContainerHttpHealthCheck.
headers (list[oci.container_instances.models.HealthCheckHttpHeader]) – The value to assign to the headers property of this ContainerHttpHealthCheck.
- property failure_action¶
Gets the failure_action of this ContainerHealthCheck. The action will be triggered when the container health check fails. There are two types of action: KILL or NONE. The default action is KILL. If failure action is KILL, the container will be subject to the container restart policy.
Allowed values for this property are: “KILL”, “NONE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The failure_action of this ContainerHealthCheck.
- Return type
str
- property failure_threshold¶
Gets the failure_threshold of this ContainerHealthCheck. Number of consecutive failures at which we consider the check failed.
- Returns
The failure_threshold of this ContainerHealthCheck.
- Return type
int
- static get_subtype(object_dictionary)¶
Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
- property headers¶
Gets the headers of this ContainerHttpHealthCheck. Container health check HTTP headers.
- Returns
The headers of this ContainerHttpHealthCheck.
- Return type
- property health_check_type¶
[Required] Gets the health_check_type of this ContainerHealthCheck. Container health check type.
Allowed values for this property are: “HTTP”, “TCP”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The health_check_type of this ContainerHealthCheck.
- Return type
str
- property initial_delay_in_seconds¶
Gets the initial_delay_in_seconds of this ContainerHealthCheck. The initial delay in seconds before start checking container health status.
- Returns
The initial_delay_in_seconds of this ContainerHealthCheck.
- Return type
int
- property interval_in_seconds¶
Gets the interval_in_seconds of this ContainerHealthCheck. Number of seconds between two consecutive runs for checking container health.
- Returns
The interval_in_seconds of this ContainerHealthCheck.
- Return type
int
- property name¶
Gets the name of this ContainerHealthCheck. Health check name.
- Returns
The name of this ContainerHealthCheck.
- Return type
str
- property path¶
[Required] Gets the path of this ContainerHttpHealthCheck. Container health check HTTP path.
- Returns
The path of this ContainerHttpHealthCheck.
- Return type
str
- property port¶
[Required] Gets the port of this ContainerHttpHealthCheck. Container health check HTTP port.
- Returns
The port of this ContainerHttpHealthCheck.
- Return type
int
- property status¶
Gets the status of this ContainerHealthCheck. Status of container
Allowed values for this property are: “HEALTHY”, “UNHEALTHY”, “UNKNOWN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The status of this ContainerHealthCheck.
- Return type
str
- property status_details¶
Gets the status_details of this ContainerHealthCheck. A message describing the current status in more details.
- Returns
The status_details of this ContainerHealthCheck.
- Return type
str
- property success_threshold¶
Gets the success_threshold of this ContainerHealthCheck. Number of consecutive successes at which we consider the check succeeded again after it was in failure state.
- Returns
The success_threshold of this ContainerHealthCheck.
- Return type
int
- property timeout_in_seconds¶
Gets the timeout_in_seconds of this ContainerHealthCheck. Length of waiting time in seconds before marking health check failed.
- Returns
The timeout_in_seconds of this ContainerHealthCheck.
- Return type
int