Struct PipelineConfig 

pub struct PipelineConfig {
    pub global: RuntimeConfig,
    pub multihost: Option<MultihostConfig>,
    pub name: Option<String>,
    pub given_name: Option<String>,
    pub storage_config: Option<StorageConfig>,
    pub secrets_dir: Option<String>,
    pub inputs: BTreeMap<Cow<'static, str>, InputEndpointConfig>,
    pub outputs: BTreeMap<Cow<'static, str>, OutputEndpointConfig>,
    pub program_ir: Option<ProgramIr>,
}

Pipeline deployment configuration. It represents configuration entries directly provided by the user (e.g., runtime configuration) and entries derived from the schema of the compiled program (e.g., connectors). Storage configuration, if applicable, is set by the runner.

Fields

global: RuntimeConfig

Global controller configuration.

multihost: Option<MultihostConfig>

Configuration for multihost pipelines.

The presence of this field indicates that the pipeline is running in multihost mode. In the pod with ordinal 0, this triggers starting the coordinator process. In all pods, this tells the pipeline process to await a connection from the coordinator instead of initializing the pipeline immediately.

name: Option<String>

Unique system-generated name of the pipeline (format: pipeline-<uuid>). It is unique across all tenants and cannot be changed.

The <uuid> is also used in the naming of various resources that back the pipeline, and as such this name is useful to find/identify corresponding resources.

given_name: Option<String>

Name given by the tenant to the pipeline. It is only unique within the same tenant, and can be changed by the tenant when the pipeline is stopped.

Given a specific tenant, it can be used to find/identify a specific pipeline of theirs.

storage_config: Option<StorageConfig>

Configuration for persistent storage

If global.storage is Some(_), this field must be set to some StorageConfig. If global.storage is `None``, the pipeline ignores this field.

secrets_dir: Option<String>

Directory containing values of secrets.

If this is not set, a default directory is used.

inputs: BTreeMap<Cow<'static, str>, InputEndpointConfig>

Input endpoint configuration.

outputs: BTreeMap<Cow<'static, str>, OutputEndpointConfig>

Output endpoint configuration.

program_ir: Option<ProgramIr>

Program information.

Implementations

impl PipelineConfig

pub fn max_parallel_connector_init(&self) -> u64

pub fn with_storage( self, storage: Option<(StorageConfig, StorageOptions)>, ) -> Self

pub fn storage(&self) -> Option<(&StorageConfig, &StorageOptions)>

pub fn secrets_dir(&self) -> &Path

Returns self.secrets_dir, or the default secrets directory if it isn’t set.

pub fn display_summary(&self) -> String

Abbreviated config that can be printed in the log on pipeline startup.

Trait Implementations

impl Clone for PipelineConfig

fn clone(&self) -> PipelineConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PipelineConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PipelineConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PipelineConfig

fn eq(&self, other: &PipelineConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for PipelineConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'__s> ToSchema<'__s> for PipelineConfig

fn schema() -> (&'__s str, RefOr<Schema>)

Return a tuple of name and schema or reference to a schema that can be referenced by the name or inlined directly to responses, request bodies or parameters.

fn aliases() -> Vec<(&'__s str, Schema)>

Optional set of alias schemas for the ToSchema::schema.

impl StructuralPartialEq for PipelineConfig