Struct OpenFlow 

pub struct OpenFlow {
    pub summary: String,
    pub description: Option<String>,
    pub value: Box<FlowValue>,
    pub schema: Option<Value>,
    pub on_behalf_of_email: Option<String>,
    pub on_behalf_of: Option<String>,
}

OpenFlow : Top-level flow definition containing metadata, configuration, and the flow structure

Fields

summary: String

Short description of what this flow does

description: Option<String>

Detailed documentation for this flow

value: Box<FlowValue>

schema: Option<Value>

JSON Schema for flow inputs. Use this to define input parameters, their types, defaults, and validation. For resource inputs, set type to ‘object’ and format to ‘resource-’ (e.g., ‘resource-stripe’)

on_behalf_of_email: Option<String>

Address of the account the flow runs on behalf of. Derived from on_behalf_of on read; accepted on write, where it is resolved to the account it names.

on_behalf_of: Option<String>

The flow runs with the permissions of this identity: u/{username}, g/{group}, or a bare email when the username is itself email-shaped. The only stored half of the identity; on_behalf_of_email is derived from it. Omit it when writing and it is resolved from that address instead.

Implementations

impl OpenFlow

pub fn new(summary: String, value: FlowValue) -> OpenFlow

Top-level flow definition containing metadata, configuration, and the flow structure

Trait Implementations

impl Clone for OpenFlow

fn clone(&self) -> OpenFlow

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenFlow

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

Formats the value using the given formatter.

impl Default for OpenFlow

fn default() -> OpenFlow

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OpenFlow

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for OpenFlow

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for OpenFlow

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for OpenFlow