Struct aws_sdk_swf::operation::record_activity_task_heartbeat::builders::RecordActivityTaskHeartbeatFluentBuilder
source · pub struct RecordActivityTaskHeartbeatFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to RecordActivityTaskHeartbeat
.
Used by activity workers to report to the service that the ActivityTask
represented by the specified taskToken
is still making progress. The worker can also specify details of the progress, for example percent complete, using the details
parameter. This action can also be used by the worker as a mechanism to check if cancellation is being requested for the activity task. If a cancellation is being attempted for the specified task, then the boolean cancelRequested
flag returned by the service is set to true
.
This action resets the taskHeartbeatTimeout
clock. The taskHeartbeatTimeout
is specified in RegisterActivityType
.
This action doesn't in itself create an event in the workflow execution history. However, if the task times out, the workflow execution history contains a ActivityTaskTimedOut
event that contains the information from the last heartbeat generated by the activity worker.
The taskStartToCloseTimeout
of an activity type is the maximum duration of an activity task, regardless of the number of RecordActivityTaskHeartbeat
requests received. The taskStartToCloseTimeout
is also specified in RegisterActivityType
.
This operation is only useful for long-lived activities to report liveliness of the task and to determine if a cancellation is being attempted.
If the cancelRequested
flag returns true
, a cancellation is being attempted. If the worker can cancel the activity, it should respond with RespondActivityTaskCanceled
. Otherwise, it should ignore the cancellation request.
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. -
You cannot use an IAM policy to constrain this action's parameters.
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 RecordActivityTaskHeartbeatFluentBuilder
impl RecordActivityTaskHeartbeatFluentBuilder
sourcepub fn as_input(&self) -> &RecordActivityTaskHeartbeatInputBuilder
pub fn as_input(&self) -> &RecordActivityTaskHeartbeatInputBuilder
Access the RecordActivityTaskHeartbeat as a reference.
sourcepub async fn send(
self
) -> Result<RecordActivityTaskHeartbeatOutput, SdkError<RecordActivityTaskHeartbeatError, HttpResponse>>
pub async fn send( self ) -> Result<RecordActivityTaskHeartbeatOutput, SdkError<RecordActivityTaskHeartbeatError, 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<RecordActivityTaskHeartbeatOutput, RecordActivityTaskHeartbeatError, Self>
pub fn customize( self ) -> CustomizableOperation<RecordActivityTaskHeartbeatOutput, RecordActivityTaskHeartbeatError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn task_token(self, input: impl Into<String>) -> Self
pub fn task_token(self, input: impl Into<String>) -> Self
The taskToken
of the ActivityTask
.
taskToken
is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken
must also be passed. This enables it to provide its progress and respond with results.
sourcepub fn set_task_token(self, input: Option<String>) -> Self
pub fn set_task_token(self, input: Option<String>) -> Self
The taskToken
of the ActivityTask
.
taskToken
is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken
must also be passed. This enables it to provide its progress and respond with results.
sourcepub fn get_task_token(&self) -> &Option<String>
pub fn get_task_token(&self) -> &Option<String>
The taskToken
of the ActivityTask
.
taskToken
is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken
must also be passed. This enables it to provide its progress and respond with results.
sourcepub fn details(self, input: impl Into<String>) -> Self
pub fn details(self, input: impl Into<String>) -> Self
If specified, contains details about the progress of the task.
sourcepub fn set_details(self, input: Option<String>) -> Self
pub fn set_details(self, input: Option<String>) -> Self
If specified, contains details about the progress of the task.
sourcepub fn get_details(&self) -> &Option<String>
pub fn get_details(&self) -> &Option<String>
If specified, contains details about the progress of the task.
Trait Implementations§
source§impl Clone for RecordActivityTaskHeartbeatFluentBuilder
impl Clone for RecordActivityTaskHeartbeatFluentBuilder
source§fn clone(&self) -> RecordActivityTaskHeartbeatFluentBuilder
fn clone(&self) -> RecordActivityTaskHeartbeatFluentBuilder
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 RecordActivityTaskHeartbeatFluentBuilder
impl !RefUnwindSafe for RecordActivityTaskHeartbeatFluentBuilder
impl Send for RecordActivityTaskHeartbeatFluentBuilder
impl Sync for RecordActivityTaskHeartbeatFluentBuilder
impl Unpin for RecordActivityTaskHeartbeatFluentBuilder
impl !UnwindSafe for RecordActivityTaskHeartbeatFluentBuilder
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