aws_sdk_forecastquery/operation/query_forecast/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::query_forecast::_query_forecast_output::QueryForecastOutputBuilder;
3
4pub use crate::operation::query_forecast::_query_forecast_input::QueryForecastInputBuilder;
5
6impl crate::operation::query_forecast::builders::QueryForecastInputBuilder {
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_forecast::QueryForecastOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::query_forecast::QueryForecastError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.query_forecast();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `QueryForecast`.
24///
25/// <p>Retrieves a forecast for a single item, filtered by the supplied criteria.</p>
26/// <p>The criteria is a key-value pair. The key is either <code>item_id</code> (or the equivalent non-timestamp, non-target field) from the <code>TARGET_TIME_SERIES</code> dataset, or one of the forecast dimensions specified as part of the <code>FeaturizationConfig</code> object.</p>
27/// <p>By default, <code>QueryForecast</code> returns the complete date range for the filtered forecast. You can request a specific date range.</p>
28/// <p>To get the full forecast, use the <a href="https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateForecastExportJob.html">CreateForecastExportJob</a> operation.</p><note>
29/// <p>The forecasts generated by Amazon Forecast are in the same timezone as the dataset that was used to create the predictor.</p>
30/// </note>
31#[derive(::std::clone::Clone, ::std::fmt::Debug)]
32pub struct QueryForecastFluentBuilder {
33    handle: ::std::sync::Arc<crate::client::Handle>,
34    inner: crate::operation::query_forecast::builders::QueryForecastInputBuilder,
35    config_override: ::std::option::Option<crate::config::Builder>,
36}
37impl
38    crate::client::customize::internal::CustomizableSend<
39        crate::operation::query_forecast::QueryForecastOutput,
40        crate::operation::query_forecast::QueryForecastError,
41    > for QueryForecastFluentBuilder
42{
43    fn send(
44        self,
45        config_override: crate::config::Builder,
46    ) -> crate::client::customize::internal::BoxFuture<
47        crate::client::customize::internal::SendResult<
48            crate::operation::query_forecast::QueryForecastOutput,
49            crate::operation::query_forecast::QueryForecastError,
50        >,
51    > {
52        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
53    }
54}
55impl QueryForecastFluentBuilder {
56    /// Creates a new `QueryForecastFluentBuilder`.
57    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
58        Self {
59            handle,
60            inner: ::std::default::Default::default(),
61            config_override: ::std::option::Option::None,
62        }
63    }
64    /// Access the QueryForecast as a reference.
65    pub fn as_input(&self) -> &crate::operation::query_forecast::builders::QueryForecastInputBuilder {
66        &self.inner
67    }
68    /// Sends the request and returns the response.
69    ///
70    /// If an error occurs, an `SdkError` will be returned with additional details that
71    /// can be matched against.
72    ///
73    /// By default, any retryable failures will be retried twice. Retry behavior
74    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
75    /// set when configuring the client.
76    pub async fn send(
77        self,
78    ) -> ::std::result::Result<
79        crate::operation::query_forecast::QueryForecastOutput,
80        ::aws_smithy_runtime_api::client::result::SdkError<
81            crate::operation::query_forecast::QueryForecastError,
82            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
83        >,
84    > {
85        let input = self
86            .inner
87            .build()
88            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
89        let runtime_plugins = crate::operation::query_forecast::QueryForecast::operation_runtime_plugins(
90            self.handle.runtime_plugins.clone(),
91            &self.handle.conf,
92            self.config_override,
93        );
94        crate::operation::query_forecast::QueryForecast::orchestrate(&runtime_plugins, input).await
95    }
96
97    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
98    pub fn customize(
99        self,
100    ) -> crate::client::customize::CustomizableOperation<
101        crate::operation::query_forecast::QueryForecastOutput,
102        crate::operation::query_forecast::QueryForecastError,
103        Self,
104    > {
105        crate::client::customize::CustomizableOperation::new(self)
106    }
107    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
108        self.set_config_override(::std::option::Option::Some(config_override.into()));
109        self
110    }
111
112    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
113        self.config_override = config_override;
114        self
115    }
116    /// <p>The Amazon Resource Name (ARN) of the forecast to query.</p>
117    pub fn forecast_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
118        self.inner = self.inner.forecast_arn(input.into());
119        self
120    }
121    /// <p>The Amazon Resource Name (ARN) of the forecast to query.</p>
122    pub fn set_forecast_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
123        self.inner = self.inner.set_forecast_arn(input);
124        self
125    }
126    /// <p>The Amazon Resource Name (ARN) of the forecast to query.</p>
127    pub fn get_forecast_arn(&self) -> &::std::option::Option<::std::string::String> {
128        self.inner.get_forecast_arn()
129    }
130    /// <p>The start date for the 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 start_date(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
132        self.inner = self.inner.start_date(input.into());
133        self
134    }
135    /// <p>The start date for the 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 set_start_date(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
137        self.inner = self.inner.set_start_date(input);
138        self
139    }
140    /// <p>The start date for the 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>
141    pub fn get_start_date(&self) -> &::std::option::Option<::std::string::String> {
142        self.inner.get_start_date()
143    }
144    /// <p>The end date for the 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 end_date(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
146        self.inner = self.inner.end_date(input.into());
147        self
148    }
149    /// <p>The end date for the 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 set_end_date(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
151        self.inner = self.inner.set_end_date(input);
152        self
153    }
154    /// <p>The end date for the 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>
155    pub fn get_end_date(&self) -> &::std::option::Option<::std::string::String> {
156        self.inner.get_end_date()
157    }
158    ///
159    /// Adds a key-value pair to `Filters`.
160    ///
161    /// To override the contents of this collection use [`set_filters`](Self::set_filters).
162    ///
163    /// <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>
164    /// <p><code>{"item_id" : "client_21"}</code></p>
165    /// <p>To get the full forecast, use the <a href="https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateForecastExportJob.html">CreateForecastExportJob</a> operation.</p>
166    pub fn filters(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
167        self.inner = self.inner.filters(k.into(), v.into());
168        self
169    }
170    /// <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>
171    /// <p><code>{"item_id" : "client_21"}</code></p>
172    /// <p>To get the full forecast, use the <a href="https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateForecastExportJob.html">CreateForecastExportJob</a> operation.</p>
173    pub fn set_filters(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
174        self.inner = self.inner.set_filters(input);
175        self
176    }
177    /// <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>
178    /// <p><code>{"item_id" : "client_21"}</code></p>
179    /// <p>To get the full forecast, use the <a href="https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateForecastExportJob.html">CreateForecastExportJob</a> operation.</p>
180    pub fn get_filters(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
181        self.inner.get_filters()
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 next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
185        self.inner = self.inner.next_token(input.into());
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 set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
190        self.inner = self.inner.set_next_token(input);
191        self
192    }
193    /// <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>
194    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
195        self.inner.get_next_token()
196    }
197}
aws_sdk_forecastquery/operation/query_forecast/builders.rs

aws_sdk_forecastquery/operation/query_forecast/
builders.rs
