Expand description
Types used as operation parameters and responses.
Modules§
- builder
- Types for composing complex structures.
- defaults
- Generation of default values for serde.
- error
- Error types.
Structs§
- AdHoc
Input Config - Configuration for inserting data with ad-hoc queries
- Adhoc
Query Args - Arguments to the
/queryendpoint. - ApiKey
Descr - API key descriptor.
- ApiKey
Id - API key identifier.
- Build
Information - Information about the build of the platform.
- Checkpoint
Failure - Information about a failed checkpoint.
- Clock
Config - ClockConfig
- Completion
Status Args - URL-encoded arguments to the
/completion_statusendpoint. - Completion
Status Response - Response to a completion token status request.
- Completion
Token Response - Response to a completion token creation request.
- Configuration
- Configuration
- Demo
- Demo
- File
Backend Config - Configuration for local file system access.
- GetPipeline
Parameters - Query parameters to GET a pipeline or a list of pipelines.
- Glue
Catalog Config - AWS Glue catalog config.
- Http
Input Config - Configuration for reading data via HTTP.
- Iceberg
Reader Config - Iceberg input connector configuration.
- License
Information - LicenseInformation
- Metrics
Parameters - Query parameters to retrieve pipeline circuit metrics.
- NewApi
KeyRequest - Request to create a new API key.
- NewApi
KeyResponse - Response to a successful API key creation.
- Object
Storage Config - ObjectStorageConfig
- Partial
Program Info - Program information is the result of the SQL compilation.
- Patch
Pipeline - Partially update the pipeline (PATCH).
- Pipeline
Id - Pipeline identifier.
- Pipeline
Info - Pipeline information. It both includes fields which are user-provided and system-generated.
- Pipeline
Selected Info - Pipeline information which has a selected subset of optional fields.
It both includes fields which are user-provided and system-generated.
If an optional field is not selected (i.e., is
None), it will not be serialized. - Post
PutPipeline - Create a new pipeline (POST), or fully update an existing pipeline (PUT).
Fields which are optional and not provided will be set to their empty type value
(for strings: an empty string
"", for objects: an empty dictionary{}). - Post
Stop Pipeline Parameters - Query parameters to POST a pipeline stop.
- Postgres
Reader Config - Postgres input connector configuration.
- Postgres
Writer Config - Postgres output connector configuration.
- Program
Config - Program configuration.
- Program
Error - Log, warning and error information about the program compilation.
- Program
Info - Program information is the output of the SQL compiler.
- Provider
AwsCognito - ProviderAwsCognito
- Provider
Google Identity - ProviderGoogleIdentity
- PubSub
Input Config - Google Pub/Sub input connector configuration.
- Redis
Output Config - Redis output connector configuration.
- Rest
Catalog Config - Iceberg REST catalog config.
- Rust
Compilation Info - Rust compilation information.
- SqlCompilation
Info - SQL compilation information.
- SqlCompiler
Message - A SQL compiler error.
- SqlIdentifier
- An SQL identifier.
- Storage
Options - Storage configuration for a pipeline.
- Sync
Config - SyncConfig
- Update
Information - UpdateInformation
- Version
- Version number.
Enums§
- AdHoc
Result Format - URL-encoded
formatargument to the/queryendpoint. - ApiPermission
- Permission types for invoking API endpoints.
- Auth
Provider - AuthProvider
- Compilation
Profile - Enumeration of possible compilation profiles that can be passed to the Rust compiler
as an argument via
cargo build --profile <>. A compilation profile affects among other things the compilation speed (how long till the program is ready to be run) and runtime speed (the performance while running). - Completion
Status - Completion token status returned by the
/completion_statusendpoint. - Display
Schedule - DisplaySchedule
- Iceberg
Catalog Type - IcebergCatalogType
- Iceberg
Ingest Mode - Iceberg table read mode.
- Iceberg
Reader Config Rest Headers - IcebergReaderConfigRestHeaders
- Json
Lines - Whether JSON values can span multiple lines.
- Kafka
Start From Config - Where to begin reading a Kafka topic.
- License
Validity - LicenseValidity
- Metrics
Format - Circuit metrics output format.
- Pipeline
Desired Status - PipelineDesiredStatus
- Pipeline
Field Selector - PipelineFieldSelector
- Pipeline
Status - Pipeline status.
- Program
Status - Program compilation status.
- Storage
Status - Storage status.