Skip to content

class HealthCheckOptions

cangjie
public class HealthCheckOptions

功能:表示健康检查中间件和终结点使用的选项集合。

成员概览

成员功能
init()创建一个带默认状态码映射的健康检查选项实例。
var resultStatusCodes保存不同健康状态对应的响应状态码映射。
var allowCachingResponses指示健康检查响应是否允许被缓存。
var predicate定义用于筛选要执行的健康检查注册项的条件。
var responseWriter定义将健康检查结果写入 HTTP 响应的回调。

init()

cangjie
public init()

功能:创建一个带默认状态码映射的健康检查选项实例。

var resultStatusCodes

cangjie
public var resultStatusCodes: HashMap<HealthStatus, UInt16>

功能:保存不同健康状态对应的响应状态码映射。

类型:HashMap<HealthStatus, UInt16>

var allowCachingResponses

cangjie
public var allowCachingResponses = false

功能:指示健康检查响应是否允许被缓存。

var predicate

cangjie
public var predicate: (HealthCheckRegistration) -> Bool =

功能:定义用于筛选要执行的健康检查注册项的条件。

类型:(HealthCheckRegistration) -> Bool

var responseWriter

cangjie
public var responseWriter: (HttpContext, HealthReport) -> Unit =

功能:定义将健康检查结果写入 HTTP 响应的回调。

类型:(HttpContext, HealthReport) -> Unit