--- title: Pipelines --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Pipelines ##### [\[DEPRECATED\] List Pipelines](https://developers.cloudflare.com/api/python/resources/pipelines/methods/list) Deprecated pipelines.list(PipelineListParams\*\*kwargs) -> [PipelineListResponse]() GET/accounts/{account\_id}/pipelines ##### [\[DEPRECATED\] Get Pipeline](https://developers.cloudflare.com/api/python/resources/pipelines/methods/get) Deprecated pipelines.get(strpipeline\_name, PipelineGetParams\*\*kwargs) -> [PipelineGetResponse]() GET/accounts/{account\_id}/pipelines/{pipeline\_name} ##### [\[DEPRECATED\] Create Pipeline](https://developers.cloudflare.com/api/python/resources/pipelines/methods/create) Deprecated pipelines.create(PipelineCreateParams\*\*kwargs) -> [PipelineCreateResponse]() POST/accounts/{account\_id}/pipelines ##### [\[DEPRECATED\] Update Pipeline](https://developers.cloudflare.com/api/python/resources/pipelines/methods/update) Deprecated pipelines.update(strpipeline\_name, PipelineUpdateParams\*\*kwargs) -> [PipelineUpdateResponse]() PUT/accounts/{account\_id}/pipelines/{pipeline\_name} ##### [\[DEPRECATED\] Delete Pipeline](https://developers.cloudflare.com/api/python/resources/pipelines/methods/delete) Deprecated pipelines.delete(strpipeline\_name, PipelineDeleteParams\*\*kwargs) DELETE/accounts/{account\_id}/pipelines/{pipeline\_name} ##### [List Pipelines](https://developers.cloudflare.com/api/python/resources/pipelines/methods/list_v1) pipelines.list\_v1(PipelineListV1Params\*\*kwargs) -> SyncV4PagePaginationArray\[[PipelineListV1Response]()] GET/accounts/{account\_id}/pipelines/v1/pipelines ##### [Get Pipeline Details](https://developers.cloudflare.com/api/python/resources/pipelines/methods/get_v1) pipelines.get\_v1(strpipeline\_id, PipelineGetV1Params\*\*kwargs) -> [PipelineGetV1Response]() GET/accounts/{account\_id}/pipelines/v1/pipelines/{pipeline\_id} ##### [Create Pipeline](https://developers.cloudflare.com/api/python/resources/pipelines/methods/create_v1) pipelines.create\_v1(PipelineCreateV1Params\*\*kwargs) -> [PipelineCreateV1Response]() POST/accounts/{account\_id}/pipelines/v1/pipelines ##### [Delete Pipeline](https://developers.cloudflare.com/api/python/resources/pipelines/methods/delete_v1) pipelines.delete\_v1(strpipeline\_id, PipelineDeleteV1Params\*\*kwargs) -> object DELETE/accounts/{account\_id}/pipelines/v1/pipelines/{pipeline\_id} ##### [Validate SQL](https://developers.cloudflare.com/api/python/resources/pipelines/methods/validate_sql) pipelines.validate\_sql(PipelineValidateSqlParams\*\*kwargs) -> [PipelineValidateSqlResponse]() POST/accounts/{account\_id}/pipelines/v1/validate\_sql ##### ModelsExpand Collapse
FieldType One of the following:
class Int32: … type: Literal\["int32"] Link to this property
Link to this property
class Int64: … type: Literal\["int64"] Link to this property
Link to this property
class Float32: … type: Literal\["float32"] Link to this property
Link to this property
class Float64: … type: Literal\["float64"] Link to this property
Link to this property
class Bool: … type: Literal\["bool"] Link to this property
Link to this property
class String: … type: Literal\["string"] Link to this property
Link to this property
class Binary: … type: Literal\["binary"] Link to this property
Link to this property
class Timestamp: … type: Literal\["timestamp"] Link to this property
unit: Optional\[Literal\["second", "millisecond", "microsecond", "nanosecond"]] One of the following: "second" Link to this property "millisecond" Link to this property "microsecond" Link to this property "nanosecond" Link to this property
Link to this property
Link to this property
class Json: … type: Literal\["json"] Link to this property
Link to this property
class Struct: …
fields: List\[SourceField] One of the following:
class Int32: … type: Literal\["int32"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Int64: … type: Literal\["int64"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Float32: … type: Literal\["float32"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Float64: … type: Literal\["float64"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Bool: … type: Literal\["bool"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class String: … type: Literal\["string"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Binary: … type: Literal\["binary"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Timestamp: … type: Literal\["timestamp"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
unit: Optional\[Literal\["second", "millisecond", "microsecond", "nanosecond"]] One of the following: "second" Link to this property "millisecond" Link to this property "microsecond" Link to this property "nanosecond" Link to this property
Link to this property
Link to this property
class Json: … type: Literal\["json"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Struct: … type: Literal\["struct"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class List: … type: Literal\["list"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
Link to this property type: Literal\["struct"] Link to this property name: Optional\[str] Link to this property
Link to this property
class List: … items: SourceField Link to this property type: Literal\["list"] Link to this property
Link to this property
[Link to this property](<#(resource)%20pipelines%20%3E%20(model)%20field_type%20%3E%20(schema)>)
class ListField: … items: SourceField Link to this property
[Link to this property](<#(resource)%20pipelines%20%3E%20(model)%20list_field%20%3E%20(schema)>)
SourceField One of the following:
class Int32: … type: Literal\["int32"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Int64: … type: Literal\["int64"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Float32: … type: Literal\["float32"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Float64: … type: Literal\["float64"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Bool: … type: Literal\["bool"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class String: … type: Literal\["string"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Binary: … type: Literal\["binary"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Timestamp: … type: Literal\["timestamp"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
unit: Optional\[Literal\["second", "millisecond", "microsecond", "nanosecond"]] One of the following: "second" Link to this property "millisecond" Link to this property "microsecond" Link to this property "nanosecond" Link to this property
Link to this property
Link to this property
class Json: … type: Literal\["json"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Struct: … type: Literal\["struct"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class List: … type: Literal\["list"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
[Link to this property](<#(resource)%20pipelines%20%3E%20(model)%20source_field%20%3E%20(schema)>)
class StructField: … fields: List\[SourceField] Link to this property name: Optional\[str] Link to this property
[Link to this property](<#(resource)%20pipelines%20%3E%20(model)%20struct_field%20%3E%20(schema)>)
class PipelineListResponse: …
result\_info: ResultInfo count: float Indicates the number of items on current page. Link to this property page: float Indicates the current page number. Link to this property per\_page: float Indicates the number of items per page. Link to this property total\_count: float Indicates the total number of items. Link to this property
Link to this property
results: List\[Result] id: str Specifies the pipeline identifier. Link to this property
destination: ResultDestination
batch: ResultDestinationBatch max\_bytes: int Specifies rough maximum size of files. maximum100000000 minimum1000 Link to this property max\_duration\_s: float Specifies duration to wait to aggregate batches files. maximum300 minimum0.25 Link to this property max\_rows: int Specifies rough maximum number of rows per file. maximum10000000 minimum100 Link to this property
Link to this property
compression: ResultDestinationCompression
type: Literal\["none", "gzip", "deflate"] Specifies the desired compression algorithm and format. One of the following: "none" Link to this property "gzip" Link to this property "deflate" Link to this property
Link to this property
Link to this property format: Literal\["json"] Specifies the format of data to deliver. Link to this property
path: ResultDestinationPath bucket: str Specifies the R2 Bucket to store files. Link to this property filename: Optional\[str] Specifies the name pattern to for individual data files. Link to this property filepath: Optional\[str] Specifies the name pattern for directory. Link to this property prefix: Optional\[str] Specifies the base directory within the bucket. Link to this property
Link to this property type: Literal\["r2"] Specifies the type of destination. Link to this property
Link to this property endpoint: str Indicates the endpoint URL to send traffic. Link to this property name: str Defines the name of the pipeline. maxLength128 minLength1 Link to this property
source: List\[ResultSource] One of the following:
class ResultSourceCloudflarePipelinesWorkersPipelinesHTTPSource: … \[DEPRECATED] HTTP source configuration. Use the new streams API instead. format: Literal\["json"] Specifies the format of source data. Link to this property type: str Link to this property authentication: Optional\[bool] Specifies whether authentication is required to send to this pipeline via HTTP. Link to this property
cors: Optional\[ResultSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS] origins: Optional\[List\[str]] Specifies allowed origins to allow Cross Origin HTTP Requests. Link to this property
Link to this property
Link to this property
class ResultSourceCloudflarePipelinesWorkersPipelinesBindingSource: … \[DEPRECATED] Worker binding source configuration. Use the new streams API instead. format: Literal\["json"] Specifies the format of source data. Link to this property type: str Link to this property
Link to this property
Link to this property version: float Indicates the version number of last saved configuration. Link to this property
Link to this property success: bool Indicates whether the API call was successful. Link to this property
[Link to this property](<#(resource)%20pipelines%20%3E%20(model)%20pipeline_list_response%20%3E%20(schema)>)
class PipelineGetResponse: … \[DEPRECATED] Describes the configuration of a pipeline. Use the new streams/sinks/pipelines API instead. id: str Specifies the pipeline identifier. Link to this property
destination: Destination
batch: DestinationBatch max\_bytes: int Specifies rough maximum size of files. maximum100000000 minimum1000 Link to this property max\_duration\_s: float Specifies duration to wait to aggregate batches files. maximum300 minimum0.25 Link to this property max\_rows: int Specifies rough maximum number of rows per file. maximum10000000 minimum100 Link to this property
Link to this property
compression: DestinationCompression
type: Literal\["none", "gzip", "deflate"] Specifies the desired compression algorithm and format. One of the following: "none" Link to this property "gzip" Link to this property "deflate" Link to this property
Link to this property
Link to this property format: Literal\["json"] Specifies the format of data to deliver. Link to this property
path: DestinationPath bucket: str Specifies the R2 Bucket to store files. Link to this property filename: Optional\[str] Specifies the name pattern to for individual data files. Link to this property filepath: Optional\[str] Specifies the name pattern for directory. Link to this property prefix: Optional\[str] Specifies the base directory within the bucket. Link to this property
Link to this property type: Literal\["r2"] Specifies the type of destination. Link to this property
Link to this property endpoint: str Indicates the endpoint URL to send traffic. Link to this property name: str Defines the name of the pipeline. maxLength128 minLength1 Link to this property
source: List\[Source] One of the following:
class SourceCloudflarePipelinesWorkersPipelinesHTTPSource: … \[DEPRECATED] HTTP source configuration. Use the new streams API instead. format: Literal\["json"] Specifies the format of source data. Link to this property type: str Link to this property authentication: Optional\[bool] Specifies whether authentication is required to send to this pipeline via HTTP. Link to this property
cors: Optional\[SourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS] origins: Optional\[List\[str]] Specifies allowed origins to allow Cross Origin HTTP Requests. Link to this property
Link to this property
Link to this property
class SourceCloudflarePipelinesWorkersPipelinesBindingSource: … \[DEPRECATED] Worker binding source configuration. Use the new streams API instead. format: Literal\["json"] Specifies the format of source data. Link to this property type: str Link to this property
Link to this property
Link to this property version: float Indicates the version number of last saved configuration. Link to this property
[Link to this property](<#(resource)%20pipelines%20%3E%20(model)%20pipeline_get_response%20%3E%20(schema)>)
class PipelineCreateResponse: … \[DEPRECATED] Describes the configuration of a pipeline. Use the new streams/sinks/pipelines API instead. id: str Specifies the pipeline identifier. Link to this property
destination: Destination
batch: DestinationBatch max\_bytes: int Specifies rough maximum size of files. maximum100000000 minimum1000 Link to this property max\_duration\_s: float Specifies duration to wait to aggregate batches files. maximum300 minimum0.25 Link to this property max\_rows: int Specifies rough maximum number of rows per file. maximum10000000 minimum100 Link to this property
Link to this property
compression: DestinationCompression
type: Literal\["none", "gzip", "deflate"] Specifies the desired compression algorithm and format. One of the following: "none" Link to this property "gzip" Link to this property "deflate" Link to this property
Link to this property
Link to this property format: Literal\["json"] Specifies the format of data to deliver. Link to this property
path: DestinationPath bucket: str Specifies the R2 Bucket to store files. Link to this property filename: Optional\[str] Specifies the name pattern to for individual data files. Link to this property filepath: Optional\[str] Specifies the name pattern for directory. Link to this property prefix: Optional\[str] Specifies the base directory within the bucket. Link to this property
Link to this property type: Literal\["r2"] Specifies the type of destination. Link to this property
Link to this property endpoint: str Indicates the endpoint URL to send traffic. Link to this property name: str Defines the name of the pipeline. maxLength128 minLength1 Link to this property
source: List\[Source] One of the following:
class SourceCloudflarePipelinesWorkersPipelinesHTTPSource: … \[DEPRECATED] HTTP source configuration. Use the new streams API instead. format: Literal\["json"] Specifies the format of source data. Link to this property type: str Link to this property authentication: Optional\[bool] Specifies whether authentication is required to send to this pipeline via HTTP. Link to this property
cors: Optional\[SourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS] origins: Optional\[List\[str]] Specifies allowed origins to allow Cross Origin HTTP Requests. Link to this property
Link to this property
Link to this property
class SourceCloudflarePipelinesWorkersPipelinesBindingSource: … \[DEPRECATED] Worker binding source configuration. Use the new streams API instead. format: Literal\["json"] Specifies the format of source data. Link to this property type: str Link to this property
Link to this property
Link to this property version: float Indicates the version number of last saved configuration. Link to this property
[Link to this property](<#(resource)%20pipelines%20%3E%20(model)%20pipeline_create_response%20%3E%20(schema)>)
class PipelineUpdateResponse: … \[DEPRECATED] Describes the configuration of a pipeline. Use the new streams/sinks/pipelines API instead. id: str Specifies the pipeline identifier. Link to this property
destination: Destination
batch: DestinationBatch max\_bytes: int Specifies rough maximum size of files. maximum100000000 minimum1000 Link to this property max\_duration\_s: float Specifies duration to wait to aggregate batches files. maximum300 minimum0.25 Link to this property max\_rows: int Specifies rough maximum number of rows per file. maximum10000000 minimum100 Link to this property
Link to this property
compression: DestinationCompression
type: Literal\["none", "gzip", "deflate"] Specifies the desired compression algorithm and format. One of the following: "none" Link to this property "gzip" Link to this property "deflate" Link to this property
Link to this property
Link to this property format: Literal\["json"] Specifies the format of data to deliver. Link to this property
path: DestinationPath bucket: str Specifies the R2 Bucket to store files. Link to this property filename: Optional\[str] Specifies the name pattern to for individual data files. Link to this property filepath: Optional\[str] Specifies the name pattern for directory. Link to this property prefix: Optional\[str] Specifies the base directory within the bucket. Link to this property
Link to this property type: Literal\["r2"] Specifies the type of destination. Link to this property
Link to this property endpoint: str Indicates the endpoint URL to send traffic. Link to this property name: str Defines the name of the pipeline. maxLength128 minLength1 Link to this property
source: List\[Source] One of the following:
class SourceCloudflarePipelinesWorkersPipelinesHTTPSource: … \[DEPRECATED] HTTP source configuration. Use the new streams API instead. format: Literal\["json"] Specifies the format of source data. Link to this property type: str Link to this property authentication: Optional\[bool] Specifies whether authentication is required to send to this pipeline via HTTP. Link to this property
cors: Optional\[SourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS] origins: Optional\[List\[str]] Specifies allowed origins to allow Cross Origin HTTP Requests. Link to this property
Link to this property
Link to this property
class SourceCloudflarePipelinesWorkersPipelinesBindingSource: … \[DEPRECATED] Worker binding source configuration. Use the new streams API instead. format: Literal\["json"] Specifies the format of source data. Link to this property type: str Link to this property
Link to this property
Link to this property version: float Indicates the version number of last saved configuration. Link to this property
[Link to this property](<#(resource)%20pipelines%20%3E%20(model)%20pipeline_update_response%20%3E%20(schema)>)
class PipelineListV1Response: … id: str Indicates a unique identifier for this pipeline. Link to this property created\_at: str Link to this property modified\_at: str Link to this property name: str Indicates the name of the Pipeline. maxLength128 minLength1 Link to this property sql: str Specifies SQL for the Pipeline processing flow. Link to this property status: str Indicates the current status of the Pipeline. Link to this property
[Link to this property](<#(resource)%20pipelines%20%3E%20(model)%20pipeline_list_v1_response%20%3E%20(schema)>)
class PipelineGetV1Response: … id: str Indicates a unique identifier for this pipeline. Link to this property created\_at: str Link to this property modified\_at: str Link to this property name: str Indicates the name of the Pipeline. maxLength128 minLength1 Link to this property sql: str Specifies SQL for the Pipeline processing flow. Link to this property status: str Indicates the current status of the Pipeline. Link to this property
tables: List\[Table] List of streams and sinks used by this pipeline. id: str Unique identifier for the connection (stream or sink). Link to this property latest: int Latest available version of the connection. Link to this property name: str Name of the connection. maxLength128 minLength1 Link to this property
type: Literal\["stream", "sink"] Type of the connection. One of the following: "stream" Link to this property "sink" Link to this property
Link to this property version: int Current version of the connection used by this pipeline. Link to this property
Link to this property failure\_reason: Optional\[str] Indicates the reason for the failure of the Pipeline. Link to this property
[Link to this property](<#(resource)%20pipelines%20%3E%20(model)%20pipeline_get_v1_response%20%3E%20(schema)>)
class PipelineCreateV1Response: … id: str Indicates a unique identifier for this pipeline. Link to this property created\_at: str Link to this property modified\_at: str Link to this property name: str Indicates the name of the Pipeline. maxLength128 minLength1 Link to this property sql: str Specifies SQL for the Pipeline processing flow. Link to this property status: str Indicates the current status of the Pipeline. Link to this property
[Link to this property](<#(resource)%20pipelines%20%3E%20(model)%20pipeline_create_v1_response%20%3E%20(schema)>)
class PipelineValidateSqlResponse: …
tables: Dict\[str, Tables] Indicates tables involved in the processing. id: str Link to this property name: str Link to this property type: str Link to this property version: float Link to this property
Link to this property
graph: Optional\[Graph] Indicates the processing flow to implement the SQL.
edges: List\[GraphEdge] dest\_id: int formatint32 minimum0 Link to this property edge\_type: str Link to this property key\_type: str Link to this property src\_id: int formatint32 minimum0 Link to this property value\_type: str Link to this property
Link to this property
nodes: List\[GraphNode] description: str Link to this property node\_id: int formatint32 minimum0 Link to this property operator: str Link to this property parallelism: int formatint32 minimum0 Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20pipelines%20%3E%20(model)%20pipeline_validate_sql_response%20%3E%20(schema)>) #### PipelinesSinks ##### [List Sinks](https://developers.cloudflare.com/api/python/resources/pipelines/subresources/sinks/methods/list) pipelines.sinks.list(SinkListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[SinkListResponse]()] GET/accounts/{account\_id}/pipelines/v1/sinks ##### [Get Sink Details](https://developers.cloudflare.com/api/python/resources/pipelines/subresources/sinks/methods/get) pipelines.sinks.get(strsink\_id, SinkGetParams\*\*kwargs) -> [SinkGetResponse]() GET/accounts/{account\_id}/pipelines/v1/sinks/{sink\_id} ##### [Create Sink](https://developers.cloudflare.com/api/python/resources/pipelines/subresources/sinks/methods/create) pipelines.sinks.create(SinkCreateParams\*\*kwargs) -> [SinkCreateResponse]() POST/accounts/{account\_id}/pipelines/v1/sinks ##### [Delete Sink](https://developers.cloudflare.com/api/python/resources/pipelines/subresources/sinks/methods/delete) pipelines.sinks.delete(strsink\_id, SinkDeleteParams\*\*kwargs) -> object DELETE/accounts/{account\_id}/pipelines/v1/sinks/{sink\_id} ##### ModelsExpand Collapse
class SinkListResponse: … id: str Indicates a unique identifier for this sink. Link to this property created\_at: datetime formatdate-time Link to this property modified\_at: datetime formatdate-time Link to this property name: str Defines the name of the Sink. maxLength128 minLength1 Link to this property
type: Literal\["r2", "r2\_data\_catalog", "basin\_catalog"] Specifies the type of sink. One of the following: "r2" Link to this property "r2\_data\_catalog" Link to this property "basin\_catalog" Link to this property
Link to this property
config: Optional\[Config] Defines the configuration of the R2 Sink. One of the following:
class ConfigCloudflarePipelinesR2TablePublic: … R2 Sink public configuration. account\_id: str Cloudflare Account ID for the bucket Link to this property bucket: str R2 Bucket to write to Link to this property
file\_naming: Optional\[ConfigCloudflarePipelinesR2TablePublicFileNaming] Controls filename prefix/suffix and strategy. prefix: Optional\[str] The prefix to use in file name. i.e prefix-.parquet Link to this property
strategy: Optional\[Literal\["serial", "uuid", "uuid\_v7", "ulid"]] Filename generation strategy. One of the following: "serial" Link to this property "uuid" Link to this property "uuid\_v7" Link to this property "ulid" Link to this property
Link to this property suffix: Optional\[str] This will overwrite the default file suffix. i.e .parquet, use with caution Link to this property
Link to this property jurisdiction: Optional\[str] Jurisdiction this bucket is hosted in Link to this property
partitioning: Optional\[ConfigCloudflarePipelinesR2TablePublicPartitioning] Data-layout partitioning for sinks. time\_pattern: Optional\[str] The pattern of the date string Link to this property
Link to this property path: Optional\[str] Subpath within the bucket to write to Link to this property
rolling\_policy: Optional\[ConfigCloudflarePipelinesR2TablePublicRollingPolicy] Rolling policy for file sinks (when & why to close a file and open a new one). file\_size\_bytes: Optional\[int] Files will be rolled after reaching this number of bytes formatuint64 minimum0 Link to this property inactivity\_seconds: Optional\[int] Number of seconds of inactivity to wait before rolling over to a new file formatuint64 minimum1 Link to this property interval\_seconds: Optional\[int] Number of seconds to wait before rolling over to a new file formatuint64 minimum1 Link to this property
Link to this property
Link to this property
class ConfigCloudflarePipelinesR2DataCatalogTablePublic: … R2 Data Catalog Sink public configuration. account\_id: str Cloudflare Account ID formaturi Link to this property bucket: str The R2 Bucket that hosts this catalog Link to this property table\_name: str Table name Link to this property namespace: Optional\[str] Table namespace Link to this property
rolling\_policy: Optional\[ConfigCloudflarePipelinesR2DataCatalogTablePublicRollingPolicy] Rolling policy for file sinks (when & why to close a file and open a new one). file\_size\_bytes: Optional\[int] Files will be rolled after reaching this number of bytes formatuint64 minimum0 Link to this property inactivity\_seconds: Optional\[int] Number of seconds of inactivity to wait before rolling over to a new file formatuint64 minimum1 Link to this property interval\_seconds: Optional\[int] Number of seconds to wait before rolling over to a new file formatuint64 minimum1 Link to this property
Link to this property
Link to this property
Link to this property
format: Optional\[Format] Defines the output data format of a sink. One of the following:
class FormatCloudflarePipelinesSinkJsonFormat: … type: Literal\["json"] Link to this property
compression: Optional\[Literal\["uncompressed", "gzip"]] Specifies the compression applied to JSON sink output. One of the following: "uncompressed" Link to this property "gzip" Link to this property
Link to this property
decimal\_encoding: Optional\[Literal\["number", "string", "bytes"]] One of the following: "number" Link to this property "string" Link to this property "bytes" Link to this property
Link to this property
timestamp\_format: Optional\[Literal\["rfc3339", "unix\_millis"]] One of the following: "rfc3339" Link to this property "unix\_millis" Link to this property
Link to this property unstructured: Optional\[bool] Link to this property
Link to this property
class FormatCloudflarePipelinesSinkParquetFormat: … type: Literal\["parquet"] Link to this property
compression: Optional\[Literal\["uncompressed", "snappy", "gzip", 2 more]] One of the following: "uncompressed" Link to this property "snappy" Link to this property "gzip" Link to this property "zstd" Link to this property "lz4" Link to this property
Link to this property row\_group\_bytes: Optional\[int] formatint64 minimum0 Link to this property
Link to this property
Link to this property
schema: Optional\[Schema] Defines the schema of the events in the data stream.
fields: Optional\[List\[SourceField]] One of the following:
class Int32: … type: Literal\["int32"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Int64: … type: Literal\["int64"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Float32: … type: Literal\["float32"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Float64: … type: Literal\["float64"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Bool: … type: Literal\["bool"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class String: … type: Literal\["string"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Binary: … type: Literal\["binary"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Timestamp: … type: Literal\["timestamp"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
unit: Optional\[Literal\["second", "millisecond", "microsecond", "nanosecond"]] One of the following: "second" Link to this property "millisecond" Link to this property "microsecond" Link to this property "nanosecond" Link to this property
Link to this property
Link to this property
class Json: … type: Literal\["json"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Struct: … type: Literal\["struct"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class List: … type: Literal\["list"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
Link to this property inferred: Optional\[bool] Link to this property
Link to this property
[Link to this property](<#(resource)%20pipelines.sinks%20%3E%20(model)%20sink_list_response%20%3E%20(schema)>)
class SinkGetResponse: … id: str Indicates a unique identifier for this sink. Link to this property created\_at: datetime formatdate-time Link to this property modified\_at: datetime formatdate-time Link to this property name: str Defines the name of the Sink. maxLength128 minLength1 Link to this property
type: Literal\["r2", "r2\_data\_catalog", "basin\_catalog"] Specifies the type of sink. One of the following: "r2" Link to this property "r2\_data\_catalog" Link to this property "basin\_catalog" Link to this property
Link to this property
config: Optional\[Config] Defines the configuration of the R2 Sink. One of the following:
class ConfigCloudflarePipelinesR2TablePublic: … R2 Sink public configuration. account\_id: str Cloudflare Account ID for the bucket Link to this property bucket: str R2 Bucket to write to Link to this property
file\_naming: Optional\[ConfigCloudflarePipelinesR2TablePublicFileNaming] Controls filename prefix/suffix and strategy. prefix: Optional\[str] The prefix to use in file name. i.e prefix-.parquet Link to this property
strategy: Optional\[Literal\["serial", "uuid", "uuid\_v7", "ulid"]] Filename generation strategy. One of the following: "serial" Link to this property "uuid" Link to this property "uuid\_v7" Link to this property "ulid" Link to this property
Link to this property suffix: Optional\[str] This will overwrite the default file suffix. i.e .parquet, use with caution Link to this property
Link to this property jurisdiction: Optional\[str] Jurisdiction this bucket is hosted in Link to this property
partitioning: Optional\[ConfigCloudflarePipelinesR2TablePublicPartitioning] Data-layout partitioning for sinks. time\_pattern: Optional\[str] The pattern of the date string Link to this property
Link to this property path: Optional\[str] Subpath within the bucket to write to Link to this property
rolling\_policy: Optional\[ConfigCloudflarePipelinesR2TablePublicRollingPolicy] Rolling policy for file sinks (when & why to close a file and open a new one). file\_size\_bytes: Optional\[int] Files will be rolled after reaching this number of bytes formatuint64 minimum0 Link to this property inactivity\_seconds: Optional\[int] Number of seconds of inactivity to wait before rolling over to a new file formatuint64 minimum1 Link to this property interval\_seconds: Optional\[int] Number of seconds to wait before rolling over to a new file formatuint64 minimum1 Link to this property
Link to this property
Link to this property
class ConfigCloudflarePipelinesR2DataCatalogTablePublic: … R2 Data Catalog Sink public configuration. account\_id: str Cloudflare Account ID formaturi Link to this property bucket: str The R2 Bucket that hosts this catalog Link to this property table\_name: str Table name Link to this property namespace: Optional\[str] Table namespace Link to this property
rolling\_policy: Optional\[ConfigCloudflarePipelinesR2DataCatalogTablePublicRollingPolicy] Rolling policy for file sinks (when & why to close a file and open a new one). file\_size\_bytes: Optional\[int] Files will be rolled after reaching this number of bytes formatuint64 minimum0 Link to this property inactivity\_seconds: Optional\[int] Number of seconds of inactivity to wait before rolling over to a new file formatuint64 minimum1 Link to this property interval\_seconds: Optional\[int] Number of seconds to wait before rolling over to a new file formatuint64 minimum1 Link to this property
Link to this property
Link to this property
Link to this property
format: Optional\[Format] Defines the output data format of a sink. One of the following:
class FormatCloudflarePipelinesSinkJsonFormat: … type: Literal\["json"] Link to this property
compression: Optional\[Literal\["uncompressed", "gzip"]] Specifies the compression applied to JSON sink output. One of the following: "uncompressed" Link to this property "gzip" Link to this property
Link to this property
decimal\_encoding: Optional\[Literal\["number", "string", "bytes"]] One of the following: "number" Link to this property "string" Link to this property "bytes" Link to this property
Link to this property
timestamp\_format: Optional\[Literal\["rfc3339", "unix\_millis"]] One of the following: "rfc3339" Link to this property "unix\_millis" Link to this property
Link to this property unstructured: Optional\[bool] Link to this property
Link to this property
class FormatCloudflarePipelinesSinkParquetFormat: … type: Literal\["parquet"] Link to this property
compression: Optional\[Literal\["uncompressed", "snappy", "gzip", 2 more]] One of the following: "uncompressed" Link to this property "snappy" Link to this property "gzip" Link to this property "zstd" Link to this property "lz4" Link to this property
Link to this property row\_group\_bytes: Optional\[int] formatint64 minimum0 Link to this property
Link to this property
Link to this property
schema: Optional\[Schema] Defines the schema of the events in the data stream.
fields: Optional\[List\[SourceField]] One of the following:
class Int32: … type: Literal\["int32"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Int64: … type: Literal\["int64"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Float32: … type: Literal\["float32"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Float64: … type: Literal\["float64"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Bool: … type: Literal\["bool"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class String: … type: Literal\["string"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Binary: … type: Literal\["binary"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Timestamp: … type: Literal\["timestamp"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
unit: Optional\[Literal\["second", "millisecond", "microsecond", "nanosecond"]] One of the following: "second" Link to this property "millisecond" Link to this property "microsecond" Link to this property "nanosecond" Link to this property
Link to this property
Link to this property
class Json: … type: Literal\["json"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Struct: … type: Literal\["struct"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class List: … type: Literal\["list"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
Link to this property inferred: Optional\[bool] Link to this property
Link to this property
[Link to this property](<#(resource)%20pipelines.sinks%20%3E%20(model)%20sink_get_response%20%3E%20(schema)>)
class SinkCreateResponse: … id: str Indicates a unique identifier for this sink. Link to this property created\_at: datetime formatdate-time Link to this property modified\_at: datetime formatdate-time Link to this property name: str Defines the name of the Sink. maxLength128 minLength1 Link to this property
type: Literal\["r2", "r2\_data\_catalog", "basin\_catalog"] Specifies the type of sink. One of the following: "r2" Link to this property "r2\_data\_catalog" Link to this property "basin\_catalog" Link to this property
Link to this property
config: Optional\[Config] R2 Data Catalog Sink One of the following:
class ConfigCloudflarePipelinesR2Table: … account\_id: str Cloudflare Account ID for the bucket Link to this property bucket: str R2 Bucket to write to Link to this property
credentials: ConfigCloudflarePipelinesR2TableCredentials access\_key\_id: str Cloudflare Account ID for the bucket formatvar-str Link to this property secret\_access\_key: str Cloudflare Account ID for the bucket formatvar-str Link to this property
Link to this property
file\_naming: Optional\[ConfigCloudflarePipelinesR2TableFileNaming] Controls filename prefix/suffix and strategy. prefix: Optional\[str] The prefix to use in file name. i.e prefix-.parquet Link to this property
strategy: Optional\[Literal\["serial", "uuid", "uuid\_v7", "ulid"]] Filename generation strategy. One of the following: "serial" Link to this property "uuid" Link to this property "uuid\_v7" Link to this property "ulid" Link to this property
Link to this property suffix: Optional\[str] This will overwrite the default file suffix. i.e .parquet, use with caution Link to this property
Link to this property jurisdiction: Optional\[str] Jurisdiction this bucket is hosted in Link to this property
partitioning: Optional\[ConfigCloudflarePipelinesR2TablePartitioning] Data-layout partitioning for sinks. time\_pattern: Optional\[str] The pattern of the date string Link to this property
Link to this property path: Optional\[str] Subpath within the bucket to write to Link to this property
rolling\_policy: Optional\[ConfigCloudflarePipelinesR2TableRollingPolicy] Rolling policy for file sinks (when & why to close a file and open a new one). file\_size\_bytes: Optional\[int] Files will be rolled after reaching this number of bytes formatuint64 minimum0 Link to this property inactivity\_seconds: Optional\[int] Number of seconds of inactivity to wait before rolling over to a new file formatuint64 minimum1 Link to this property interval\_seconds: Optional\[int] Number of seconds to wait before rolling over to a new file formatuint64 minimum1 Link to this property
Link to this property
Link to this property
class ConfigCloudflarePipelinesR2DataCatalogTable: … R2 Data Catalog Sink token: str Authentication token formatvar-str Link to this property account\_id: str Cloudflare Account ID formaturi Link to this property bucket: str The R2 Bucket that hosts this catalog Link to this property table\_name: str Table name Link to this property namespace: Optional\[str] Table namespace Link to this property
rolling\_policy: Optional\[ConfigCloudflarePipelinesR2DataCatalogTableRollingPolicy] Rolling policy for file sinks (when & why to close a file and open a new one). file\_size\_bytes: Optional\[int] Files will be rolled after reaching this number of bytes formatuint64 minimum0 Link to this property inactivity\_seconds: Optional\[int] Number of seconds of inactivity to wait before rolling over to a new file formatuint64 minimum1 Link to this property interval\_seconds: Optional\[int] Number of seconds to wait before rolling over to a new file formatuint64 minimum1 Link to this property
Link to this property
Link to this property
Link to this property
format: Optional\[Format] Defines the output data format of a sink. One of the following:
class FormatCloudflarePipelinesSinkJsonFormat: … type: Literal\["json"] Link to this property
compression: Optional\[Literal\["uncompressed", "gzip"]] Specifies the compression applied to JSON sink output. One of the following: "uncompressed" Link to this property "gzip" Link to this property
Link to this property
decimal\_encoding: Optional\[Literal\["number", "string", "bytes"]] One of the following: "number" Link to this property "string" Link to this property "bytes" Link to this property
Link to this property
timestamp\_format: Optional\[Literal\["rfc3339", "unix\_millis"]] One of the following: "rfc3339" Link to this property "unix\_millis" Link to this property
Link to this property unstructured: Optional\[bool] Link to this property
Link to this property
class FormatCloudflarePipelinesSinkParquetFormat: … type: Literal\["parquet"] Link to this property
compression: Optional\[Literal\["uncompressed", "snappy", "gzip", 2 more]] One of the following: "uncompressed" Link to this property "snappy" Link to this property "gzip" Link to this property "zstd" Link to this property "lz4" Link to this property
Link to this property row\_group\_bytes: Optional\[int] formatint64 minimum0 Link to this property
Link to this property
Link to this property
schema: Optional\[Schema] Defines the schema of the events in the data stream.
fields: Optional\[List\[SourceField]] One of the following:
class Int32: … type: Literal\["int32"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Int64: … type: Literal\["int64"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Float32: … type: Literal\["float32"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Float64: … type: Literal\["float64"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Bool: … type: Literal\["bool"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class String: … type: Literal\["string"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Binary: … type: Literal\["binary"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Timestamp: … type: Literal\["timestamp"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
unit: Optional\[Literal\["second", "millisecond", "microsecond", "nanosecond"]] One of the following: "second" Link to this property "millisecond" Link to this property "microsecond" Link to this property "nanosecond" Link to this property
Link to this property
Link to this property
class Json: … type: Literal\["json"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Struct: … type: Literal\["struct"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class List: … type: Literal\["list"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
Link to this property inferred: Optional\[bool] Link to this property
Link to this property
[Link to this property](<#(resource)%20pipelines.sinks%20%3E%20(model)%20sink_create_response%20%3E%20(schema)>) #### PipelinesStreams ##### [List Streams](https://developers.cloudflare.com/api/python/resources/pipelines/subresources/streams/methods/list) pipelines.streams.list(StreamListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[StreamListResponse]()] GET/accounts/{account\_id}/pipelines/v1/streams ##### [Get Stream Details](https://developers.cloudflare.com/api/python/resources/pipelines/subresources/streams/methods/get) pipelines.streams.get(strstream\_id, StreamGetParams\*\*kwargs) -> [StreamGetResponse]() GET/accounts/{account\_id}/pipelines/v1/streams/{stream\_id} ##### [Create Stream](https://developers.cloudflare.com/api/python/resources/pipelines/subresources/streams/methods/create) pipelines.streams.create(StreamCreateParams\*\*kwargs) -> [StreamCreateResponse]() POST/accounts/{account\_id}/pipelines/v1/streams ##### [Update Stream](https://developers.cloudflare.com/api/python/resources/pipelines/subresources/streams/methods/update) pipelines.streams.update(strstream\_id, StreamUpdateParams\*\*kwargs) -> [StreamUpdateResponse]() PATCH/accounts/{account\_id}/pipelines/v1/streams/{stream\_id} ##### [Delete Stream](https://developers.cloudflare.com/api/python/resources/pipelines/subresources/streams/methods/delete) pipelines.streams.delete(strstream\_id, StreamDeleteParams\*\*kwargs) -> object DELETE/accounts/{account\_id}/pipelines/v1/streams/{stream\_id} ##### ModelsExpand Collapse
class StreamListResponse: … id: str Indicates a unique identifier for this stream. Link to this property created\_at: datetime formatdate-time Link to this property
http: HTTP authentication: bool Indicates that authentication is required for the HTTP endpoint. Link to this property enabled: bool Indicates that the HTTP endpoint is enabled. Link to this property
cors: Optional\[HTTPCORS] Specifies the CORS options for the HTTP endpoint. origins: Optional\[List\[str]] Link to this property
Link to this property
Link to this property modified\_at: datetime formatdate-time Link to this property name: str Indicates the name of the Stream. maxLength128 minLength1 Link to this property version: int Indicates the current version of this stream. Link to this property
worker\_binding: WorkerBinding enabled: bool Indicates that the worker binding is enabled. Link to this property
Link to this property endpoint: Optional\[str] Indicates the endpoint URL of this stream. formaturi Link to this property
format: Optional\[Format] Defines the data format of the events. One of the following:
class FormatJson: … type: Literal\["json"] Link to this property
decimal\_encoding: Optional\[Literal\["number", "string", "bytes"]] One of the following: "number" Link to this property "string" Link to this property "bytes" Link to this property
Link to this property
timestamp\_format: Optional\[Literal\["rfc3339", "unix\_millis"]] One of the following: "rfc3339" Link to this property "unix\_millis" Link to this property
Link to this property unstructured: Optional\[bool] Link to this property
Link to this property
class FormatParquet: … type: Literal\["parquet"] Link to this property
compression: Optional\[Literal\["uncompressed", "snappy", "gzip", 2 more]] One of the following: "uncompressed" Link to this property "snappy" Link to this property "gzip" Link to this property "zstd" Link to this property "lz4" Link to this property
Link to this property row\_group\_bytes: Optional\[int] formatint64 minimum0 Link to this property
Link to this property
Link to this property
schema: Optional\[Schema] Defines the schema of the events in the data stream.
fields: Optional\[List\[SourceField]] One of the following:
class Int32: … type: Literal\["int32"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Int64: … type: Literal\["int64"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Float32: … type: Literal\["float32"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Float64: … type: Literal\["float64"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Bool: … type: Literal\["bool"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class String: … type: Literal\["string"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Binary: … type: Literal\["binary"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Timestamp: … type: Literal\["timestamp"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
unit: Optional\[Literal\["second", "millisecond", "microsecond", "nanosecond"]] One of the following: "second" Link to this property "millisecond" Link to this property "microsecond" Link to this property "nanosecond" Link to this property
Link to this property
Link to this property
class Json: … type: Literal\["json"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Struct: … type: Literal\["struct"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class List: … type: Literal\["list"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
Link to this property inferred: Optional\[bool] Link to this property
Link to this property
[Link to this property](<#(resource)%20pipelines.streams%20%3E%20(model)%20stream_list_response%20%3E%20(schema)>)
class StreamGetResponse: … id: str Indicates a unique identifier for this stream. Link to this property created\_at: datetime formatdate-time Link to this property
http: HTTP authentication: bool Indicates that authentication is required for the HTTP endpoint. Link to this property enabled: bool Indicates that the HTTP endpoint is enabled. Link to this property
cors: Optional\[HTTPCORS] Specifies the CORS options for the HTTP endpoint. origins: Optional\[List\[str]] Link to this property
Link to this property
Link to this property modified\_at: datetime formatdate-time Link to this property name: str Indicates the name of the Stream. maxLength128 minLength1 Link to this property version: int Indicates the current version of this stream. Link to this property
worker\_binding: WorkerBinding enabled: bool Indicates that the worker binding is enabled. Link to this property
Link to this property endpoint: Optional\[str] Indicates the endpoint URL of this stream. formaturi Link to this property
format: Optional\[Format] Defines the data format of the events. One of the following:
class FormatJson: … type: Literal\["json"] Link to this property
decimal\_encoding: Optional\[Literal\["number", "string", "bytes"]] One of the following: "number" Link to this property "string" Link to this property "bytes" Link to this property
Link to this property
timestamp\_format: Optional\[Literal\["rfc3339", "unix\_millis"]] One of the following: "rfc3339" Link to this property "unix\_millis" Link to this property
Link to this property unstructured: Optional\[bool] Link to this property
Link to this property
class FormatParquet: … type: Literal\["parquet"] Link to this property
compression: Optional\[Literal\["uncompressed", "snappy", "gzip", 2 more]] One of the following: "uncompressed" Link to this property "snappy" Link to this property "gzip" Link to this property "zstd" Link to this property "lz4" Link to this property
Link to this property row\_group\_bytes: Optional\[int] formatint64 minimum0 Link to this property
Link to this property
Link to this property
schema: Optional\[Schema] Defines the schema of the events in the data stream.
fields: Optional\[List\[SourceField]] One of the following:
class Int32: … type: Literal\["int32"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Int64: … type: Literal\["int64"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Float32: … type: Literal\["float32"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Float64: … type: Literal\["float64"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Bool: … type: Literal\["bool"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class String: … type: Literal\["string"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Binary: … type: Literal\["binary"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Timestamp: … type: Literal\["timestamp"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
unit: Optional\[Literal\["second", "millisecond", "microsecond", "nanosecond"]] One of the following: "second" Link to this property "millisecond" Link to this property "microsecond" Link to this property "nanosecond" Link to this property
Link to this property
Link to this property
class Json: … type: Literal\["json"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Struct: … type: Literal\["struct"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class List: … type: Literal\["list"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
Link to this property inferred: Optional\[bool] Link to this property
Link to this property
[Link to this property](<#(resource)%20pipelines.streams%20%3E%20(model)%20stream_get_response%20%3E%20(schema)>)
class StreamCreateResponse: … id: str Indicates a unique identifier for this stream. Link to this property created\_at: datetime formatdate-time Link to this property
http: HTTP authentication: bool Indicates that authentication is required for the HTTP endpoint. Link to this property enabled: bool Indicates that the HTTP endpoint is enabled. Link to this property
cors: Optional\[HTTPCORS] Specifies the CORS options for the HTTP endpoint. origins: Optional\[List\[str]] Link to this property
Link to this property
Link to this property modified\_at: datetime formatdate-time Link to this property name: str Indicates the name of the Stream. maxLength128 minLength1 Link to this property version: int Indicates the current version of this stream. Link to this property
worker\_binding: WorkerBinding enabled: bool Indicates that the worker binding is enabled. Link to this property
Link to this property endpoint: Optional\[str] Indicates the endpoint URL of this stream. formaturi Link to this property
format: Optional\[Format] Defines the data format of the events. One of the following:
class FormatJson: … type: Literal\["json"] Link to this property
decimal\_encoding: Optional\[Literal\["number", "string", "bytes"]] One of the following: "number" Link to this property "string" Link to this property "bytes" Link to this property
Link to this property
timestamp\_format: Optional\[Literal\["rfc3339", "unix\_millis"]] One of the following: "rfc3339" Link to this property "unix\_millis" Link to this property
Link to this property unstructured: Optional\[bool] Link to this property
Link to this property
class FormatParquet: … type: Literal\["parquet"] Link to this property
compression: Optional\[Literal\["uncompressed", "snappy", "gzip", 2 more]] One of the following: "uncompressed" Link to this property "snappy" Link to this property "gzip" Link to this property "zstd" Link to this property "lz4" Link to this property
Link to this property row\_group\_bytes: Optional\[int] formatint64 minimum0 Link to this property
Link to this property
Link to this property
schema: Optional\[Schema] Defines the schema of the events in the data stream.
fields: Optional\[List\[SourceField]] One of the following:
class Int32: … type: Literal\["int32"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Int64: … type: Literal\["int64"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Float32: … type: Literal\["float32"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Float64: … type: Literal\["float64"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Bool: … type: Literal\["bool"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class String: … type: Literal\["string"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Binary: … type: Literal\["binary"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Timestamp: … type: Literal\["timestamp"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
unit: Optional\[Literal\["second", "millisecond", "microsecond", "nanosecond"]] One of the following: "second" Link to this property "millisecond" Link to this property "microsecond" Link to this property "nanosecond" Link to this property
Link to this property
Link to this property
class Json: … type: Literal\["json"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Struct: … type: Literal\["struct"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class List: … type: Literal\["list"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
Link to this property inferred: Optional\[bool] Link to this property
Link to this property
[Link to this property](<#(resource)%20pipelines.streams%20%3E%20(model)%20stream_create_response%20%3E%20(schema)>)
class StreamUpdateResponse: … id: str Indicates a unique identifier for this stream. Link to this property created\_at: datetime formatdate-time Link to this property
http: HTTP authentication: bool Indicates that authentication is required for the HTTP endpoint. Link to this property enabled: bool Indicates that the HTTP endpoint is enabled. Link to this property
cors: Optional\[HTTPCORS] Specifies the CORS options for the HTTP endpoint. origins: Optional\[List\[str]] Link to this property
Link to this property
Link to this property modified\_at: datetime formatdate-time Link to this property name: str Indicates the name of the Stream. maxLength128 minLength1 Link to this property version: int Indicates the current version of this stream. Link to this property
worker\_binding: WorkerBinding enabled: bool Indicates that the worker binding is enabled. Link to this property
Link to this property endpoint: Optional\[str] Indicates the endpoint URL of this stream. formaturi Link to this property
format: Optional\[Format] Defines the data format of the events. One of the following:
class FormatJson: … type: Literal\["json"] Link to this property
decimal\_encoding: Optional\[Literal\["number", "string", "bytes"]] One of the following: "number" Link to this property "string" Link to this property "bytes" Link to this property
Link to this property
timestamp\_format: Optional\[Literal\["rfc3339", "unix\_millis"]] One of the following: "rfc3339" Link to this property "unix\_millis" Link to this property
Link to this property unstructured: Optional\[bool] Link to this property
Link to this property
class FormatParquet: … type: Literal\["parquet"] Link to this property
compression: Optional\[Literal\["uncompressed", "snappy", "gzip", 2 more]] One of the following: "uncompressed" Link to this property "snappy" Link to this property "gzip" Link to this property "zstd" Link to this property "lz4" Link to this property
Link to this property row\_group\_bytes: Optional\[int] formatint64 minimum0 Link to this property
Link to this property
Link to this property
schema: Optional\[Schema] Defines the schema of the events in the data stream.
fields: Optional\[List\[SourceField]] One of the following:
class Int32: … type: Literal\["int32"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Int64: … type: Literal\["int64"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Float32: … type: Literal\["float32"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Float64: … type: Literal\["float64"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Bool: … type: Literal\["bool"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class String: … type: Literal\["string"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Binary: … type: Literal\["binary"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Timestamp: … type: Literal\["timestamp"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
unit: Optional\[Literal\["second", "millisecond", "microsecond", "nanosecond"]] One of the following: "second" Link to this property "millisecond" Link to this property "microsecond" Link to this property "nanosecond" Link to this property
Link to this property
Link to this property
class Json: … type: Literal\["json"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Struct: … type: Literal\["struct"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class List: … type: Literal\["list"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
Link to this property inferred: Optional\[bool] Link to this property
Link to this property
[Link to this property](<#(resource)%20pipelines.streams%20%3E%20(model)%20stream_update_response%20%3E%20(schema)>)