aws_sdk_forecastquery/operation/query_what_if_forecast/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::query_what_if_forecast::_query_what_if_forecast_input::QueryWhatIfForecastInputBuilder;
3
4pub use crate::operation::query_what_if_forecast::_query_what_if_forecast_output::QueryWhatIfForecastOutputBuilder;
5
6impl crate::operation::query_what_if_forecast::builders::QueryWhatIfForecastInputBuilder {
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::query_what_if_forecast::QueryWhatIfForecastOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::query_what_if_forecast::QueryWhatIfForecastError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.query_what_if_forecast();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `QueryWhatIfForecast`.
24///
25/// <p>Retrieves a what-if forecast.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct QueryWhatIfForecastFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::query_what_if_forecast::builders::QueryWhatIfForecastInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::query_what_if_forecast::QueryWhatIfForecastOutput,
35        crate::operation::query_what_if_forecast::QueryWhatIfForecastError,
36    > for QueryWhatIfForecastFluentBuilder
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::query_what_if_forecast::QueryWhatIfForecastOutput,
44            crate::operation::query_what_if_forecast::QueryWhatIfForecastError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl QueryWhatIfForecastFluentBuilder {
51    /// Creates a new `QueryWhatIfForecastFluentBuilder`.
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 QueryWhatIfForecast as a reference.
60    pub fn as_input(&self) -> &crate::operation::query_what_if_forecast::builders::QueryWhatIfForecastInputBuilder {
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::query_what_if_forecast::QueryWhatIfForecastOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::query_what_if_forecast::QueryWhatIfForecastError,
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::query_what_if_forecast::QueryWhatIfForecast::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::query_what_if_forecast::QueryWhatIfForecast::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::query_what_if_forecast::QueryWhatIfForecastOutput,
97        crate::operation::query_what_if_forecast::QueryWhatIfForecastError,
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 Amazon Resource Name (ARN) of the what-if forecast to query.</p>
112    pub fn what_if_forecast_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
113        self.inner = self.inner.what_if_forecast_arn(input.into());
114        self
115    }
116    /// <p>The Amazon Resource Name (ARN) of the what-if forecast to query.</p>
117    pub fn set_what_if_forecast_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
118        self.inner = self.inner.set_what_if_forecast_arn(input);
119        self
120    }
121    /// <p>The Amazon Resource Name (ARN) of the what-if forecast to query.</p>
122    pub fn get_what_if_forecast_arn(&self) -> &::std::option::Option<::std::string::String> {
123        self.inner.get_what_if_forecast_arn()
124    }
125    /// <p>The start date for the what-if forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T08:00:00.</p>
126    pub fn start_date(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
127        self.inner = self.inner.start_date(input.into());
128        self
129    }
130    /// <p>The start date for the what-if forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T08:00:00.</p>
131    pub fn set_start_date(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
132        self.inner = self.inner.set_start_date(input);
133        self
134    }
135    /// <p>The start date for the what-if forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T08:00:00.</p>
136    pub fn get_start_date(&self) -> &::std::option::Option<::std::string::String> {
137        self.inner.get_start_date()
138    }
139    /// <p>The end date for the what-if forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T20:00:00.</p>
140    pub fn end_date(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
141        self.inner = self.inner.end_date(input.into());
142        self
143    }
144    /// <p>The end date for the what-if forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T20:00:00.</p>
145    pub fn set_end_date(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
146        self.inner = self.inner.set_end_date(input);
147        self
148    }
149    /// <p>The end date for the what-if forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T20:00:00.</p>
150    pub fn get_end_date(&self) -> &::std::option::Option<::std::string::String> {
151        self.inner.get_end_date()
152    }
153    ///
154    /// Adds a key-value pair to `Filters`.
155    ///
156    /// To override the contents of this collection use [`set_filters`](Self::set_filters).
157    ///
158    /// <p>The filtering criteria to apply when retrieving the forecast. For example, to get the forecast for <code>client_21</code> in the electricity usage dataset, specify the following:</p>
159    /// <p><code>{"item_id" : "client_21"}</code></p>
160    /// <p>To get the full what-if forecast, use the <a href="https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateWhatIfForecastExport.html">CreateForecastExportJob</a> operation.</p>
161    pub fn filters(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
162        self.inner = self.inner.filters(k.into(), v.into());
163        self
164    }
165    /// <p>The filtering criteria to apply when retrieving the forecast. For example, to get the forecast for <code>client_21</code> in the electricity usage dataset, specify the following:</p>
166    /// <p><code>{"item_id" : "client_21"}</code></p>
167    /// <p>To get the full what-if forecast, use the <a href="https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateWhatIfForecastExport.html">CreateForecastExportJob</a> operation.</p>
168    pub fn set_filters(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
169        self.inner = self.inner.set_filters(input);
170        self
171    }
172    /// <p>The filtering criteria to apply when retrieving the forecast. For example, to get the forecast for <code>client_21</code> in the electricity usage dataset, specify the following:</p>
173    /// <p><code>{"item_id" : "client_21"}</code></p>
174    /// <p>To get the full what-if forecast, use the <a href="https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateWhatIfForecastExport.html">CreateForecastExportJob</a> operation.</p>
175    pub fn get_filters(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
176        self.inner.get_filters()
177    }
178    /// <p>If the result of the previous request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.</p>
179    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
180        self.inner = self.inner.next_token(input.into());
181        self
182    }
183    /// <p>If the result of the previous request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.</p>
184    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
185        self.inner = self.inner.set_next_token(input);
186        self
187    }
188    /// <p>If the result of the previous request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.</p>
189    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
190        self.inner.get_next_token()
191    }
192}
aws_sdk_forecastquery/operation/query_what_if_forecast/builders.rs

aws_sdk_forecastquery/operation/query_what_if_forecast/
builders.rs
