1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
/// <p>Provides information about a forecast. Returned as part of the <code>QueryForecast</code> response.</p>
#[non_exhaustive]
#[derive(std::clone::Clone, std::cmp::PartialEq, std::fmt::Debug)]
pub struct Forecast {
/// <p>The forecast.</p>
/// <p>The <i>string</i> of the string-to-array map is one of the following values:</p>
/// <ul>
/// <li> <p>p10</p> </li>
/// <li> <p>p50</p> </li>
/// <li> <p>p90</p> </li>
/// </ul>
/// <p>The default setting is <code>["0.1", "0.5", "0.9"]</code>. Use the optional <code>ForecastTypes</code> parameter of the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateForecast.html">CreateForecast</a> operation to change the values. The values will vary depending on how this is set, with a minimum of <code>1</code> and a maximum of <code>5.</code> </p>
#[doc(hidden)]
pub predictions: std::option::Option<
std::collections::HashMap<std::string::String, std::vec::Vec<crate::model::DataPoint>>,
>,
}
impl Forecast {
/// <p>The forecast.</p>
/// <p>The <i>string</i> of the string-to-array map is one of the following values:</p>
/// <ul>
/// <li> <p>p10</p> </li>
/// <li> <p>p50</p> </li>
/// <li> <p>p90</p> </li>
/// </ul>
/// <p>The default setting is <code>["0.1", "0.5", "0.9"]</code>. Use the optional <code>ForecastTypes</code> parameter of the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateForecast.html">CreateForecast</a> operation to change the values. The values will vary depending on how this is set, with a minimum of <code>1</code> and a maximum of <code>5.</code> </p>
pub fn predictions(
&self,
) -> std::option::Option<
&std::collections::HashMap<std::string::String, std::vec::Vec<crate::model::DataPoint>>,
> {
self.predictions.as_ref()
}
}
/// See [`Forecast`](crate::model::Forecast).
pub mod forecast {
/// A builder for [`Forecast`](crate::model::Forecast).
#[derive(std::clone::Clone, std::cmp::PartialEq, std::default::Default, std::fmt::Debug)]
pub struct Builder {
pub(crate) predictions: std::option::Option<
std::collections::HashMap<std::string::String, std::vec::Vec<crate::model::DataPoint>>,
>,
}
impl Builder {
/// Adds a key-value pair to `predictions`.
///
/// To override the contents of this collection use [`set_predictions`](Self::set_predictions).
///
/// <p>The forecast.</p>
/// <p>The <i>string</i> of the string-to-array map is one of the following values:</p>
/// <ul>
/// <li> <p>p10</p> </li>
/// <li> <p>p50</p> </li>
/// <li> <p>p90</p> </li>
/// </ul>
/// <p>The default setting is <code>["0.1", "0.5", "0.9"]</code>. Use the optional <code>ForecastTypes</code> parameter of the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateForecast.html">CreateForecast</a> operation to change the values. The values will vary depending on how this is set, with a minimum of <code>1</code> and a maximum of <code>5.</code> </p>
pub fn predictions(
mut self,
k: impl Into<std::string::String>,
v: std::vec::Vec<crate::model::DataPoint>,
) -> Self {
let mut hash_map = self.predictions.unwrap_or_default();
hash_map.insert(k.into(), v);
self.predictions = Some(hash_map);
self
}
/// <p>The forecast.</p>
/// <p>The <i>string</i> of the string-to-array map is one of the following values:</p>
/// <ul>
/// <li> <p>p10</p> </li>
/// <li> <p>p50</p> </li>
/// <li> <p>p90</p> </li>
/// </ul>
/// <p>The default setting is <code>["0.1", "0.5", "0.9"]</code>. Use the optional <code>ForecastTypes</code> parameter of the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateForecast.html">CreateForecast</a> operation to change the values. The values will vary depending on how this is set, with a minimum of <code>1</code> and a maximum of <code>5.</code> </p>
pub fn set_predictions(
mut self,
input: std::option::Option<
std::collections::HashMap<
std::string::String,
std::vec::Vec<crate::model::DataPoint>,
>,
>,
) -> Self {
self.predictions = input;
self
}
/// Consumes the builder and constructs a [`Forecast`](crate::model::Forecast).
pub fn build(self) -> crate::model::Forecast {
crate::model::Forecast {
predictions: self.predictions,
}
}
}
}
impl Forecast {
/// Creates a new builder-style object to manufacture [`Forecast`](crate::model::Forecast).
pub fn builder() -> crate::model::forecast::Builder {
crate::model::forecast::Builder::default()
}
}
/// <p>The forecast value for a specific date. Part of the <code>Forecast</code> object.</p>
#[non_exhaustive]
#[derive(std::clone::Clone, std::cmp::PartialEq, std::fmt::Debug)]
pub struct DataPoint {
/// <p>The timestamp of the specific forecast.</p>
#[doc(hidden)]
pub timestamp: std::option::Option<std::string::String>,
/// <p>The forecast value.</p>
#[doc(hidden)]
pub value: std::option::Option<f64>,
}
impl DataPoint {
/// <p>The timestamp of the specific forecast.</p>
pub fn timestamp(&self) -> std::option::Option<&str> {
self.timestamp.as_deref()
}
/// <p>The forecast value.</p>
pub fn value(&self) -> std::option::Option<f64> {
self.value
}
}
/// See [`DataPoint`](crate::model::DataPoint).
pub mod data_point {
/// A builder for [`DataPoint`](crate::model::DataPoint).
#[derive(std::clone::Clone, std::cmp::PartialEq, std::default::Default, std::fmt::Debug)]
pub struct Builder {
pub(crate) timestamp: std::option::Option<std::string::String>,
pub(crate) value: std::option::Option<f64>,
}
impl Builder {
/// <p>The timestamp of the specific forecast.</p>
pub fn timestamp(mut self, input: impl Into<std::string::String>) -> Self {
self.timestamp = Some(input.into());
self
}
/// <p>The timestamp of the specific forecast.</p>
pub fn set_timestamp(mut self, input: std::option::Option<std::string::String>) -> Self {
self.timestamp = input;
self
}
/// <p>The forecast value.</p>
pub fn value(mut self, input: f64) -> Self {
self.value = Some(input);
self
}
/// <p>The forecast value.</p>
pub fn set_value(mut self, input: std::option::Option<f64>) -> Self {
self.value = input;
self
}
/// Consumes the builder and constructs a [`DataPoint`](crate::model::DataPoint).
pub fn build(self) -> crate::model::DataPoint {
crate::model::DataPoint {
timestamp: self.timestamp,
value: self.value,
}
}
}
}
impl DataPoint {
/// Creates a new builder-style object to manufacture [`DataPoint`](crate::model::DataPoint).
pub fn builder() -> crate::model::data_point::Builder {
crate::model::data_point::Builder::default()
}
}