aws_sdk_iotmanagedintegrations/operation/start_device_discovery/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::start_device_discovery::_start_device_discovery_output::StartDeviceDiscoveryOutputBuilder;
3
4pub use crate::operation::start_device_discovery::_start_device_discovery_input::StartDeviceDiscoveryInputBuilder;
5
6impl crate::operation::start_device_discovery::builders::StartDeviceDiscoveryInputBuilder {
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_device_discovery::StartDeviceDiscoveryOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::start_device_discovery::StartDeviceDiscoveryError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.start_device_discovery();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `StartDeviceDiscovery`.
24///
25/// <p>This API is used to start device discovery for hub-connected and third-party-connected devices. The authentication material (install code) is delivered as a message to the controller instructing it to start the discovery.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct StartDeviceDiscoveryFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::start_device_discovery::builders::StartDeviceDiscoveryInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::start_device_discovery::StartDeviceDiscoveryOutput,
35        crate::operation::start_device_discovery::StartDeviceDiscoveryError,
36    > for StartDeviceDiscoveryFluentBuilder
37{
38    fn send(
39        self,
40        config_override: crate::config::Builder,
41    ) -> crate::client::customize::internal::BoxFuture<
42        crate::client::customize::internal::SendResult<
43            crate::operation::start_device_discovery::StartDeviceDiscoveryOutput,
44            crate::operation::start_device_discovery::StartDeviceDiscoveryError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl StartDeviceDiscoveryFluentBuilder {
51    /// Creates a new `StartDeviceDiscoveryFluentBuilder`.
52    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
53        Self {
54            handle,
55            inner: ::std::default::Default::default(),
56            config_override: ::std::option::Option::None,
57        }
58    }
59    /// Access the StartDeviceDiscovery as a reference.
60    pub fn as_input(&self) -> &crate::operation::start_device_discovery::builders::StartDeviceDiscoveryInputBuilder {
61        &self.inner
62    }
63    /// Sends the request and returns the response.
64    ///
65    /// If an error occurs, an `SdkError` will be returned with additional details that
66    /// can be matched against.
67    ///
68    /// By default, any retryable failures will be retried twice. Retry behavior
69    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
70    /// set when configuring the client.
71    pub async fn send(
72        self,
73    ) -> ::std::result::Result<
74        crate::operation::start_device_discovery::StartDeviceDiscoveryOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::start_device_discovery::StartDeviceDiscoveryError,
77            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
78        >,
79    > {
80        let input = self
81            .inner
82            .build()
83            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
84        let runtime_plugins = crate::operation::start_device_discovery::StartDeviceDiscovery::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::start_device_discovery::StartDeviceDiscovery::orchestrate(&runtime_plugins, input).await
90    }
91
92    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
93    pub fn customize(
94        self,
95    ) -> crate::client::customize::CustomizableOperation<
96        crate::operation::start_device_discovery::StartDeviceDiscoveryOutput,
97        crate::operation::start_device_discovery::StartDeviceDiscoveryError,
98        Self,
99    > {
100        crate::client::customize::CustomizableOperation::new(self)
101    }
102    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
103        self.set_config_override(::std::option::Option::Some(config_override.into()));
104        self
105    }
106
107    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
108        self.config_override = config_override;
109        self
110    }
111    /// <p>The discovery type supporting the type of device to be discovered in the device discovery task request.</p>
112    pub fn discovery_type(mut self, input: crate::types::DiscoveryType) -> Self {
113        self.inner = self.inner.discovery_type(input);
114        self
115    }
116    /// <p>The discovery type supporting the type of device to be discovered in the device discovery task request.</p>
117    pub fn set_discovery_type(mut self, input: ::std::option::Option<crate::types::DiscoveryType>) -> Self {
118        self.inner = self.inner.set_discovery_type(input);
119        self
120    }
121    /// <p>The discovery type supporting the type of device to be discovered in the device discovery task request.</p>
122    pub fn get_discovery_type(&self) -> &::std::option::Option<crate::types::DiscoveryType> {
123        self.inner.get_discovery_type()
124    }
125    ///
126    /// Adds a key-value pair to `CustomProtocolDetail`.
127    ///
128    /// To override the contents of this collection use [`set_custom_protocol_detail`](Self::set_custom_protocol_detail).
129    ///
130    /// <p>Additional protocol-specific details required for device discovery, which vary based on the discovery type.</p><note>
131    /// <p>For a <code>DiscoveryType</code> of <code>CUSTOM</code>, the string-to-string map must have a key value of <code>Name</code> set to a non-empty-string.</p>
132    /// </note>
133    pub fn custom_protocol_detail(
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.custom_protocol_detail(k.into(), v.into());
139        self
140    }
141    /// <p>Additional protocol-specific details required for device discovery, which vary based on the discovery type.</p><note>
142    /// <p>For a <code>DiscoveryType</code> of <code>CUSTOM</code>, the string-to-string map must have a key value of <code>Name</code> set to a non-empty-string.</p>
143    /// </note>
144    pub fn set_custom_protocol_detail(
145        mut self,
146        input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
147    ) -> Self {
148        self.inner = self.inner.set_custom_protocol_detail(input);
149        self
150    }
151    /// <p>Additional protocol-specific details required for device discovery, which vary based on the discovery type.</p><note>
152    /// <p>For a <code>DiscoveryType</code> of <code>CUSTOM</code>, the string-to-string map must have a key value of <code>Name</code> set to a non-empty-string.</p>
153    /// </note>
154    pub fn get_custom_protocol_detail(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
155        self.inner.get_custom_protocol_detail()
156    }
157    /// <p>The id of the end-user's IoT hub.</p>
158    pub fn controller_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
159        self.inner = self.inner.controller_identifier(input.into());
160        self
161    }
162    /// <p>The id of the end-user's IoT hub.</p>
163    pub fn set_controller_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
164        self.inner = self.inner.set_controller_identifier(input);
165        self
166    }
167    /// <p>The id of the end-user's IoT hub.</p>
168    pub fn get_controller_identifier(&self) -> &::std::option::Option<::std::string::String> {
169        self.inner.get_controller_identifier()
170    }
171    /// <p>The id of the connector association.</p>
172    #[deprecated(note = "ConnectorAssociationIdentifier is deprecated", since = "06-25-2025")]
173    pub fn connector_association_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
174        self.inner = self.inner.connector_association_identifier(input.into());
175        self
176    }
177    /// <p>The id of the connector association.</p>
178    #[deprecated(note = "ConnectorAssociationIdentifier is deprecated", since = "06-25-2025")]
179    pub fn set_connector_association_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
180        self.inner = self.inner.set_connector_association_identifier(input);
181        self
182    }
183    /// <p>The id of the connector association.</p>
184    #[deprecated(note = "ConnectorAssociationIdentifier is deprecated", since = "06-25-2025")]
185    pub fn get_connector_association_identifier(&self) -> &::std::option::Option<::std::string::String> {
186        self.inner.get_connector_association_identifier()
187    }
188    /// <p>The identifier of the cloud-to-cloud account association to use for discovery of third-party devices.</p>
189    pub fn account_association_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
190        self.inner = self.inner.account_association_id(input.into());
191        self
192    }
193    /// <p>The identifier of the cloud-to-cloud account association to use for discovery of third-party devices.</p>
194    pub fn set_account_association_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
195        self.inner = self.inner.set_account_association_id(input);
196        self
197    }
198    /// <p>The identifier of the cloud-to-cloud account association to use for discovery of third-party devices.</p>
199    pub fn get_account_association_id(&self) -> &::std::option::Option<::std::string::String> {
200        self.inner.get_account_association_id()
201    }
202    /// <p>The authentication material required to start the local device discovery job request.</p>
203    pub fn authentication_material(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
204        self.inner = self.inner.authentication_material(input.into());
205        self
206    }
207    /// <p>The authentication material required to start the local device discovery job request.</p>
208    pub fn set_authentication_material(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
209        self.inner = self.inner.set_authentication_material(input);
210        self
211    }
212    /// <p>The authentication material required to start the local device discovery job request.</p>
213    pub fn get_authentication_material(&self) -> &::std::option::Option<::std::string::String> {
214        self.inner.get_authentication_material()
215    }
216    /// <p>The type of authentication material used for device discovery jobs.</p>
217    pub fn authentication_material_type(mut self, input: crate::types::DiscoveryAuthMaterialType) -> Self {
218        self.inner = self.inner.authentication_material_type(input);
219        self
220    }
221    /// <p>The type of authentication material used for device discovery jobs.</p>
222    pub fn set_authentication_material_type(mut self, input: ::std::option::Option<crate::types::DiscoveryAuthMaterialType>) -> Self {
223        self.inner = self.inner.set_authentication_material_type(input);
224        self
225    }
226    /// <p>The type of authentication material used for device discovery jobs.</p>
227    pub fn get_authentication_material_type(&self) -> &::std::option::Option<crate::types::DiscoveryAuthMaterialType> {
228        self.inner.get_authentication_material_type()
229    }
230    /// <p>An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.</p>
231    pub fn client_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
232        self.inner = self.inner.client_token(input.into());
233        self
234    }
235    /// <p>An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.</p>
236    pub fn set_client_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
237        self.inner = self.inner.set_client_token(input);
238        self
239    }
240    /// <p>An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.</p>
241    pub fn get_client_token(&self) -> &::std::option::Option<::std::string::String> {
242        self.inner.get_client_token()
243    }
244    ///
245    /// Adds a key-value pair to `Tags`.
246    ///
247    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
248    ///
249    /// <p>A set of key/value pairs that are used to manage the device discovery request.</p>
250    #[deprecated(note = "Tags have been deprecated from this api", since = "06-25-2025")]
251    pub fn tags(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
252        self.inner = self.inner.tags(k.into(), v.into());
253        self
254    }
255    /// <p>A set of key/value pairs that are used to manage the device discovery request.</p>
256    #[deprecated(note = "Tags have been deprecated from this api", since = "06-25-2025")]
257    pub fn set_tags(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
258        self.inner = self.inner.set_tags(input);
259        self
260    }
261    /// <p>A set of key/value pairs that are used to manage the device discovery request.</p>
262    #[deprecated(note = "Tags have been deprecated from this api", since = "06-25-2025")]
263    pub fn get_tags(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
264        self.inner.get_tags()
265    }
266}
aws_sdk_iotmanagedintegrations/operation/start_device_discovery/builders.rs

aws_sdk_iotmanagedintegrations/operation/start_device_discovery/
builders.rs
