Available on crate feature
source-rest only.Modules§
- auth
- Authentication strategies for REST APIs.
- config
- Stream configuration and builder.
- extract
- Record extraction from API responses.
- pagination
- Pagination strategies for REST APIs.
- replication
- Incremental replication support.
- retry
- Retry logic with exponential backoff.
- schema
- JSON Schema inference from record samples.
- serde_
helpers - Serde helper modules for types that don’t implement Serialize/Deserialize natively.
- stream
- The main REST stream executor.
- transform
- Record transformation pipeline.
Structs§
- Response
Validator - Optional callback to decide whether the token endpoint response is successful.
- Rest
Stream - A configured REST API stream that handles pagination, auth, and extraction.
- Rest
Stream Config - Configuration for a RestStream.
Enums§
- Auth
- Supported authentication methods.
- Faucet
Error - All possible errors returned by faucet-stream.
- Pagination
Style - Supported pagination strategies.
- Record
Transform - A transformation applied to every record fetched by a source (e.g. the REST
source’s
RestStream). - Replication
Method - Determines how records are replicated from the source.
Constants§
- DEFAULT_
EXPIRY_ RATIO - Default fraction of
expires_inafter which the token is refreshed. - DEFAULT_
TOKEN_ ENDPOINT_ EXPIRY_ RATIO - Default fraction of
expires_inafter which the token is refreshed.
Traits§
- Sink
- A sink writes records to an external system.
- Source
- A source fetches records from an external system.
Functions§
- fetch_
oauth2_ token - Fetch an OAuth2 token using the client credentials grant.
- fetch_
token_ from_ endpoint - Fetch a token from the given endpoint and extract it using JSONPath.