Struct aws_sdk_sfn::client::fluent_builders::SendTaskHeartbeat
source · [−]pub struct SendTaskHeartbeat { /* private fields */ }
Expand description
Fluent builder constructing a request to SendTaskHeartbeat
.
Used by activity workers and task states using the callback pattern to report to Step Functions that the task represented by the specified taskToken
is still making progress. This action resets the Heartbeat
clock. The Heartbeat
threshold is specified in the state machine's Amazon States Language definition (HeartbeatSeconds
). This action does not in itself create an event in the execution history. However, if the task times out, the execution history contains an ActivityTimedOut
entry for activities, or a TaskTimedOut
entry for for tasks using the job run or callback pattern.
The Timeout
of a task, defined in the state machine's Amazon States Language definition, is its maximum allowed duration, regardless of the number of SendTaskHeartbeat
requests received. Use HeartbeatSeconds
to configure the timeout interval for heartbeats.
Implementations
sourceimpl SendTaskHeartbeat
impl SendTaskHeartbeat
sourcepub async fn send(
self
) -> Result<SendTaskHeartbeatOutput, SdkError<SendTaskHeartbeatError>>
pub async fn send(
self
) -> Result<SendTaskHeartbeatOutput, SdkError<SendTaskHeartbeatError>>
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 task_token(self, input: impl Into<String>) -> Self
pub fn task_token(self, input: impl Into<String>) -> Self
The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the context object when a workflow enters a task state. See GetActivityTaskOutput$taskToken
.
sourcepub fn set_task_token(self, input: Option<String>) -> Self
pub fn set_task_token(self, input: Option<String>) -> Self
The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the context object when a workflow enters a task state. See GetActivityTaskOutput$taskToken
.
Trait Implementations
sourceimpl Clone for SendTaskHeartbeat
impl Clone for SendTaskHeartbeat
sourcefn clone(&self) -> SendTaskHeartbeat
fn clone(&self) -> SendTaskHeartbeat
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 SendTaskHeartbeat
impl Send for SendTaskHeartbeat
impl Sync for SendTaskHeartbeat
impl Unpin for SendTaskHeartbeat
impl !UnwindSafe for SendTaskHeartbeat
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