Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace UpdateHealthCheckerDetails

The configuration details of the health checker.

Properties

Optional dns

dns: model.DnsHealthCheckerDetails

Optional intervalInMillis

intervalInMillis: undefined | number

The interval between health checks, in milliseconds.

Example: {@code 10000} Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional port

port: undefined | number

The backend server port against which to run the health check.

Example: {@code 8080} Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional protocol

protocol: model.HealthCheckProtocols

The protocol that the health check must use; either HTTP, UDP, or TCP.

Example: {@code HTTP}

Optional requestData

requestData: undefined | string

Base64 encoded pattern to be sent as UDP or TCP health check probe.

Optional responseBodyRegex

responseBodyRegex: undefined | string

A regular expression for parsing the response body from the backend server.

Example: {@code ^((?!false).|\\s)*$}

Optional responseData

responseData: undefined | string

Base64 encoded pattern to be validated as UDP or TCP health check probe response.

Optional retries

retries: undefined | number

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: {@code 3} Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional returnCode

returnCode: undefined | number

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: {@code 200} Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional timeoutInMillis

timeoutInMillis: undefined | number

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: {@code 3000} Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional urlPath

urlPath: undefined | string

The path against which to run the health check.

Example: {@code /healthcheck}

Functions

getDeserializedJsonObj

getJsonObj