Class ConnectionHealthStatusCodes

• TopLevel.Object
  • dw.commerceapps.ConnectionHealthStatusCodes

Status codes and detail keys returned by the ConnectionHealthCheckHooks.checkConnectionHealth() hook. The BM connection-health endpoint translates the returned Status into a health payload using these values.

See Also:

• ConnectionHealthCheckHooks

Constant Summary 

Constant	Description
DETAIL_MESSAGE: String = “message”	Status detail key for the human-readable status message.
DETAIL_REMEDIATION: String = “remediation”	Status detail key for the merchant-facing remediation hint.
STATUS_CODE_DEGRADED: String = “DEGRADED”	Status code that indicates a degraded connection (partial functionality available).
STATUS_CODE_UNHEALTHY: String = “UNHEALTHY”	Status code that indicates the connection is unhealthy.

Constructor Summary 

Constructor	Description
ConnectionHealthStatusCodes()

Method Summary 

Methods inherited from class Object 

assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values

Constant Details 

DETAIL_MESSAGE 

DETAIL_MESSAGE: String = "message"

Status detail key for the human-readable status message.

---

DETAIL_REMEDIATION 

DETAIL_REMEDIATION: String = "remediation"

Status detail key for the merchant-facing remediation hint.

---

STATUS_CODE_DEGRADED 

STATUS_CODE_DEGRADED: String = "DEGRADED"

Status code that indicates a degraded connection (partial functionality available).

---

STATUS_CODE_UNHEALTHY 

STATUS_CODE_UNHEALTHY: String = "UNHEALTHY"

Status code that indicates the connection is unhealthy.

---

Constructor Details 

ConnectionHealthStatusCodes() 

ConnectionHealthStatusCodes()

---