CreateContainerTcpHealthCheckDetails

class oci.container_instances.models.CreateContainerTcpHealthCheckDetails(**kwargs)

Bases: CreateContainerHealthCheckDetails

Container Health Check TCP type.

Attributes:

FAILURE_ACTION_KILL

A constant which can be used with the failure_action property of a CreateContainerHealthCheckDetails.

FAILURE_ACTION_NONE

A constant which can be used with the failure_action property of a CreateContainerHealthCheckDetails.

HEALTH_CHECK_TYPE_HTTP

A constant which can be used with the health_check_type property of a CreateContainerHealthCheckDetails.

HEALTH_CHECK_TYPE_TCP

A constant which can be used with the health_check_type property of a CreateContainerHealthCheckDetails.

failure_action

Gets the failure_action of this CreateContainerHealthCheckDetails.

failure_threshold

Gets the failure_threshold of this CreateContainerHealthCheckDetails.

health_check_type

[Required] Gets the health_check_type of this CreateContainerHealthCheckDetails.

initial_delay_in_seconds

Gets the initial_delay_in_seconds of this CreateContainerHealthCheckDetails.

interval_in_seconds

Gets the interval_in_seconds of this CreateContainerHealthCheckDetails.

name

Gets the name of this CreateContainerHealthCheckDetails.

port

[Required] Gets the port of this CreateContainerTcpHealthCheckDetails.

success_threshold

Gets the success_threshold of this CreateContainerHealthCheckDetails.

timeout_in_seconds

Gets the timeout_in_seconds of this CreateContainerHealthCheckDetails.

Methods:

__init__(**kwargs)

Initializes a new CreateContainerTcpHealthCheckDetails 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 CreateContainerHealthCheckDetails. This constant has a value of “KILL”

FAILURE_ACTION_NONE = 'NONE'

A constant which can be used with the failure_action property of a CreateContainerHealthCheckDetails. 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 CreateContainerHealthCheckDetails. 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 CreateContainerHealthCheckDetails. This constant has a value of “TCP”

__init__(**kwargs)

Initializes a new CreateContainerTcpHealthCheckDetails object with values from keyword arguments. The default value of the health_check_type attribute of this class is TCP and 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 CreateContainerTcpHealthCheckDetails.

  • health_check_type (str) – The value to assign to the health_check_type property of this CreateContainerTcpHealthCheckDetails. 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 CreateContainerTcpHealthCheckDetails.

  • interval_in_seconds (int) – The value to assign to the interval_in_seconds property of this CreateContainerTcpHealthCheckDetails.

  • failure_threshold (int) – The value to assign to the failure_threshold property of this CreateContainerTcpHealthCheckDetails.

  • success_threshold (int) – The value to assign to the success_threshold property of this CreateContainerTcpHealthCheckDetails.

  • timeout_in_seconds (int) – The value to assign to the timeout_in_seconds property of this CreateContainerTcpHealthCheckDetails.

  • failure_action (str) – The value to assign to the failure_action property of this CreateContainerTcpHealthCheckDetails. Allowed values for this property are: “KILL”, “NONE”

  • port (int) – The value to assign to the port property of this CreateContainerTcpHealthCheckDetails.

property failure_action

Gets the failure_action of this CreateContainerHealthCheckDetails. 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”

Returns

The failure_action of this CreateContainerHealthCheckDetails.

Return type

str

property failure_threshold

Gets the failure_threshold of this CreateContainerHealthCheckDetails. Number of consecutive failures at which we consider the check failed.

Returns

The failure_threshold of this CreateContainerHealthCheckDetails.

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 health_check_type

[Required] Gets the health_check_type of this CreateContainerHealthCheckDetails. Container health check type.

Allowed values for this property are: “HTTP”, “TCP”

Returns

The health_check_type of this CreateContainerHealthCheckDetails.

Return type

str

property initial_delay_in_seconds

Gets the initial_delay_in_seconds of this CreateContainerHealthCheckDetails. The initial delay in seconds before start checking container health status.

Returns

The initial_delay_in_seconds of this CreateContainerHealthCheckDetails.

Return type

int

property interval_in_seconds

Gets the interval_in_seconds of this CreateContainerHealthCheckDetails. Number of seconds between two consecutive runs for checking container health.

Returns

The interval_in_seconds of this CreateContainerHealthCheckDetails.

Return type

int

property name

Gets the name of this CreateContainerHealthCheckDetails. Health check name.

Returns

The name of this CreateContainerHealthCheckDetails.

Return type

str

property port

[Required] Gets the port of this CreateContainerTcpHealthCheckDetails. Container health check port.

Returns

The port of this CreateContainerTcpHealthCheckDetails.

Return type

int

property success_threshold

Gets the success_threshold of this CreateContainerHealthCheckDetails. Number of consecutive successes at which we consider the check succeeded again after it was in failure state.

Returns

The success_threshold of this CreateContainerHealthCheckDetails.

Return type

int

property timeout_in_seconds

Gets the timeout_in_seconds of this CreateContainerHealthCheckDetails. Length of waiting time in seconds before marking health check failed.

Returns

The timeout_in_seconds of this CreateContainerHealthCheckDetails.

Return type

int