aws_sdk_iot/operation/create_custom_metric/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_custom_metric::_create_custom_metric_output::CreateCustomMetricOutputBuilder;
3
4pub use crate::operation::create_custom_metric::_create_custom_metric_input::CreateCustomMetricInputBuilder;
5
6impl crate::operation::create_custom_metric::builders::CreateCustomMetricInputBuilder {
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::create_custom_metric::CreateCustomMetricOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::create_custom_metric::CreateCustomMetricError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.create_custom_metric();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `CreateCustomMetric`.
24///
25/// <p>Use this API to define a Custom Metric published by your devices to Device Defender.</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">CreateCustomMetric</a> action.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct CreateCustomMetricFluentBuilder {
29    handle: ::std::sync::Arc<crate::client::Handle>,
30    inner: crate::operation::create_custom_metric::builders::CreateCustomMetricInputBuilder,
31    config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34    crate::client::customize::internal::CustomizableSend<
35        crate::operation::create_custom_metric::CreateCustomMetricOutput,
36        crate::operation::create_custom_metric::CreateCustomMetricError,
37    > for CreateCustomMetricFluentBuilder
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::create_custom_metric::CreateCustomMetricOutput,
45            crate::operation::create_custom_metric::CreateCustomMetricError,
46        >,
47    > {
48        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49    }
50}
51impl CreateCustomMetricFluentBuilder {
52    /// Creates a new `CreateCustomMetricFluentBuilder`.
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 CreateCustomMetric as a reference.
61    pub fn as_input(&self) -> &crate::operation::create_custom_metric::builders::CreateCustomMetricInputBuilder {
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::create_custom_metric::CreateCustomMetricOutput,
76        ::aws_smithy_runtime_api::client::result::SdkError<
77            crate::operation::create_custom_metric::CreateCustomMetricError,
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::create_custom_metric::CreateCustomMetric::operation_runtime_plugins(
86            self.handle.runtime_plugins.clone(),
87            &self.handle.conf,
88            self.config_override,
89        );
90        crate::operation::create_custom_metric::CreateCustomMetric::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::create_custom_metric::CreateCustomMetricOutput,
98        crate::operation::create_custom_metric::CreateCustomMetricError,
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 custom metric. This will be used in the metric report submitted from the device/thing. The name can't begin with <code>aws:</code>. You can't change the name after you define it.</p>
113    pub fn metric_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
114        self.inner = self.inner.metric_name(input.into());
115        self
116    }
117    /// <p>The name of the custom metric. This will be used in the metric report submitted from the device/thing. The name can't begin with <code>aws:</code>. You can't change the name after you define it.</p>
118    pub fn set_metric_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
119        self.inner = self.inner.set_metric_name(input);
120        self
121    }
122    /// <p>The name of the custom metric. This will be used in the metric report submitted from the device/thing. The name can't begin with <code>aws:</code>. You can't change the name after you define it.</p>
123    pub fn get_metric_name(&self) -> &::std::option::Option<::std::string::String> {
124        self.inner.get_metric_name()
125    }
126    /// <p>The friendly name in the console for the custom metric. This name doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. You can update the friendly name after you define it.</p>
127    pub fn display_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
128        self.inner = self.inner.display_name(input.into());
129        self
130    }
131    /// <p>The friendly name in the console for the custom metric. This name doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. You can update the friendly name after you define it.</p>
132    pub fn set_display_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
133        self.inner = self.inner.set_display_name(input);
134        self
135    }
136    /// <p>The friendly name in the console for the custom metric. This name doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. You can update the friendly name after you define it.</p>
137    pub fn get_display_name(&self) -> &::std::option::Option<::std::string::String> {
138        self.inner.get_display_name()
139    }
140    /// <p>The type of the custom metric.</p><important>
141    /// <p>The type <code>number</code> only takes a single metric value as an input, but when you submit the metrics value in the DeviceMetrics report, you must pass it as an array with a single value.</p>
142    /// </important>
143    pub fn metric_type(mut self, input: crate::types::CustomMetricType) -> Self {
144        self.inner = self.inner.metric_type(input);
145        self
146    }
147    /// <p>The type of the custom metric.</p><important>
148    /// <p>The type <code>number</code> only takes a single metric value as an input, but when you submit the metrics value in the DeviceMetrics report, you must pass it as an array with a single value.</p>
149    /// </important>
150    pub fn set_metric_type(mut self, input: ::std::option::Option<crate::types::CustomMetricType>) -> Self {
151        self.inner = self.inner.set_metric_type(input);
152        self
153    }
154    /// <p>The type of the custom metric.</p><important>
155    /// <p>The type <code>number</code> only takes a single metric value as an input, but when you submit the metrics value in the DeviceMetrics report, you must pass it as an array with a single value.</p>
156    /// </important>
157    pub fn get_metric_type(&self) -> &::std::option::Option<crate::types::CustomMetricType> {
158        self.inner.get_metric_type()
159    }
160    ///
161    /// Appends an item to `tags`.
162    ///
163    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
164    ///
165    /// <p>Metadata that can be used to manage the custom metric.</p>
166    pub fn tags(mut self, input: crate::types::Tag) -> Self {
167        self.inner = self.inner.tags(input);
168        self
169    }
170    /// <p>Metadata that can be used to manage the custom metric.</p>
171    pub fn set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>) -> Self {
172        self.inner = self.inner.set_tags(input);
173        self
174    }
175    /// <p>Metadata that can be used to manage the custom metric.</p>
176    pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
177        self.inner.get_tags()
178    }
179    /// <p>Each custom metric must have a unique client request token. If you try to create a new custom metric that already exists with a different token, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.</p>
180    pub fn client_request_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
181        self.inner = self.inner.client_request_token(input.into());
182        self
183    }
184    /// <p>Each custom metric must have a unique client request token. If you try to create a new custom metric that already exists with a different token, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.</p>
185    pub fn set_client_request_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
186        self.inner = self.inner.set_client_request_token(input);
187        self
188    }
189    /// <p>Each custom metric must have a unique client request token. If you try to create a new custom metric that already exists with a different token, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.</p>
190    pub fn get_client_request_token(&self) -> &::std::option::Option<::std::string::String> {
191        self.inner.get_client_request_token()
192    }
193}
aws_sdk_iot/operation/create_custom_metric/builders.rs

aws_sdk_iot/operation/create_custom_metric/
builders.rs
