Skip to content

FallbackTriggersDict

Dictionary Type

FallbackTriggersDict

Bases: TypedDict

Dictionary form of FallbackTriggers.

Attributes

errors instance-attribute
errors: Sequence[str] | None

The errors that trigger a fallback. You can specify the following:

  • CONNECTION_ERROR -- The gateway couldn't connect to the target because the connection was refused, reset, or timed out. The request didn't reach the target.

  • FIRST_BYTE_TIMEOUT -- The target accepted the connection but didn't return the first byte of the response within firstByteTimeoutMilliseconds. The gateway abandons the request before any of the response reaches you.

  • UNROUTABLE -- The gateway couldn't route the request to the target, for example because the target doesn't exist or doesn't support the request path. These errors don't count toward the circuit breaker.

status_codes instance-attribute
status_codes: Sequence[str] | None

The HTTP status codes returned by the target that trigger a fallback. You can specify the following:

  • An exact status code -- A three-digit code, such as 429.

  • A class of status codes -- The first digit followed by XX, such as 5XX, which matches every code from 500 to 599.

Only 4XX and 5XX codes are supported. Throttling by the gateway itself doesn't trigger a fallback.