aws_sdk_lambda/operation/checkpoint_durable_execution/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::checkpoint_durable_execution::_checkpoint_durable_execution_output::CheckpointDurableExecutionOutputBuilder;
3
4pub use crate::operation::checkpoint_durable_execution::_checkpoint_durable_execution_input::CheckpointDurableExecutionInputBuilder;
5
6impl crate::operation::checkpoint_durable_execution::builders::CheckpointDurableExecutionInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::checkpoint_durable_execution::CheckpointDurableExecutionOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::checkpoint_durable_execution::CheckpointDurableExecutionError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.checkpoint_durable_execution();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `CheckpointDurableExecution`.
24///
25/// <p>Saves the progress of a <a href="https://docs.aws.amazon.com/lambda/latest/dg/durable-functions.html">durable function</a> execution during runtime. This API is used by the Lambda durable functions SDK to checkpoint completed steps and schedule asynchronous operations. You typically don't need to call this API directly as the SDK handles checkpointing automatically.</p>
26/// <p>Each checkpoint operation consumes the current checkpoint token and returns a new one for the next checkpoint. This ensures that checkpoints are applied in the correct order and prevents duplicate or out-of-order state updates.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct CheckpointDurableExecutionFluentBuilder {
29    handle: ::std::sync::Arc<crate::client::Handle>,
30    inner: crate::operation::checkpoint_durable_execution::builders::CheckpointDurableExecutionInputBuilder,
31    config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34    crate::client::customize::internal::CustomizableSend<
35        crate::operation::checkpoint_durable_execution::CheckpointDurableExecutionOutput,
36        crate::operation::checkpoint_durable_execution::CheckpointDurableExecutionError,
37    > for CheckpointDurableExecutionFluentBuilder
38{
39    fn send(
40        self,
41        config_override: crate::config::Builder,
42    ) -> crate::client::customize::internal::BoxFuture<
43        crate::client::customize::internal::SendResult<
44            crate::operation::checkpoint_durable_execution::CheckpointDurableExecutionOutput,
45            crate::operation::checkpoint_durable_execution::CheckpointDurableExecutionError,
46        >,
47    > {
48        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49    }
50}
51impl CheckpointDurableExecutionFluentBuilder {
52    /// Creates a new `CheckpointDurableExecutionFluentBuilder`.
53    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
54        Self {
55            handle,
56            inner: ::std::default::Default::default(),
57            config_override: ::std::option::Option::None,
58        }
59    }
60    /// Access the CheckpointDurableExecution as a reference.
61    pub fn as_input(&self) -> &crate::operation::checkpoint_durable_execution::builders::CheckpointDurableExecutionInputBuilder {
62        &self.inner
63    }
64    /// Sends the request and returns the response.
65    ///
66    /// If an error occurs, an `SdkError` will be returned with additional details that
67    /// can be matched against.
68    ///
69    /// By default, any retryable failures will be retried twice. Retry behavior
70    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
71    /// set when configuring the client.
72    pub async fn send(
73        self,
74    ) -> ::std::result::Result<
75        crate::operation::checkpoint_durable_execution::CheckpointDurableExecutionOutput,
76        ::aws_smithy_runtime_api::client::result::SdkError<
77            crate::operation::checkpoint_durable_execution::CheckpointDurableExecutionError,
78            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
79        >,
80    > {
81        let input = self
82            .inner
83            .build()
84            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
85        let runtime_plugins = crate::operation::checkpoint_durable_execution::CheckpointDurableExecution::operation_runtime_plugins(
86            self.handle.runtime_plugins.clone(),
87            &self.handle.conf,
88            self.config_override,
89        );
90        crate::operation::checkpoint_durable_execution::CheckpointDurableExecution::orchestrate(&runtime_plugins, input).await
91    }
92
93    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
94    pub fn customize(
95        self,
96    ) -> crate::client::customize::CustomizableOperation<
97        crate::operation::checkpoint_durable_execution::CheckpointDurableExecutionOutput,
98        crate::operation::checkpoint_durable_execution::CheckpointDurableExecutionError,
99        Self,
100    > {
101        crate::client::customize::CustomizableOperation::new(self)
102    }
103    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
104        self.set_config_override(::std::option::Option::Some(config_override.into()));
105        self
106    }
107
108    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
109        self.config_override = config_override;
110        self
111    }
112    /// <p>The Amazon Resource Name (ARN) of the durable execution.</p>
113    pub fn durable_execution_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
114        self.inner = self.inner.durable_execution_arn(input.into());
115        self
116    }
117    /// <p>The Amazon Resource Name (ARN) of the durable execution.</p>
118    pub fn set_durable_execution_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
119        self.inner = self.inner.set_durable_execution_arn(input);
120        self
121    }
122    /// <p>The Amazon Resource Name (ARN) of the durable execution.</p>
123    pub fn get_durable_execution_arn(&self) -> &::std::option::Option<::std::string::String> {
124        self.inner.get_durable_execution_arn()
125    }
126    /// <p>A unique token that identifies the current checkpoint state. This token is provided by the Lambda runtime and must be used to ensure checkpoints are applied in the correct order. Each checkpoint operation consumes this token and returns a new one.</p>
127    pub fn checkpoint_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
128        self.inner = self.inner.checkpoint_token(input.into());
129        self
130    }
131    /// <p>A unique token that identifies the current checkpoint state. This token is provided by the Lambda runtime and must be used to ensure checkpoints are applied in the correct order. Each checkpoint operation consumes this token and returns a new one.</p>
132    pub fn set_checkpoint_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
133        self.inner = self.inner.set_checkpoint_token(input);
134        self
135    }
136    /// <p>A unique token that identifies the current checkpoint state. This token is provided by the Lambda runtime and must be used to ensure checkpoints are applied in the correct order. Each checkpoint operation consumes this token and returns a new one.</p>
137    pub fn get_checkpoint_token(&self) -> &::std::option::Option<::std::string::String> {
138        self.inner.get_checkpoint_token()
139    }
140    ///
141    /// Appends an item to `Updates`.
142    ///
143    /// To override the contents of this collection use [`set_updates`](Self::set_updates).
144    ///
145    /// <p>An array of state updates to apply during this checkpoint. Each update represents a change to the execution state, such as completing a step, starting a callback, or scheduling a timer. Updates are applied atomically as part of the checkpoint operation.</p>
146    pub fn updates(mut self, input: crate::types::OperationUpdate) -> Self {
147        self.inner = self.inner.updates(input);
148        self
149    }
150    /// <p>An array of state updates to apply during this checkpoint. Each update represents a change to the execution state, such as completing a step, starting a callback, or scheduling a timer. Updates are applied atomically as part of the checkpoint operation.</p>
151    pub fn set_updates(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::OperationUpdate>>) -> Self {
152        self.inner = self.inner.set_updates(input);
153        self
154    }
155    /// <p>An array of state updates to apply during this checkpoint. Each update represents a change to the execution state, such as completing a step, starting a callback, or scheduling a timer. Updates are applied atomically as part of the checkpoint operation.</p>
156    pub fn get_updates(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::OperationUpdate>> {
157        self.inner.get_updates()
158    }
159    /// <p>An optional idempotency token to ensure that duplicate checkpoint requests are handled correctly. If provided, Lambda uses this token to detect and handle duplicate requests within a 15-minute window.</p>
160    pub fn client_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
161        self.inner = self.inner.client_token(input.into());
162        self
163    }
164    /// <p>An optional idempotency token to ensure that duplicate checkpoint requests are handled correctly. If provided, Lambda uses this token to detect and handle duplicate requests within a 15-minute window.</p>
165    pub fn set_client_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
166        self.inner = self.inner.set_client_token(input);
167        self
168    }
169    /// <p>An optional idempotency token to ensure that duplicate checkpoint requests are handled correctly. If provided, Lambda uses this token to detect and handle duplicate requests within a 15-minute window.</p>
170    pub fn get_client_token(&self) -> &::std::option::Option<::std::string::String> {
171        self.inner.get_client_token()
172    }
173}
aws_sdk_lambda/operation/checkpoint_durable_execution/builders.rs

aws_sdk_lambda/operation/checkpoint_durable_execution/
builders.rs
