Struct FlowInvocation 

#[non_exhaustive]
pub struct FlowInvocation {
    pub flow: String,
    pub display_name: String,
    pub flow_state: OutputState,
    /* private fields */
}

Available on crate features examples or playbooks or sessions only.

Stores metadata of the invocation of a CX flow.

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: String

Required. The unique identifier of the flow. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>.

display_name: String

Output only. The display name of the flow.

flow_state: OutputState

Required. Flow invocation’s output state.

Implementations

impl FlowInvocation

pub fn new() -> Self

Creates a new default instance.

pub fn set_flow<T: Into<String>>(self, v: T) -> Self

Sets the value of flow.

Example

let x = FlowInvocation::new().set_flow(format!("projects/{project_id}/locations/{location_id}/agents/{agent_id}/flows/{flow_id}"));

pub fn set_display_name<T: Into<String>>(self, v: T) -> Self

Sets the value of display_name.

Example

let x = FlowInvocation::new().set_display_name("example");

pub fn set_flow_state<T: Into<OutputState>>(self, v: T) -> Self

Sets the value of flow_state.

Example

use google_cloud_dialogflow_cx_v3::model::OutputState;
let x0 = FlowInvocation::new().set_flow_state(OutputState::Ok);
let x1 = FlowInvocation::new().set_flow_state(OutputState::Cancelled);
let x2 = FlowInvocation::new().set_flow_state(OutputState::Failed);

Trait Implementations

impl Clone for FlowInvocation

fn clone(&self) -> FlowInvocation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FlowInvocation

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

Formats the value using the given formatter.

impl Default for FlowInvocation

fn default() -> FlowInvocation

Returns the “default value” for a type.

impl Message for FlowInvocation

fn typename() -> &'static str

The typename of this message.

impl PartialEq for FlowInvocation

fn eq(&self, other: &FlowInvocation) -> 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 StructuralPartialEq for FlowInvocation