Struct aws_sdk_swf::operation::poll_for_decision_task::builders::PollForDecisionTaskFluentBuilder
source · pub struct PollForDecisionTaskFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to PollForDecisionTask
.
Used by deciders to get a DecisionTask
from the specified decision taskList
. A decision task may be returned for any open workflow execution that is using the specified task list. The task includes a paginated view of the history of the workflow execution. The decider should use the workflow type and the history to determine how to properly handle the task.
This action initiates a long poll, where the service holds the HTTP connection open and responds as soon a task becomes available. If no decision task is available in the specified task list before the timeout of 60 seconds expires, an empty result is returned. An empty result, in this context, means that a DecisionTask is returned, but that the value of taskToken is an empty string.
Deciders should set their client side socket timeout to at least 70 seconds (10 seconds higher than the timeout).
Because the number of workflow history events for a single workflow execution might be very large, the result returned might be split up across a number of pages. To retrieve subsequent pages, make additional calls to PollForDecisionTask
using the nextPageToken
returned by the initial call. Note that you do not call GetWorkflowExecutionHistory
with this nextPageToken
. Instead, call PollForDecisionTask
again.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resource
element with the domain name to limit the action to only specified domains. -
Use an
Action
element to allow or deny permission to call this action. -
Constrain the
taskList.name
parameter by using aCondition
element with theswf:taskList.name
key to allow the action to access only certain task lists.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause
parameter is set to OPERATION_NOT_PERMITTED
. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
Implementations§
source§impl PollForDecisionTaskFluentBuilder
impl PollForDecisionTaskFluentBuilder
sourcepub fn as_input(&self) -> &PollForDecisionTaskInputBuilder
pub fn as_input(&self) -> &PollForDecisionTaskInputBuilder
Access the PollForDecisionTask as a reference.
sourcepub async fn send(
self
) -> Result<PollForDecisionTaskOutput, SdkError<PollForDecisionTaskError, HttpResponse>>
pub async fn send( self ) -> Result<PollForDecisionTaskOutput, SdkError<PollForDecisionTaskError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn customize(
self
) -> CustomizableOperation<PollForDecisionTaskOutput, PollForDecisionTaskError, Self>
pub fn customize( self ) -> CustomizableOperation<PollForDecisionTaskOutput, PollForDecisionTaskError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn into_paginator(self) -> PollForDecisionTaskPaginator
pub fn into_paginator(self) -> PollForDecisionTaskPaginator
Create a paginator for this request
Paginators are used by calling send().await
which returns a PaginationStream
.
sourcepub fn domain(self, input: impl Into<String>) -> Self
pub fn domain(self, input: impl Into<String>) -> Self
The name of the domain containing the task lists to poll.
sourcepub fn set_domain(self, input: Option<String>) -> Self
pub fn set_domain(self, input: Option<String>) -> Self
The name of the domain containing the task lists to poll.
sourcepub fn get_domain(&self) -> &Option<String>
pub fn get_domain(&self) -> &Option<String>
The name of the domain containing the task lists to poll.
sourcepub fn task_list(self, input: TaskList) -> Self
pub fn task_list(self, input: TaskList) -> Self
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
.
sourcepub fn set_task_list(self, input: Option<TaskList>) -> Self
pub fn set_task_list(self, input: Option<TaskList>) -> Self
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
.
sourcepub fn get_task_list(&self) -> &Option<TaskList>
pub fn get_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
.
sourcepub fn identity(self, input: impl Into<String>) -> Self
pub fn identity(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_identity(self, input: Option<String>) -> Self
pub fn set_identity(self, input: Option<String>) -> Self
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.
sourcepub fn get_identity(&self) -> &Option<String>
pub fn get_identity(&self) -> &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.
sourcepub fn next_page_token(self, input: impl Into<String>) -> Self
pub fn next_page_token(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_next_page_token(self, input: Option<String>) -> Self
pub fn set_next_page_token(self, input: Option<String>) -> Self
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.
sourcepub fn get_next_page_token(&self) -> &Option<String>
pub fn get_next_page_token(&self) -> &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.
sourcepub fn maximum_page_size(self, input: i32) -> Self
pub fn maximum_page_size(self, input: i32) -> Self
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.
sourcepub fn set_maximum_page_size(self, input: Option<i32>) -> Self
pub fn set_maximum_page_size(self, input: Option<i32>) -> Self
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.
sourcepub fn get_maximum_page_size(&self) -> &Option<i32>
pub fn get_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.
sourcepub fn reverse_order(self, input: bool) -> Self
pub fn reverse_order(self, input: bool) -> Self
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.
sourcepub fn set_reverse_order(self, input: Option<bool>) -> Self
pub fn set_reverse_order(self, input: Option<bool>) -> Self
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.
sourcepub fn get_reverse_order(&self) -> &Option<bool>
pub fn get_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.
sourcepub fn start_at_previous_started_event(self, input: bool) -> Self
pub fn start_at_previous_started_event(self, input: bool) -> Self
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
.
sourcepub fn set_start_at_previous_started_event(self, input: Option<bool>) -> Self
pub fn set_start_at_previous_started_event(self, input: Option<bool>) -> Self
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
.
sourcepub fn get_start_at_previous_started_event(&self) -> &Option<bool>
pub fn get_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
.
Trait Implementations§
source§impl Clone for PollForDecisionTaskFluentBuilder
impl Clone for PollForDecisionTaskFluentBuilder
source§fn clone(&self) -> PollForDecisionTaskFluentBuilder
fn clone(&self) -> PollForDecisionTaskFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for PollForDecisionTaskFluentBuilder
impl !RefUnwindSafe for PollForDecisionTaskFluentBuilder
impl Send for PollForDecisionTaskFluentBuilder
impl Sync for PollForDecisionTaskFluentBuilder
impl Unpin for PollForDecisionTaskFluentBuilder
impl !UnwindSafe for PollForDecisionTaskFluentBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more