Struct aws_sdk_swf::operation::poll_for_decision_task::PollForDecisionTaskInput

#[non_exhaustive]
pub struct PollForDecisionTaskInput {
    pub domain: Option<String>,
    pub task_list: Option<TaskList>,
    pub identity: Option<String>,
    pub next_page_token: Option<String>,
    pub maximum_page_size: Option<i32>,
    pub reverse_order: Option<bool>,
    pub start_at_previous_started_event: Option<bool>,
}

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 name of the domain containing the task lists to poll.

task_list: Option<TaskList>

Specifies the task list to poll for decision tasks.

The specified string must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

identity: Option<String>

Identity of the decider making the request, which is recorded in the DecisionTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined.

next_page_token: Option<String>

If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".

The configured maximumPageSize determines how many results can be returned in a single call.

The nextPageToken returned by this action cannot be used with GetWorkflowExecutionHistory to get the next page. You must call PollForDecisionTask again (with the nextPageToken) to retrieve the next page of history records. Calling PollForDecisionTask with a nextPageToken doesn't return a new decision task.

maximum_page_size: Option<i32>

The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

reverse_order: Option<bool>

When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimestamp of the events.

start_at_previous_started_event: Option<bool>

When set to true, returns the events with eventTimestamp greater than or equal to eventTimestamp of the most recent DecisionTaskStarted event. By default, this parameter is set to false.

Implementations

impl PollForDecisionTaskInput

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

The name of the domain containing the task lists to poll.

pub fn task_list(&self) -> Option<&TaskList>

Specifies the task list to poll for decision tasks.

The specified string must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

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

Identity of the decider making the request, which is recorded in the DecisionTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined.

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

If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".

The configured maximumPageSize determines how many results can be returned in a single call.

The nextPageToken returned by this action cannot be used with GetWorkflowExecutionHistory to get the next page. You must call PollForDecisionTask again (with the nextPageToken) to retrieve the next page of history records. Calling PollForDecisionTask with a nextPageToken doesn't return a new decision task.

pub fn maximum_page_size(&self) -> Option<i32>

The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

pub fn reverse_order(&self) -> Option<bool>

When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimestamp of the events.

pub fn start_at_previous_started_event(&self) -> Option<bool>

When set to true, returns the events with eventTimestamp greater than or equal to eventTimestamp of the most recent DecisionTaskStarted event. By default, this parameter is set to false.

impl PollForDecisionTaskInput

pub fn builder() -> PollForDecisionTaskInputBuilder

Creates a new builder-style object to manufacture PollForDecisionTaskInput.

Trait Implementations

impl Clone for PollForDecisionTaskInput

fn clone(&self) -> PollForDecisionTaskInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PollForDecisionTaskInput

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

Formats the value using the given formatter.

impl PartialEq for PollForDecisionTaskInput

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