aws_sdk_ec2/operation/get_capacity_manager_metric_dimensions/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::get_capacity_manager_metric_dimensions::_get_capacity_manager_metric_dimensions_output::GetCapacityManagerMetricDimensionsOutputBuilder;
3
4pub use crate::operation::get_capacity_manager_metric_dimensions::_get_capacity_manager_metric_dimensions_input::GetCapacityManagerMetricDimensionsInputBuilder;
5
6impl crate::operation::get_capacity_manager_metric_dimensions::builders::GetCapacityManagerMetricDimensionsInputBuilder {
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::get_capacity_manager_metric_dimensions::GetCapacityManagerMetricDimensionsOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::get_capacity_manager_metric_dimensions::GetCapacityManagerMetricDimensionsError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.get_capacity_manager_metric_dimensions();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `GetCapacityManagerMetricDimensions`.
24///
25/// <p>Retrieves the available dimension values for capacity metrics within a specified time range. This is useful for discovering what accounts, regions, instance families, and other dimensions have data available for filtering and grouping.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct GetCapacityManagerMetricDimensionsFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::get_capacity_manager_metric_dimensions::builders::GetCapacityManagerMetricDimensionsInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::get_capacity_manager_metric_dimensions::GetCapacityManagerMetricDimensionsOutput,
35        crate::operation::get_capacity_manager_metric_dimensions::GetCapacityManagerMetricDimensionsError,
36    > for GetCapacityManagerMetricDimensionsFluentBuilder
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::get_capacity_manager_metric_dimensions::GetCapacityManagerMetricDimensionsOutput,
44            crate::operation::get_capacity_manager_metric_dimensions::GetCapacityManagerMetricDimensionsError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl GetCapacityManagerMetricDimensionsFluentBuilder {
51    /// Creates a new `GetCapacityManagerMetricDimensionsFluentBuilder`.
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 GetCapacityManagerMetricDimensions as a reference.
60    pub fn as_input(&self) -> &crate::operation::get_capacity_manager_metric_dimensions::builders::GetCapacityManagerMetricDimensionsInputBuilder {
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::get_capacity_manager_metric_dimensions::GetCapacityManagerMetricDimensionsOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::get_capacity_manager_metric_dimensions::GetCapacityManagerMetricDimensionsError,
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::get_capacity_manager_metric_dimensions::GetCapacityManagerMetricDimensions::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::get_capacity_manager_metric_dimensions::GetCapacityManagerMetricDimensions::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::get_capacity_manager_metric_dimensions::GetCapacityManagerMetricDimensionsOutput,
97        crate::operation::get_capacity_manager_metric_dimensions::GetCapacityManagerMetricDimensionsError,
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    /// Create a paginator for this request
112    ///
113    /// Paginators are used by calling [`send().await`](crate::operation::get_capacity_manager_metric_dimensions::paginator::GetCapacityManagerMetricDimensionsPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
114    pub fn into_paginator(self) -> crate::operation::get_capacity_manager_metric_dimensions::paginator::GetCapacityManagerMetricDimensionsPaginator {
115        crate::operation::get_capacity_manager_metric_dimensions::paginator::GetCapacityManagerMetricDimensionsPaginator::new(self.handle, self.inner)
116    }
117    ///
118    /// Appends an item to `GroupBy`.
119    ///
120    /// To override the contents of this collection use [`set_group_by`](Self::set_group_by).
121    ///
122    /// <p>The dimensions to group by when retrieving available dimension values. This determines which dimension combinations are returned. Required parameter.</p>
123    pub fn group_by(mut self, input: crate::types::GroupBy) -> Self {
124        self.inner = self.inner.group_by(input);
125        self
126    }
127    /// <p>The dimensions to group by when retrieving available dimension values. This determines which dimension combinations are returned. Required parameter.</p>
128    pub fn set_group_by(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::GroupBy>>) -> Self {
129        self.inner = self.inner.set_group_by(input);
130        self
131    }
132    /// <p>The dimensions to group by when retrieving available dimension values. This determines which dimension combinations are returned. Required parameter.</p>
133    pub fn get_group_by(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::GroupBy>> {
134        self.inner.get_group_by()
135    }
136    ///
137    /// Appends an item to `FilterBy`.
138    ///
139    /// To override the contents of this collection use [`set_filter_by`](Self::set_filter_by).
140    ///
141    /// <p>Conditions to filter which dimension values are returned. Each filter specifies a dimension, comparison operator, and values to match against.</p>
142    pub fn filter_by(mut self, input: crate::types::CapacityManagerCondition) -> Self {
143        self.inner = self.inner.filter_by(input);
144        self
145    }
146    /// <p>Conditions to filter which dimension values are returned. Each filter specifies a dimension, comparison operator, and values to match against.</p>
147    pub fn set_filter_by(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::CapacityManagerCondition>>) -> Self {
148        self.inner = self.inner.set_filter_by(input);
149        self
150    }
151    /// <p>Conditions to filter which dimension values are returned. Each filter specifies a dimension, comparison operator, and values to match against.</p>
152    pub fn get_filter_by(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::CapacityManagerCondition>> {
153        self.inner.get_filter_by()
154    }
155    /// <p>The start time for the dimension query, in ISO 8601 format. Only dimensions with data in this time range will be returned.</p>
156    pub fn start_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
157        self.inner = self.inner.start_time(input);
158        self
159    }
160    /// <p>The start time for the dimension query, in ISO 8601 format. Only dimensions with data in this time range will be returned.</p>
161    pub fn set_start_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
162        self.inner = self.inner.set_start_time(input);
163        self
164    }
165    /// <p>The start time for the dimension query, in ISO 8601 format. Only dimensions with data in this time range will be returned.</p>
166    pub fn get_start_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
167        self.inner.get_start_time()
168    }
169    /// <p>The end time for the dimension query, in ISO 8601 format. Only dimensions with data in this time range will be returned.</p>
170    pub fn end_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
171        self.inner = self.inner.end_time(input);
172        self
173    }
174    /// <p>The end time for the dimension query, in ISO 8601 format. Only dimensions with data in this time range will be returned.</p>
175    pub fn set_end_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
176        self.inner = self.inner.set_end_time(input);
177        self
178    }
179    /// <p>The end time for the dimension query, in ISO 8601 format. Only dimensions with data in this time range will be returned.</p>
180    pub fn get_end_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
181        self.inner.get_end_time()
182    }
183    ///
184    /// Appends an item to `MetricNames`.
185    ///
186    /// To override the contents of this collection use [`set_metric_names`](Self::set_metric_names).
187    ///
188    /// <p>The metric names to use as an additional filter when retrieving dimensions. Only dimensions that have data for these metrics will be returned. Required parameter with maximum size of 1 for v1.</p>
189    pub fn metric_names(mut self, input: crate::types::Metric) -> Self {
190        self.inner = self.inner.metric_names(input);
191        self
192    }
193    /// <p>The metric names to use as an additional filter when retrieving dimensions. Only dimensions that have data for these metrics will be returned. Required parameter with maximum size of 1 for v1.</p>
194    pub fn set_metric_names(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Metric>>) -> Self {
195        self.inner = self.inner.set_metric_names(input);
196        self
197    }
198    /// <p>The metric names to use as an additional filter when retrieving dimensions. Only dimensions that have data for these metrics will be returned. Required parameter with maximum size of 1 for v1.</p>
199    pub fn get_metric_names(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Metric>> {
200        self.inner.get_metric_names()
201    }
202    /// <p>The maximum number of dimension combinations to return. Valid range is 1 to 1000. Use with NextToken for pagination.</p>
203    pub fn max_results(mut self, input: i32) -> Self {
204        self.inner = self.inner.max_results(input);
205        self
206    }
207    /// <p>The maximum number of dimension combinations to return. Valid range is 1 to 1000. Use with NextToken for pagination.</p>
208    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
209        self.inner = self.inner.set_max_results(input);
210        self
211    }
212    /// <p>The maximum number of dimension combinations to return. Valid range is 1 to 1000. Use with NextToken for pagination.</p>
213    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
214        self.inner.get_max_results()
215    }
216    /// <p>The token for the next page of results. Use this value in a subsequent call to retrieve additional dimension values.</p>
217    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
218        self.inner = self.inner.next_token(input.into());
219        self
220    }
221    /// <p>The token for the next page of results. Use this value in a subsequent call to retrieve additional dimension values.</p>
222    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
223        self.inner = self.inner.set_next_token(input);
224        self
225    }
226    /// <p>The token for the next page of results. Use this value in a subsequent call to retrieve additional dimension values.</p>
227    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
228        self.inner.get_next_token()
229    }
230    /// <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
231    pub fn dry_run(mut self, input: bool) -> Self {
232        self.inner = self.inner.dry_run(input);
233        self
234    }
235    /// <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
236    pub fn set_dry_run(mut self, input: ::std::option::Option<bool>) -> Self {
237        self.inner = self.inner.set_dry_run(input);
238        self
239    }
240    /// <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
241    pub fn get_dry_run(&self) -> &::std::option::Option<bool> {
242        self.inner.get_dry_run()
243    }
244}