aws_sdk_iotsitewise/operation/delete_time_series/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::delete_time_series::_delete_time_series_output::DeleteTimeSeriesOutputBuilder;
3
4pub use crate::operation::delete_time_series::_delete_time_series_input::DeleteTimeSeriesInputBuilder;
5
6impl crate::operation::delete_time_series::builders::DeleteTimeSeriesInputBuilder {
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::delete_time_series::DeleteTimeSeriesOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::delete_time_series::DeleteTimeSeriesError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.delete_time_series();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `DeleteTimeSeries`.
24///
25/// <p>Deletes a time series (data stream). If you delete a time series that's associated with an asset property, the asset property still exists, but the time series will no longer be associated with this asset property.</p>
26/// <p>To identify a time series, do one of the following:</p>
27/// <ul>
28/// <li>
29/// <p>If the time series isn't associated with an asset property, specify the <code>alias</code> of the time series.</p></li>
30/// <li>
31/// <p>If the time series is associated with an asset property, specify one of the following:</p>
32/// <ul>
33/// <li>
34/// <p>The <code>alias</code> of the time series.</p></li>
35/// <li>
36/// <p>The <code>assetId</code> and <code>propertyId</code> that identifies the asset property.</p></li>
37/// </ul></li>
38/// </ul>
39#[derive(::std::clone::Clone, ::std::fmt::Debug)]
40pub struct DeleteTimeSeriesFluentBuilder {
41 handle: ::std::sync::Arc<crate::client::Handle>,
42 inner: crate::operation::delete_time_series::builders::DeleteTimeSeriesInputBuilder,
43 config_override: ::std::option::Option<crate::config::Builder>,
44}
45impl
46 crate::client::customize::internal::CustomizableSend<
47 crate::operation::delete_time_series::DeleteTimeSeriesOutput,
48 crate::operation::delete_time_series::DeleteTimeSeriesError,
49 > for DeleteTimeSeriesFluentBuilder
50{
51 fn send(
52 self,
53 config_override: crate::config::Builder,
54 ) -> crate::client::customize::internal::BoxFuture<
55 crate::client::customize::internal::SendResult<
56 crate::operation::delete_time_series::DeleteTimeSeriesOutput,
57 crate::operation::delete_time_series::DeleteTimeSeriesError,
58 >,
59 > {
60 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
61 }
62}
63impl DeleteTimeSeriesFluentBuilder {
64 /// Creates a new `DeleteTimeSeriesFluentBuilder`.
65 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
66 Self {
67 handle,
68 inner: ::std::default::Default::default(),
69 config_override: ::std::option::Option::None,
70 }
71 }
72 /// Access the DeleteTimeSeries as a reference.
73 pub fn as_input(&self) -> &crate::operation::delete_time_series::builders::DeleteTimeSeriesInputBuilder {
74 &self.inner
75 }
76 /// Sends the request and returns the response.
77 ///
78 /// If an error occurs, an `SdkError` will be returned with additional details that
79 /// can be matched against.
80 ///
81 /// By default, any retryable failures will be retried twice. Retry behavior
82 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
83 /// set when configuring the client.
84 pub async fn send(
85 self,
86 ) -> ::std::result::Result<
87 crate::operation::delete_time_series::DeleteTimeSeriesOutput,
88 ::aws_smithy_runtime_api::client::result::SdkError<
89 crate::operation::delete_time_series::DeleteTimeSeriesError,
90 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
91 >,
92 > {
93 let input = self
94 .inner
95 .build()
96 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
97 let runtime_plugins = crate::operation::delete_time_series::DeleteTimeSeries::operation_runtime_plugins(
98 self.handle.runtime_plugins.clone(),
99 &self.handle.conf,
100 self.config_override,
101 );
102 crate::operation::delete_time_series::DeleteTimeSeries::orchestrate(&runtime_plugins, input).await
103 }
104
105 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
106 pub fn customize(
107 self,
108 ) -> crate::client::customize::CustomizableOperation<
109 crate::operation::delete_time_series::DeleteTimeSeriesOutput,
110 crate::operation::delete_time_series::DeleteTimeSeriesError,
111 Self,
112 > {
113 crate::client::customize::CustomizableOperation::new(self)
114 }
115 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
116 self.set_config_override(::std::option::Option::Some(config_override.into()));
117 self
118 }
119
120 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
121 self.config_override = config_override;
122 self
123 }
124 /// <p>The alias that identifies the time series.</p>
125 pub fn alias(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
126 self.inner = self.inner.alias(input.into());
127 self
128 }
129 /// <p>The alias that identifies the time series.</p>
130 pub fn set_alias(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
131 self.inner = self.inner.set_alias(input);
132 self
133 }
134 /// <p>The alias that identifies the time series.</p>
135 pub fn get_alias(&self) -> &::std::option::Option<::std::string::String> {
136 self.inner.get_alias()
137 }
138 /// <p>The ID of the asset in which the asset property was created. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
139 pub fn asset_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
140 self.inner = self.inner.asset_id(input.into());
141 self
142 }
143 /// <p>The ID of the asset in which the asset property was created. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
144 pub fn set_asset_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
145 self.inner = self.inner.set_asset_id(input);
146 self
147 }
148 /// <p>The ID of the asset in which the asset property was created. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
149 pub fn get_asset_id(&self) -> &::std::option::Option<::std::string::String> {
150 self.inner.get_asset_id()
151 }
152 /// <p>The ID of the asset property. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
153 pub fn property_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
154 self.inner = self.inner.property_id(input.into());
155 self
156 }
157 /// <p>The ID of the asset property. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
158 pub fn set_property_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
159 self.inner = self.inner.set_property_id(input);
160 self
161 }
162 /// <p>The ID of the asset property. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
163 pub fn get_property_id(&self) -> &::std::option::Option<::std::string::String> {
164 self.inner.get_property_id()
165 }
166 /// <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
167 pub fn client_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
168 self.inner = self.inner.client_token(input.into());
169 self
170 }
171 /// <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
172 pub fn set_client_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
173 self.inner = self.inner.set_client_token(input);
174 self
175 }
176 /// <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
177 pub fn get_client_token(&self) -> &::std::option::Option<::std::string::String> {
178 self.inner.get_client_token()
179 }
180}