Show / Hide Table of Contents

Class CreateContainerHealthCheckDetails

Container Health Check is used to check and report the status of a container.

Inheritance
object
CreateContainerHealthCheckDetails
CreateContainerHttpHealthCheckDetails
CreateContainerTcpHealthCheckDetails
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.ContainerinstancesService.Models
Assembly: OCI.DotNetSDK.Containerinstances.dll
Syntax
[JsonConverter(typeof(CreateContainerHealthCheckDetailsModelConverter))]
public class CreateContainerHealthCheckDetails

Properties

FailureAction

Declaration
[JsonProperty(PropertyName = "failureAction")]
[JsonConverter(typeof(StringEnumConverter))]
public ContainerHealthCheckFailureAction? FailureAction { get; set; }
Property Value
Type Description
ContainerHealthCheckFailureAction?

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.

FailureThreshold

Declaration
[JsonProperty(PropertyName = "failureThreshold")]
public int? FailureThreshold { get; set; }
Property Value
Type Description
int?

Number of consecutive failures at which we consider the check failed.

InitialDelayInSeconds

Declaration
[JsonProperty(PropertyName = "initialDelayInSeconds")]
public int? InitialDelayInSeconds { get; set; }
Property Value
Type Description
int?

The initial delay in seconds before start checking container health status.

IntervalInSeconds

Declaration
[JsonProperty(PropertyName = "intervalInSeconds")]
public int? IntervalInSeconds { get; set; }
Property Value
Type Description
int?

Number of seconds between two consecutive runs for checking container health.

Name

Declaration
[JsonProperty(PropertyName = "name")]
public string Name { get; set; }
Property Value
Type Description
string

Health check name.

SuccessThreshold

Declaration
[JsonProperty(PropertyName = "successThreshold")]
public int? SuccessThreshold { get; set; }
Property Value
Type Description
int?

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

TimeoutInSeconds

Declaration
[JsonProperty(PropertyName = "timeoutInSeconds")]
public int? TimeoutInSeconds { get; set; }
Property Value
Type Description
int?

Length of waiting time in seconds before marking health check failed.

In this article
Back to top