Struct camunda_client::models::process_instance_modification_instruction_dto::ProcessInstanceModificationInstructionDto

pub struct ProcessInstanceModificationInstructionDto {
    pub _type: Type,
    pub variables: Option<TriggerVariableValueDto>,
    pub activity_id: Option<String>,
    pub transition_id: Option<String>,
    pub activity_instance_id: Option<String>,
    pub transition_instance_id: Option<String>,
    pub ancestor_activity_instance_id: Option<String>,
    pub cancel_current_active_activity_instances: Option<bool>,
}

Fields

_type: Type

Mandatory. One of the following values: cancel, startBeforeActivity, startAfterActivity, startTransition. * A cancel instruction requests cancellation of a single activity instance or all instances of one activity. * A startBeforeActivity instruction requests to enter a given activity. * A startAfterActivity instruction requests to execute the single outgoing sequence flow of a given activity. * A startTransition instruction requests to execute a specific sequence flow.

variables: Option<TriggerVariableValueDto>

activity_id: Option<String>

Can be used with instructions of types startTransition. Specifies the sequence flow to start.

transition_id: Option<String>

Can be used with instructions of types startTransition. Specifies the sequence flow to start.

activity_instance_id: Option<String>

Can be used with instructions of type cancel. Specifies the activity instance to cancel. Valid values are the activity instance IDs supplied by the Get Activity Instance request.

transition_instance_id: Option<String>

Can be used with instructions of type cancel. Specifies the transition instance to cancel. Valid values are the transition instance IDs supplied by the Get Activity Instance request.

ancestor_activity_instance_id: Option<String>

Can be used with instructions of type startBeforeActivity, startAfterActivity, and startTransition. Valid values are the activity instance IDs supplied by the Get Activity Instance request. If there are multiple parent activity instances of the targeted activity, this specifies the ancestor scope in which hierarchy the activity/transition is to be instantiated. Example: When there are two instances of a subprocess and an activity contained in the subprocess is to be started, this parameter allows to specifiy under which subprocess instance the activity should be started.

cancel_current_active_activity_instances: Option<bool>

Can be used with instructions of type cancel. Prevents the deletion of new created activity instances.

Implementations

impl ProcessInstanceModificationInstructionDto

pub fn new(_type: Type) -> ProcessInstanceModificationInstructionDto

Trait Implementations

impl Clone for ProcessInstanceModificationInstructionDto

fn clone(&self) -> ProcessInstanceModificationInstructionDto

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ProcessInstanceModificationInstructionDto

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProcessInstanceModificationInstructionDto

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<ProcessInstanceModificationInstructionDto> for ProcessInstanceModificationInstructionDto

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for ProcessInstanceModificationInstructionDto

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 ProcessInstanceModificationInstructionDto