Struct aws_sdk_sfn::client::fluent_builders::GetActivityTask
source · [−]pub struct GetActivityTask { /* private fields */ }
Expand description
Fluent builder constructing a request to GetActivityTask
.
Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a running state machine. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available (i.e. an execution of a task of this type is needed.) The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll returns a taskToken
with a null string.
Workers should set their client side socket timeout to at least 65 seconds (5 seconds higher than the maximum time the service may hold the poll request).
Polling with GetActivityTask
can cause latency in some implementations. See Avoid Latency When Polling for Activity Tasks in the Step Functions Developer Guide.
Implementations
sourceimpl GetActivityTask
impl GetActivityTask
sourcepub async fn send(
self
) -> Result<GetActivityTaskOutput, SdkError<GetActivityTaskError>>
pub async fn send(
self
) -> Result<GetActivityTaskOutput, SdkError<GetActivityTaskError>>
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 activity_arn(self, input: impl Into<String>) -> Self
pub fn activity_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the activity to retrieve tasks from (assigned when you create the task using CreateActivity
.)
sourcepub fn set_activity_arn(self, input: Option<String>) -> Self
pub fn set_activity_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the activity to retrieve tasks from (assigned when you create the task using CreateActivity
.)
sourcepub fn worker_name(self, input: impl Into<String>) -> Self
pub fn worker_name(self, input: impl Into<String>) -> Self
You can provide an arbitrary name in order to identify the worker that the task is assigned to. This name is used when it is logged in the execution history.
sourcepub fn set_worker_name(self, input: Option<String>) -> Self
pub fn set_worker_name(self, input: Option<String>) -> Self
You can provide an arbitrary name in order to identify the worker that the task is assigned to. This name is used when it is logged in the execution history.
Trait Implementations
sourceimpl Clone for GetActivityTask
impl Clone for GetActivityTask
sourcefn clone(&self) -> GetActivityTask
fn clone(&self) -> GetActivityTask
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
Auto Trait Implementations
impl !RefUnwindSafe for GetActivityTask
impl Send for GetActivityTask
impl Sync for GetActivityTask
impl Unpin for GetActivityTask
impl !UnwindSafe for GetActivityTask
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more