Struct WorkflowDetails

#[non_exhaustive]
pub struct WorkflowDetails {
    pub on_upload: Option<Vec<WorkflowDetail>>,
    pub on_partial_upload: Option<Vec<WorkflowDetail>>,
}

Container for the WorkflowDetail data type. It is used by actions that trigger a workflow to begin execution.

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.

on_upload: Option<Vec<WorkflowDetail>>

A trigger that starts a workflow: the workflow begins to execute after a file is uploaded.

To remove an associated workflow from a server, you can provide an empty OnUpload object, as in the following example.

aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":\[\]}'

OnUpload can contain a maximum of one WorkflowDetail object.

on_partial_upload: Option<Vec<WorkflowDetail>>

A trigger that starts a workflow if a file is only partially uploaded. You can attach a workflow to a server that executes whenever there is a partial upload.

A partial upload occurs when a file is open when the session disconnects.

OnPartialUpload can contain a maximum of one WorkflowDetail object.

Implementations

impl WorkflowDetails

pub fn on_upload(&self) -> &[WorkflowDetail]

A trigger that starts a workflow: the workflow begins to execute after a file is uploaded.

To remove an associated workflow from a server, you can provide an empty OnUpload object, as in the following example.

aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":\[\]}'

OnUpload can contain a maximum of one WorkflowDetail object.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .on_upload.is_none().

pub fn on_partial_upload(&self) -> &[WorkflowDetail]

A trigger that starts a workflow if a file is only partially uploaded. You can attach a workflow to a server that executes whenever there is a partial upload.

A partial upload occurs when a file is open when the session disconnects.

OnPartialUpload can contain a maximum of one WorkflowDetail object.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .on_partial_upload.is_none().

impl WorkflowDetails

pub fn builder() -> WorkflowDetailsBuilder

Creates a new builder-style object to manufacture WorkflowDetails.

Trait Implementations

impl Clone for WorkflowDetails

fn clone(&self) -> WorkflowDetails

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WorkflowDetails

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

Formats the value using the given formatter.

impl PartialEq for WorkflowDetails

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