Skip to main content

WaitTimeFromHeader

Extract wait time from a HTTP header in the response.

  • type: object
  • required: ["type","header"]

type​

  • Required: Yes
  • type: string
  • enum: ["WaitTimeFromHeader"]

The name of the response header defining how long to wait before retrying.

  • Required: Yes
  • type: string
  • Available variables: config

Examples:

Retry-After

regex​

Optional regex to apply on the header to extract its value. The regex should define a capture group defining the wait time.

  • Required: No
  • type: string

Examples:

([-+]?\d+)

max_waiting_time_in_seconds​

Stop the stream instead of waiting, when the value extracted from the header is greater than or equal to this value. Can be a hardcoded number, or a string interpolated from the connector config so that the bound can be changed without a connector release. A value of 0 means never wait. Not evaluated when a rate-limited retry can rotate to another credential with quota; any other retryable error still consults this strategy.

  • Required: No
  • Available variables: config

Examples:

3600
{{ config['max_waiting_time'] * 60 }}
  • anyOf:

    • type: number
  • anyOf:

    • type: string

$parameters​

  • Required: No
  • type: object