aws_sdk_sagemaker/operation/list_trial_components/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::list_trial_components::_list_trial_components_output::ListTrialComponentsOutputBuilder;
3
4pub use crate::operation::list_trial_components::_list_trial_components_input::ListTrialComponentsInputBuilder;
5
6impl crate::operation::list_trial_components::builders::ListTrialComponentsInputBuilder {
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::list_trial_components::ListTrialComponentsOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::list_trial_components::ListTrialComponentsError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.list_trial_components();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `ListTrialComponents`.
24///
25/// <p>Lists the trial components in your account. You can sort the list by trial component name or creation time. You can filter the list to show only components that were created in a specific time range. You can also filter on one of the following:</p>
26/// <ul>
27/// <li>
28/// <p><code>ExperimentName</code></p></li>
29/// <li>
30/// <p><code>SourceArn</code></p></li>
31/// <li>
32/// <p><code>TrialName</code></p></li>
33/// </ul>
34#[derive(::std::clone::Clone, ::std::fmt::Debug)]
35pub struct ListTrialComponentsFluentBuilder {
36    handle: ::std::sync::Arc<crate::client::Handle>,
37    inner: crate::operation::list_trial_components::builders::ListTrialComponentsInputBuilder,
38    config_override: ::std::option::Option<crate::config::Builder>,
39}
40impl
41    crate::client::customize::internal::CustomizableSend<
42        crate::operation::list_trial_components::ListTrialComponentsOutput,
43        crate::operation::list_trial_components::ListTrialComponentsError,
44    > for ListTrialComponentsFluentBuilder
45{
46    fn send(
47        self,
48        config_override: crate::config::Builder,
49    ) -> crate::client::customize::internal::BoxFuture<
50        crate::client::customize::internal::SendResult<
51            crate::operation::list_trial_components::ListTrialComponentsOutput,
52            crate::operation::list_trial_components::ListTrialComponentsError,
53        >,
54    > {
55        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
56    }
57}
58impl ListTrialComponentsFluentBuilder {
59    /// Creates a new `ListTrialComponentsFluentBuilder`.
60    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
61        Self {
62            handle,
63            inner: ::std::default::Default::default(),
64            config_override: ::std::option::Option::None,
65        }
66    }
67    /// Access the ListTrialComponents as a reference.
68    pub fn as_input(&self) -> &crate::operation::list_trial_components::builders::ListTrialComponentsInputBuilder {
69        &self.inner
70    }
71    /// Sends the request and returns the response.
72    ///
73    /// If an error occurs, an `SdkError` will be returned with additional details that
74    /// can be matched against.
75    ///
76    /// By default, any retryable failures will be retried twice. Retry behavior
77    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
78    /// set when configuring the client.
79    pub async fn send(
80        self,
81    ) -> ::std::result::Result<
82        crate::operation::list_trial_components::ListTrialComponentsOutput,
83        ::aws_smithy_runtime_api::client::result::SdkError<
84            crate::operation::list_trial_components::ListTrialComponentsError,
85            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
86        >,
87    > {
88        let input = self
89            .inner
90            .build()
91            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
92        let runtime_plugins = crate::operation::list_trial_components::ListTrialComponents::operation_runtime_plugins(
93            self.handle.runtime_plugins.clone(),
94            &self.handle.conf,
95            self.config_override,
96        );
97        crate::operation::list_trial_components::ListTrialComponents::orchestrate(&runtime_plugins, input).await
98    }
99
100    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
101    pub fn customize(
102        self,
103    ) -> crate::client::customize::CustomizableOperation<
104        crate::operation::list_trial_components::ListTrialComponentsOutput,
105        crate::operation::list_trial_components::ListTrialComponentsError,
106        Self,
107    > {
108        crate::client::customize::CustomizableOperation::new(self)
109    }
110    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
111        self.set_config_override(::std::option::Option::Some(config_override.into()));
112        self
113    }
114
115    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
116        self.config_override = config_override;
117        self
118    }
119    /// Create a paginator for this request
120    ///
121    /// Paginators are used by calling [`send().await`](crate::operation::list_trial_components::paginator::ListTrialComponentsPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
122    pub fn into_paginator(self) -> crate::operation::list_trial_components::paginator::ListTrialComponentsPaginator {
123        crate::operation::list_trial_components::paginator::ListTrialComponentsPaginator::new(self.handle, self.inner)
124    }
125    /// <p>A filter that returns only components that are part of the specified experiment. If you specify <code>ExperimentName</code>, you can't filter by <code>SourceArn</code> or <code>TrialName</code>.</p>
126    pub fn experiment_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
127        self.inner = self.inner.experiment_name(input.into());
128        self
129    }
130    /// <p>A filter that returns only components that are part of the specified experiment. If you specify <code>ExperimentName</code>, you can't filter by <code>SourceArn</code> or <code>TrialName</code>.</p>
131    pub fn set_experiment_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
132        self.inner = self.inner.set_experiment_name(input);
133        self
134    }
135    /// <p>A filter that returns only components that are part of the specified experiment. If you specify <code>ExperimentName</code>, you can't filter by <code>SourceArn</code> or <code>TrialName</code>.</p>
136    pub fn get_experiment_name(&self) -> &::std::option::Option<::std::string::String> {
137        self.inner.get_experiment_name()
138    }
139    /// <p>A filter that returns only components that are part of the specified trial. If you specify <code>TrialName</code>, you can't filter by <code>ExperimentName</code> or <code>SourceArn</code>.</p>
140    pub fn trial_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
141        self.inner = self.inner.trial_name(input.into());
142        self
143    }
144    /// <p>A filter that returns only components that are part of the specified trial. If you specify <code>TrialName</code>, you can't filter by <code>ExperimentName</code> or <code>SourceArn</code>.</p>
145    pub fn set_trial_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
146        self.inner = self.inner.set_trial_name(input);
147        self
148    }
149    /// <p>A filter that returns only components that are part of the specified trial. If you specify <code>TrialName</code>, you can't filter by <code>ExperimentName</code> or <code>SourceArn</code>.</p>
150    pub fn get_trial_name(&self) -> &::std::option::Option<::std::string::String> {
151        self.inner.get_trial_name()
152    }
153    /// <p>A filter that returns only components that have the specified source Amazon Resource Name (ARN). If you specify <code>SourceArn</code>, you can't filter by <code>ExperimentName</code> or <code>TrialName</code>.</p>
154    pub fn source_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
155        self.inner = self.inner.source_arn(input.into());
156        self
157    }
158    /// <p>A filter that returns only components that have the specified source Amazon Resource Name (ARN). If you specify <code>SourceArn</code>, you can't filter by <code>ExperimentName</code> or <code>TrialName</code>.</p>
159    pub fn set_source_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
160        self.inner = self.inner.set_source_arn(input);
161        self
162    }
163    /// <p>A filter that returns only components that have the specified source Amazon Resource Name (ARN). If you specify <code>SourceArn</code>, you can't filter by <code>ExperimentName</code> or <code>TrialName</code>.</p>
164    pub fn get_source_arn(&self) -> &::std::option::Option<::std::string::String> {
165        self.inner.get_source_arn()
166    }
167    /// <p>A filter that returns only components created after the specified time.</p>
168    pub fn created_after(mut self, input: ::aws_smithy_types::DateTime) -> Self {
169        self.inner = self.inner.created_after(input);
170        self
171    }
172    /// <p>A filter that returns only components created after the specified time.</p>
173    pub fn set_created_after(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
174        self.inner = self.inner.set_created_after(input);
175        self
176    }
177    /// <p>A filter that returns only components created after the specified time.</p>
178    pub fn get_created_after(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
179        self.inner.get_created_after()
180    }
181    /// <p>A filter that returns only components created before the specified time.</p>
182    pub fn created_before(mut self, input: ::aws_smithy_types::DateTime) -> Self {
183        self.inner = self.inner.created_before(input);
184        self
185    }
186    /// <p>A filter that returns only components created before the specified time.</p>
187    pub fn set_created_before(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
188        self.inner = self.inner.set_created_before(input);
189        self
190    }
191    /// <p>A filter that returns only components created before the specified time.</p>
192    pub fn get_created_before(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
193        self.inner.get_created_before()
194    }
195    /// <p>The property used to sort results. The default value is <code>CreationTime</code>.</p>
196    pub fn sort_by(mut self, input: crate::types::SortTrialComponentsBy) -> Self {
197        self.inner = self.inner.sort_by(input);
198        self
199    }
200    /// <p>The property used to sort results. The default value is <code>CreationTime</code>.</p>
201    pub fn set_sort_by(mut self, input: ::std::option::Option<crate::types::SortTrialComponentsBy>) -> Self {
202        self.inner = self.inner.set_sort_by(input);
203        self
204    }
205    /// <p>The property used to sort results. The default value is <code>CreationTime</code>.</p>
206    pub fn get_sort_by(&self) -> &::std::option::Option<crate::types::SortTrialComponentsBy> {
207        self.inner.get_sort_by()
208    }
209    /// <p>The sort order. The default value is <code>Descending</code>.</p>
210    pub fn sort_order(mut self, input: crate::types::SortOrder) -> Self {
211        self.inner = self.inner.sort_order(input);
212        self
213    }
214    /// <p>The sort order. The default value is <code>Descending</code>.</p>
215    pub fn set_sort_order(mut self, input: ::std::option::Option<crate::types::SortOrder>) -> Self {
216        self.inner = self.inner.set_sort_order(input);
217        self
218    }
219    /// <p>The sort order. The default value is <code>Descending</code>.</p>
220    pub fn get_sort_order(&self) -> &::std::option::Option<crate::types::SortOrder> {
221        self.inner.get_sort_order()
222    }
223    /// <p>The maximum number of components to return in the response. The default value is 10.</p>
224    pub fn max_results(mut self, input: i32) -> Self {
225        self.inner = self.inner.max_results(input);
226        self
227    }
228    /// <p>The maximum number of components to return in the response. The default value is 10.</p>
229    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
230        self.inner = self.inner.set_max_results(input);
231        self
232    }
233    /// <p>The maximum number of components to return in the response. The default value is 10.</p>
234    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
235        self.inner.get_max_results()
236    }
237    /// <p>If the previous call to <code>ListTrialComponents</code> didn't return the full set of components, the call returns a token for getting the next set of components.</p>
238    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
239        self.inner = self.inner.next_token(input.into());
240        self
241    }
242    /// <p>If the previous call to <code>ListTrialComponents</code> didn't return the full set of components, the call returns a token for getting the next set of components.</p>
243    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
244        self.inner = self.inner.set_next_token(input);
245        self
246    }
247    /// <p>If the previous call to <code>ListTrialComponents</code> didn't return the full set of components, the call returns a token for getting the next set of components.</p>
248    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
249        self.inner.get_next_token()
250    }
251}
aws_sdk_sagemaker/operation/list_trial_components/builders.rs

aws_sdk_sagemaker/operation/list_trial_components/
builders.rs
