Struct CreateStreamParams 

pub struct CreateStreamParams {

    pub name: String,
    pub region: StreamRegion,
    pub network: String,
    pub dataset: StreamDataset,
    pub start_range: i64,
    pub end_range: i64,
    pub destination_attributes: DestinationAttributes,
    pub plan: Option<String>,
    pub threshold_fetch_buffer: Option<i64>,
    pub dataset_batch_size: i64,
    pub max_batch_size: Option<i64>,
    pub max_buffer_range_size: Option<i64>,
    pub max_buffer_processing_workers: Option<i64>,
    pub keep_distance_from_tip: Option<i64>,
    pub filter_function: Option<String>,
    pub filter_language: Option<FilterLanguage>,
    pub address_book_config: Option<AddressBookConfig>,
    pub include_stream_metadata: Option<StreamMetadataLocation>,
    pub product_type: Option<ProductType>,
    pub status: Option<StreamStatus>,
    pub notification_email: Option<String>,
    pub charge_min_cap: Option<i32>,
    pub fix_block_reorgs: Option<i32>,
    pub elastic_batch_enabled: bool,
    pub extra_destinations: Option<Vec<DestinationAttributes>>,
}

Parameters for creating a new stream.

Fields

name: String

Human-readable label identifying the stream.

region: StreamRegion

Geographic region where the stream runs.

network: String

Blockchain network to stream from (e.g. ethereum-mainnet).

dataset: StreamDataset

Type of on-chain data to stream.

start_range: i64

Block number to begin streaming from.

end_range: i64

Block number to stop streaming at; -1 for continuous operation.

destination_attributes: DestinationAttributes

Destination-specific configuration (webhook URL, S3 bucket, DB credentials, etc.).

plan: Option<String>

Billing plan associated with the stream. Optional; the server applies the account default when omitted.

threshold_fetch_buffer: Option<i64>

Buffer size used by the stream fetcher before delivery. Optional; the server applies its default when omitted.

dataset_batch_size: i64

Number of blocks grouped together per delivered batch. Required by the API.

max_batch_size: Option<i64>

Upper bound on batch size when elastic batching is enabled.

max_buffer_range_size: Option<i64>

Maximum number of buffered blocks waiting to be processed.

max_buffer_processing_workers: Option<i64>

Maximum number of worker threads processing buffered batches.

keep_distance_from_tip: Option<i64>

Number of blocks to stay behind the chain tip to reduce exposure to reorgs.

filter_function: Option<String>

Base64-encoded filter function applied to each batch before delivery.

filter_language: Option<FilterLanguage>

Language the filter function is written in.

address_book_config: Option<AddressBookConfig>

Optional address book to evaluate the filter against.

include_stream_metadata: Option<StreamMetadataLocation>

Where to include stream metadata in delivered payloads.

product_type: Option<ProductType>

Billing product type the stream is associated with.

status: Option<StreamStatus>

Initial stream state (active or paused). Defaults to active when omitted.

notification_email: Option<String>

Email address that receives stream termination or failure alerts.

charge_min_cap: Option<i32>

Minimum charge cap applied to the stream’s billing.

fix_block_reorgs: Option<i32>

Flag (0 or 1) enabling automatic re-streaming of blocks affected by chain reorganizations.

elastic_batch_enabled: bool

When enabled, batch size is reduced toward 1 as the stream catches up to the chain tip. Required by the API.

extra_destinations: Option<Vec<DestinationAttributes>>

Additional destinations that receive the same batches alongside the primary.

Trait Implementations

impl Clone for CreateStreamParams

fn clone(&self) -> CreateStreamParams

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateStreamParams

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CreateStreamParams

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CreateStreamParams

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.