aws_sdk_iotjobsdataplane/operation/start_next_pending_job_execution/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::start_next_pending_job_execution::_start_next_pending_job_execution_output::StartNextPendingJobExecutionOutputBuilder;
3
4pub use crate::operation::start_next_pending_job_execution::_start_next_pending_job_execution_input::StartNextPendingJobExecutionInputBuilder;
5
6impl crate::operation::start_next_pending_job_execution::builders::StartNextPendingJobExecutionInputBuilder {
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::start_next_pending_job_execution::StartNextPendingJobExecutionOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::start_next_pending_job_execution::StartNextPendingJobExecutionError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.start_next_pending_job_execution();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `StartNextPendingJobExecution`.
24///
25/// <p>Gets and starts the next pending (status IN_PROGRESS or QUEUED) job execution for a thing.</p>
26/// <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">StartNextPendingJobExecution</a> action.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct StartNextPendingJobExecutionFluentBuilder {
29    handle: ::std::sync::Arc<crate::client::Handle>,
30    inner: crate::operation::start_next_pending_job_execution::builders::StartNextPendingJobExecutionInputBuilder,
31    config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34    crate::client::customize::internal::CustomizableSend<
35        crate::operation::start_next_pending_job_execution::StartNextPendingJobExecutionOutput,
36        crate::operation::start_next_pending_job_execution::StartNextPendingJobExecutionError,
37    > for StartNextPendingJobExecutionFluentBuilder
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::start_next_pending_job_execution::StartNextPendingJobExecutionOutput,
45            crate::operation::start_next_pending_job_execution::StartNextPendingJobExecutionError,
46        >,
47    > {
48        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49    }
50}
51impl StartNextPendingJobExecutionFluentBuilder {
52    /// Creates a new `StartNextPendingJobExecutionFluentBuilder`.
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 StartNextPendingJobExecution as a reference.
61    pub fn as_input(&self) -> &crate::operation::start_next_pending_job_execution::builders::StartNextPendingJobExecutionInputBuilder {
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::start_next_pending_job_execution::StartNextPendingJobExecutionOutput,
76        ::aws_smithy_runtime_api::client::result::SdkError<
77            crate::operation::start_next_pending_job_execution::StartNextPendingJobExecutionError,
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::start_next_pending_job_execution::StartNextPendingJobExecution::operation_runtime_plugins(
86            self.handle.runtime_plugins.clone(),
87            &self.handle.conf,
88            self.config_override,
89        );
90        crate::operation::start_next_pending_job_execution::StartNextPendingJobExecution::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::start_next_pending_job_execution::StartNextPendingJobExecutionOutput,
98        crate::operation::start_next_pending_job_execution::StartNextPendingJobExecutionError,
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 name of the thing associated with the device.</p>
113    pub fn thing_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
114        self.inner = self.inner.thing_name(input.into());
115        self
116    }
117    /// <p>The name of the thing associated with the device.</p>
118    pub fn set_thing_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
119        self.inner = self.inner.set_thing_name(input);
120        self
121    }
122    /// <p>The name of the thing associated with the device.</p>
123    pub fn get_thing_name(&self) -> &::std::option::Option<::std::string::String> {
124        self.inner.get_thing_name()
125    }
126    ///
127    /// Adds a key-value pair to `statusDetails`.
128    ///
129    /// To override the contents of this collection use [`set_status_details`](Self::set_status_details).
130    ///
131    /// <p>A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.</p>
132    /// <p>The maximum length of the value in the name/value pair is 1,024 characters.</p>
133    pub fn status_details(
134        mut self,
135        k: impl ::std::convert::Into<::std::string::String>,
136        v: impl ::std::convert::Into<::std::string::String>,
137    ) -> Self {
138        self.inner = self.inner.status_details(k.into(), v.into());
139        self
140    }
141    /// <p>A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.</p>
142    /// <p>The maximum length of the value in the name/value pair is 1,024 characters.</p>
143    pub fn set_status_details(
144        mut self,
145        input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
146    ) -> Self {
147        self.inner = self.inner.set_status_details(input);
148        self
149    }
150    /// <p>A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.</p>
151    /// <p>The maximum length of the value in the name/value pair is 1,024 characters.</p>
152    pub fn get_status_details(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
153        self.inner.get_status_details()
154    }
155    /// <p>Specifies the amount of time this device has to finish execution of this job. If the job execution status is not set to a terminal state before this timer expires, or before the timer is reset (by calling <code>UpdateJobExecution</code>, setting the status to <code>IN_PROGRESS</code>, and specifying a new timeout value in field <code>stepTimeoutInMinutes</code>) the job execution status will be automatically set to <code>TIMED_OUT</code>. Note that setting the step timeout has no effect on the in progress timeout that may have been specified when the job was created (<code>CreateJob</code> using field <code>timeoutConfig</code>).</p>
156    /// <p>Valid values for this parameter range from 1 to 10080 (1 minute to 7 days).</p>
157    pub fn step_timeout_in_minutes(mut self, input: i64) -> Self {
158        self.inner = self.inner.step_timeout_in_minutes(input);
159        self
160    }
161    /// <p>Specifies the amount of time this device has to finish execution of this job. If the job execution status is not set to a terminal state before this timer expires, or before the timer is reset (by calling <code>UpdateJobExecution</code>, setting the status to <code>IN_PROGRESS</code>, and specifying a new timeout value in field <code>stepTimeoutInMinutes</code>) the job execution status will be automatically set to <code>TIMED_OUT</code>. Note that setting the step timeout has no effect on the in progress timeout that may have been specified when the job was created (<code>CreateJob</code> using field <code>timeoutConfig</code>).</p>
162    /// <p>Valid values for this parameter range from 1 to 10080 (1 minute to 7 days).</p>
163    pub fn set_step_timeout_in_minutes(mut self, input: ::std::option::Option<i64>) -> Self {
164        self.inner = self.inner.set_step_timeout_in_minutes(input);
165        self
166    }
167    /// <p>Specifies the amount of time this device has to finish execution of this job. If the job execution status is not set to a terminal state before this timer expires, or before the timer is reset (by calling <code>UpdateJobExecution</code>, setting the status to <code>IN_PROGRESS</code>, and specifying a new timeout value in field <code>stepTimeoutInMinutes</code>) the job execution status will be automatically set to <code>TIMED_OUT</code>. Note that setting the step timeout has no effect on the in progress timeout that may have been specified when the job was created (<code>CreateJob</code> using field <code>timeoutConfig</code>).</p>
168    /// <p>Valid values for this parameter range from 1 to 10080 (1 minute to 7 days).</p>
169    pub fn get_step_timeout_in_minutes(&self) -> &::std::option::Option<i64> {
170        self.inner.get_step_timeout_in_minutes()
171    }
172}
aws_sdk_iotjobsdataplane/operation/start_next_pending_job_execution/builders.rs

aws_sdk_iotjobsdataplane/operation/start_next_pending_job_execution/
builders.rs
