Struct aws_sdk_swf::operation::terminate_workflow_execution::TerminateWorkflowExecutionInput

#[non_exhaustive]
pub struct TerminateWorkflowExecutionInput {
    pub domain: Option<String>,
    pub workflow_id: Option<String>,
    pub run_id: Option<String>,
    pub reason: Option<String>,
    pub details: Option<String>,
    pub child_policy: Option<ChildPolicy>,
}

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.

domain: Option<String>

The domain of the workflow execution to terminate.

workflow_id: Option<String>

The workflowId of the workflow execution to terminate.

run_id: Option<String>

The runId of the workflow execution to terminate.

reason: Option<String>

A descriptive reason for terminating the workflow execution.

details: Option<String>

Details for terminating the workflow execution.

child_policy: Option<ChildPolicy>

If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the execution.

The supported child policies are:

• TERMINATE – The child executions are terminated.

• REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

• ABANDON – No action is taken. The child executions continue to run.

A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.

Implementations

impl TerminateWorkflowExecutionInput

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

The domain of the workflow execution to terminate.

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

The workflowId of the workflow execution to terminate.

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

The runId of the workflow execution to terminate.

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

A descriptive reason for terminating the workflow execution.

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

Details for terminating the workflow execution.

pub fn child_policy(&self) -> Option<&ChildPolicy>

If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the execution.

The supported child policies are:

• TERMINATE – The child executions are terminated.

• REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

• ABANDON – No action is taken. The child executions continue to run.

A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.

impl TerminateWorkflowExecutionInput

pub fn builder() -> TerminateWorkflowExecutionInputBuilder

Creates a new builder-style object to manufacture TerminateWorkflowExecutionInput.

Trait Implementations

impl Clone for TerminateWorkflowExecutionInput

fn clone(&self) -> TerminateWorkflowExecutionInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TerminateWorkflowExecutionInput

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

Formats the value using the given formatter.

impl PartialEq for TerminateWorkflowExecutionInput

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for TerminateWorkflowExecutionInput