Struct StartFlowExecutionInput

#[non_exhaustive]
pub struct StartFlowExecutionInput {
    pub flow_identifier: Option<String>,
    pub flow_alias_identifier: Option<String>,
    pub flow_execution_name: Option<String>,
    pub inputs: Option<Vec<FlowInput>>,
    pub model_performance_configuration: Option<ModelPerformanceConfiguration>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

flow_identifier: Option<String>

The unique identifier of the flow to execute.

flow_alias_identifier: Option<String>

The unique identifier of the flow alias to use for the flow execution.

flow_execution_name: Option<String>

The unique name for the flow execution. If you don't provide one, a system-generated name is used.

inputs: Option<Vec<FlowInput>>

The input data required for the flow execution. This must match the input schema defined in the flow.

model_performance_configuration: Option<ModelPerformanceConfiguration>

The performance settings for the foundation model used in the flow execution.

Implementations

impl StartFlowExecutionInput

pub fn flow_identifier(&self) -> Option<&str>

The unique identifier of the flow to execute.

pub fn flow_alias_identifier(&self) -> Option<&str>

The unique identifier of the flow alias to use for the flow execution.

pub fn flow_execution_name(&self) -> Option<&str>

The unique name for the flow execution. If you don't provide one, a system-generated name is used.

pub fn inputs(&self) -> &[FlowInput]

The input data required for the flow execution. This must match the input schema defined in the flow.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .inputs.is_none().

pub fn model_performance_configuration( &self, ) -> Option<&ModelPerformanceConfiguration>

The performance settings for the foundation model used in the flow execution.

impl StartFlowExecutionInput

pub fn builder() -> StartFlowExecutionInputBuilder

Creates a new builder-style object to manufacture StartFlowExecutionInput.

Trait Implementations

impl Clone for StartFlowExecutionInput

fn clone(&self) -> StartFlowExecutionInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StartFlowExecutionInput

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

Formats the value using the given formatter.

impl PartialEq for StartFlowExecutionInput

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

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

const 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 StructuralPartialEq for StartFlowExecutionInput