aws_sdk_deadline/operation/start_sessions_statistics_aggregation/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::start_sessions_statistics_aggregation::_start_sessions_statistics_aggregation_output::StartSessionsStatisticsAggregationOutputBuilder;
3
4pub use crate::operation::start_sessions_statistics_aggregation::_start_sessions_statistics_aggregation_input::StartSessionsStatisticsAggregationInputBuilder;
5
6impl crate::operation::start_sessions_statistics_aggregation::builders::StartSessionsStatisticsAggregationInputBuilder {
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::start_sessions_statistics_aggregation::StartSessionsStatisticsAggregationOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::start_sessions_statistics_aggregation::StartSessionsStatisticsAggregationError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.start_sessions_statistics_aggregation();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `StartSessionsStatisticsAggregation`.
24///
25/// <p>Starts an asynchronous request for getting aggregated statistics about queues and farms. Get the statistics using the <code>GetSessionsStatisticsAggregation</code> operation. You can only have one running aggregation for your Deadline Cloud farm. Call the <code>GetSessionsStatisticsAggregation</code> operation and check the <code>status</code> field to see if an aggregation is running. Statistics are available for 1 hour after you call the <code>StartSessionsStatisticsAggregation</code> operation.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct StartSessionsStatisticsAggregationFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::start_sessions_statistics_aggregation::builders::StartSessionsStatisticsAggregationInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::start_sessions_statistics_aggregation::StartSessionsStatisticsAggregationOutput,
35        crate::operation::start_sessions_statistics_aggregation::StartSessionsStatisticsAggregationError,
36    > for StartSessionsStatisticsAggregationFluentBuilder
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::start_sessions_statistics_aggregation::StartSessionsStatisticsAggregationOutput,
44            crate::operation::start_sessions_statistics_aggregation::StartSessionsStatisticsAggregationError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl StartSessionsStatisticsAggregationFluentBuilder {
51    /// Creates a new `StartSessionsStatisticsAggregationFluentBuilder`.
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 StartSessionsStatisticsAggregation as a reference.
60    pub fn as_input(&self) -> &crate::operation::start_sessions_statistics_aggregation::builders::StartSessionsStatisticsAggregationInputBuilder {
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::start_sessions_statistics_aggregation::StartSessionsStatisticsAggregationOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::start_sessions_statistics_aggregation::StartSessionsStatisticsAggregationError,
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::start_sessions_statistics_aggregation::StartSessionsStatisticsAggregation::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::start_sessions_statistics_aggregation::StartSessionsStatisticsAggregation::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::start_sessions_statistics_aggregation::StartSessionsStatisticsAggregationOutput,
97        crate::operation::start_sessions_statistics_aggregation::StartSessionsStatisticsAggregationError,
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 identifier of the farm that contains queues or fleets to return statistics for.</p>
112    pub fn farm_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
113        self.inner = self.inner.farm_id(input.into());
114        self
115    }
116    /// <p>The identifier of the farm that contains queues or fleets to return statistics for.</p>
117    pub fn set_farm_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
118        self.inner = self.inner.set_farm_id(input);
119        self
120    }
121    /// <p>The identifier of the farm that contains queues or fleets to return statistics for.</p>
122    pub fn get_farm_id(&self) -> &::std::option::Option<::std::string::String> {
123        self.inner.get_farm_id()
124    }
125    /// <p>A list of fleet IDs or queue IDs to gather statistics for.</p>
126    pub fn resource_ids(mut self, input: crate::types::SessionsStatisticsResources) -> Self {
127        self.inner = self.inner.resource_ids(input);
128        self
129    }
130    /// <p>A list of fleet IDs or queue IDs to gather statistics for.</p>
131    pub fn set_resource_ids(mut self, input: ::std::option::Option<crate::types::SessionsStatisticsResources>) -> Self {
132        self.inner = self.inner.set_resource_ids(input);
133        self
134    }
135    /// <p>A list of fleet IDs or queue IDs to gather statistics for.</p>
136    pub fn get_resource_ids(&self) -> &::std::option::Option<crate::types::SessionsStatisticsResources> {
137        self.inner.get_resource_ids()
138    }
139    /// <p>The Linux timestamp of the date and time that the statistics start.</p>
140    pub fn start_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
141        self.inner = self.inner.start_time(input);
142        self
143    }
144    /// <p>The Linux timestamp of the date and time that the statistics start.</p>
145    pub fn set_start_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
146        self.inner = self.inner.set_start_time(input);
147        self
148    }
149    /// <p>The Linux timestamp of the date and time that the statistics start.</p>
150    pub fn get_start_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
151        self.inner.get_start_time()
152    }
153    /// <p>The Linux timestamp of the date and time that the statistics end.</p>
154    pub fn end_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
155        self.inner = self.inner.end_time(input);
156        self
157    }
158    /// <p>The Linux timestamp of the date and time that the statistics end.</p>
159    pub fn set_end_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
160        self.inner = self.inner.set_end_time(input);
161        self
162    }
163    /// <p>The Linux timestamp of the date and time that the statistics end.</p>
164    pub fn get_end_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
165        self.inner.get_end_time()
166    }
167    /// <p>The timezone to use for the statistics. Use UTC notation such as "UTC+8."</p>
168    pub fn timezone(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
169        self.inner = self.inner.timezone(input.into());
170        self
171    }
172    /// <p>The timezone to use for the statistics. Use UTC notation such as "UTC+8."</p>
173    pub fn set_timezone(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
174        self.inner = self.inner.set_timezone(input);
175        self
176    }
177    /// <p>The timezone to use for the statistics. Use UTC notation such as "UTC+8."</p>
178    pub fn get_timezone(&self) -> &::std::option::Option<::std::string::String> {
179        self.inner.get_timezone()
180    }
181    /// <p>The period to aggregate the statistics.</p>
182    pub fn period(mut self, input: crate::types::Period) -> Self {
183        self.inner = self.inner.period(input);
184        self
185    }
186    /// <p>The period to aggregate the statistics.</p>
187    pub fn set_period(mut self, input: ::std::option::Option<crate::types::Period>) -> Self {
188        self.inner = self.inner.set_period(input);
189        self
190    }
191    /// <p>The period to aggregate the statistics.</p>
192    pub fn get_period(&self) -> &::std::option::Option<crate::types::Period> {
193        self.inner.get_period()
194    }
195    ///
196    /// Appends an item to `groupBy`.
197    ///
198    /// To override the contents of this collection use [`set_group_by`](Self::set_group_by).
199    ///
200    /// <p>The field to use to group the statistics.</p>
201    pub fn group_by(mut self, input: crate::types::UsageGroupByField) -> Self {
202        self.inner = self.inner.group_by(input);
203        self
204    }
205    /// <p>The field to use to group the statistics.</p>
206    pub fn set_group_by(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::UsageGroupByField>>) -> Self {
207        self.inner = self.inner.set_group_by(input);
208        self
209    }
210    /// <p>The field to use to group the statistics.</p>
211    pub fn get_group_by(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::UsageGroupByField>> {
212        self.inner.get_group_by()
213    }
214    ///
215    /// Appends an item to `statistics`.
216    ///
217    /// To override the contents of this collection use [`set_statistics`](Self::set_statistics).
218    ///
219    /// <p>One to four statistics to return.</p>
220    pub fn statistics(mut self, input: crate::types::UsageStatistic) -> Self {
221        self.inner = self.inner.statistics(input);
222        self
223    }
224    /// <p>One to four statistics to return.</p>
225    pub fn set_statistics(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::UsageStatistic>>) -> Self {
226        self.inner = self.inner.set_statistics(input);
227        self
228    }
229    /// <p>One to four statistics to return.</p>
230    pub fn get_statistics(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::UsageStatistic>> {
231        self.inner.get_statistics()
232    }
233}
aws_sdk_deadline/operation/start_sessions_statistics_aggregation/builders.rs

aws_sdk_deadline/operation/start_sessions_statistics_aggregation/
builders.rs
