Skip to main content

StateDelegatingStream

(This component is experimental. Use at your own risk.) Orchestrate the retriever's usage based on the state value.

  • type: object
  • required: ["type","name","full_refresh_stream","incremental_stream"]

type​

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

name​

The stream name.

  • Required: Yes
  • type: string
  • default: ``

full_refresh_stream​

Component used to coordinate how records are extracted across stream slices and request pages when the state is empty or not provided.

incremental_stream​

Component used to coordinate how records are extracted across stream slices and request pages when the state provided.

api_retention_period​

The data retention period of the incremental API (ISO8601 duration). If the cursor value is older than this retention period, the connector will automatically fall back to a full refresh to avoid data loss. This is useful for APIs like Stripe Events API which only retain data for 30 days.

  • PT1H: 1 hour
  • P1D: 1 day
  • P1W: 1 week
  • P1M: 1 month
  • P1Y: 1 year
  • P30D: 30 days
  • Required: No
  • type: string

Examples:

P30D
P90D
P1Y

$parameters​

  • Required: No
  • type: object
Was this page helpful?