Struct Workflow

pub struct Workflow {
    pub uuid: String,
    pub factory_name: String,
    pub name: String,
    pub state: i32,
    pub data: Vec<u8>,
    pub error: String,
    pub start_time: i64,
    pub end_time: i64,
    pub create_time: i64,
}

Workflow is the persisted state of a long-running workflow.

Fields

uuid: String

uuid is set when the workflow is created, and immutable after that.

factory_name: String

factory_name is set with the name of the factory that created the job (and can also restart it). It is set at creation time, and immutable after that.

name: String

name is the display name of the workflow.

state: i32

state describes the state of the job. A job is created as NotStarted, then the Workflow Manager picks it up and starts it, switching it to Running (and populating ‘start_time’). The workflow can then fail over to a new Workflow Manager is necessary, and still be in Running state. When done, it goes to Done, ‘end_time’ is populated, and ‘error’ is set if there was an error.

data: Vec<u8>

data is workflow-specific stored data. It is usually a binary proto-encoded data structure. It can vary throughout the execution of the workflow. It will not change after the workflow is Done.

error: String

error is set if the job finished with an error. This field only makes sense if ‘state’ is Done.

start_time: i64

start_time is set when the workflow manager starts a workflow for the first time. This field only makes sense if ‘state’ is Running or Done.

end_time: i64

end_time is set when the workflow is finished. This field only makes sense if ‘state’ is Done.

create_time: i64

create_time is set when the workflow is created.

Implementations

impl Workflow

pub fn state(&self) -> WorkflowState

Returns the enum value of state, or the default if the field is set to an invalid enum value.

pub fn set_state(&mut self, value: WorkflowState)

Sets state to the provided enum value.

Trait Implementations

impl Clone for Workflow

fn clone(&self) -> Workflow

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Workflow

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

Formats the value using the given formatter.

impl Default for Workflow

fn default() -> Self

Returns the “default value” for a type.

impl Message for Workflow

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Workflow

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