aws-sdk-cloudwatch 1.109.1

AWS SDK for Amazon CloudWatch
Documentation 
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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.

/// <p>Encapsulates the statistical data that CloudWatch computes from metric data.</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct Datapoint {
    /// <p>The time stamp used for the data point.</p>
    pub timestamp: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>The number of metric values that contributed to the aggregate value of this data point.</p>
    pub sample_count: ::std::option::Option<f64>,
    /// <p>The average of the metric values that correspond to the data point.</p>
    pub average: ::std::option::Option<f64>,
    /// <p>The sum of the metric values for the data point.</p>
    pub sum: ::std::option::Option<f64>,
    /// <p>The minimum metric value for the data point.</p>
    pub minimum: ::std::option::Option<f64>,
    /// <p>The maximum metric value for the data point.</p>
    pub maximum: ::std::option::Option<f64>,
    /// <p>The standard unit for the data point.</p>
    pub unit: ::std::option::Option<crate::types::StandardUnit>,
    /// <p>The percentile statistic for the data point.</p>
    pub extended_statistics: ::std::option::Option<::std::collections::HashMap<::std::string::String, f64>>,
}
impl Datapoint {
    /// <p>The time stamp used for the data point.</p>
    pub fn timestamp(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.timestamp.as_ref()
    }
    /// <p>The number of metric values that contributed to the aggregate value of this data point.</p>
    pub fn sample_count(&self) -> ::std::option::Option<f64> {
        self.sample_count
    }
    /// <p>The average of the metric values that correspond to the data point.</p>
    pub fn average(&self) -> ::std::option::Option<f64> {
        self.average
    }
    /// <p>The sum of the metric values for the data point.</p>
    pub fn sum(&self) -> ::std::option::Option<f64> {
        self.sum
    }
    /// <p>The minimum metric value for the data point.</p>
    pub fn minimum(&self) -> ::std::option::Option<f64> {
        self.minimum
    }
    /// <p>The maximum metric value for the data point.</p>
    pub fn maximum(&self) -> ::std::option::Option<f64> {
        self.maximum
    }
    /// <p>The standard unit for the data point.</p>
    pub fn unit(&self) -> ::std::option::Option<&crate::types::StandardUnit> {
        self.unit.as_ref()
    }
    /// <p>The percentile statistic for the data point.</p>
    pub fn extended_statistics(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, f64>> {
        self.extended_statistics.as_ref()
    }
}
impl Datapoint {
    /// Creates a new builder-style object to manufacture [`Datapoint`](crate::types::Datapoint).
    pub fn builder() -> crate::types::builders::DatapointBuilder {
        crate::types::builders::DatapointBuilder::default()
    }
}

/// A builder for [`Datapoint`](crate::types::Datapoint).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct DatapointBuilder {
    pub(crate) timestamp: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) sample_count: ::std::option::Option<f64>,
    pub(crate) average: ::std::option::Option<f64>,
    pub(crate) sum: ::std::option::Option<f64>,
    pub(crate) minimum: ::std::option::Option<f64>,
    pub(crate) maximum: ::std::option::Option<f64>,
    pub(crate) unit: ::std::option::Option<crate::types::StandardUnit>,
    pub(crate) extended_statistics: ::std::option::Option<::std::collections::HashMap<::std::string::String, f64>>,
}
impl DatapointBuilder {
    /// <p>The time stamp used for the data point.</p>
    pub fn timestamp(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.timestamp = ::std::option::Option::Some(input);
        self
    }
    /// <p>The time stamp used for the data point.</p>
    pub fn set_timestamp(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.timestamp = input;
        self
    }
    /// <p>The time stamp used for the data point.</p>
    pub fn get_timestamp(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.timestamp
    }
    /// <p>The number of metric values that contributed to the aggregate value of this data point.</p>
    pub fn sample_count(mut self, input: f64) -> Self {
        self.sample_count = ::std::option::Option::Some(input);
        self
    }
    /// <p>The number of metric values that contributed to the aggregate value of this data point.</p>
    pub fn set_sample_count(mut self, input: ::std::option::Option<f64>) -> Self {
        self.sample_count = input;
        self
    }
    /// <p>The number of metric values that contributed to the aggregate value of this data point.</p>
    pub fn get_sample_count(&self) -> &::std::option::Option<f64> {
        &self.sample_count
    }
    /// <p>The average of the metric values that correspond to the data point.</p>
    pub fn average(mut self, input: f64) -> Self {
        self.average = ::std::option::Option::Some(input);
        self
    }
    /// <p>The average of the metric values that correspond to the data point.</p>
    pub fn set_average(mut self, input: ::std::option::Option<f64>) -> Self {
        self.average = input;
        self
    }
    /// <p>The average of the metric values that correspond to the data point.</p>
    pub fn get_average(&self) -> &::std::option::Option<f64> {
        &self.average
    }
    /// <p>The sum of the metric values for the data point.</p>
    pub fn sum(mut self, input: f64) -> Self {
        self.sum = ::std::option::Option::Some(input);
        self
    }
    /// <p>The sum of the metric values for the data point.</p>
    pub fn set_sum(mut self, input: ::std::option::Option<f64>) -> Self {
        self.sum = input;
        self
    }
    /// <p>The sum of the metric values for the data point.</p>
    pub fn get_sum(&self) -> &::std::option::Option<f64> {
        &self.sum
    }
    /// <p>The minimum metric value for the data point.</p>
    pub fn minimum(mut self, input: f64) -> Self {
        self.minimum = ::std::option::Option::Some(input);
        self
    }
    /// <p>The minimum metric value for the data point.</p>
    pub fn set_minimum(mut self, input: ::std::option::Option<f64>) -> Self {
        self.minimum = input;
        self
    }
    /// <p>The minimum metric value for the data point.</p>
    pub fn get_minimum(&self) -> &::std::option::Option<f64> {
        &self.minimum
    }
    /// <p>The maximum metric value for the data point.</p>
    pub fn maximum(mut self, input: f64) -> Self {
        self.maximum = ::std::option::Option::Some(input);
        self
    }
    /// <p>The maximum metric value for the data point.</p>
    pub fn set_maximum(mut self, input: ::std::option::Option<f64>) -> Self {
        self.maximum = input;
        self
    }
    /// <p>The maximum metric value for the data point.</p>
    pub fn get_maximum(&self) -> &::std::option::Option<f64> {
        &self.maximum
    }
    /// <p>The standard unit for the data point.</p>
    pub fn unit(mut self, input: crate::types::StandardUnit) -> Self {
        self.unit = ::std::option::Option::Some(input);
        self
    }
    /// <p>The standard unit for the data point.</p>
    pub fn set_unit(mut self, input: ::std::option::Option<crate::types::StandardUnit>) -> Self {
        self.unit = input;
        self
    }
    /// <p>The standard unit for the data point.</p>
    pub fn get_unit(&self) -> &::std::option::Option<crate::types::StandardUnit> {
        &self.unit
    }
    /// Adds a key-value pair to `extended_statistics`.
    ///
    /// To override the contents of this collection use [`set_extended_statistics`](Self::set_extended_statistics).
    ///
    /// <p>The percentile statistic for the data point.</p>
    pub fn extended_statistics(mut self, k: impl ::std::convert::Into<::std::string::String>, v: f64) -> Self {
        let mut hash_map = self.extended_statistics.unwrap_or_default();
        hash_map.insert(k.into(), v);
        self.extended_statistics = ::std::option::Option::Some(hash_map);
        self
    }
    /// <p>The percentile statistic for the data point.</p>
    pub fn set_extended_statistics(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, f64>>) -> Self {
        self.extended_statistics = input;
        self
    }
    /// <p>The percentile statistic for the data point.</p>
    pub fn get_extended_statistics(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, f64>> {
        &self.extended_statistics
    }
    /// Consumes the builder and constructs a [`Datapoint`](crate::types::Datapoint).
    pub fn build(self) -> crate::types::Datapoint {
        crate::types::Datapoint {
            timestamp: self.timestamp,
            sample_count: self.sample_count,
            average: self.average,
            sum: self.sum,
            minimum: self.minimum,
            maximum: self.maximum,
            unit: self.unit,
            extended_statistics: self.extended_statistics,
        }
    }
}