aws_sdk_robomaker/operation/list_simulation_applications/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::list_simulation_applications::_list_simulation_applications_output::ListSimulationApplicationsOutputBuilder;
3
4pub use crate::operation::list_simulation_applications::_list_simulation_applications_input::ListSimulationApplicationsInputBuilder;
5
6impl crate::operation::list_simulation_applications::builders::ListSimulationApplicationsInputBuilder {
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_simulation_applications::ListSimulationApplicationsOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::list_simulation_applications::ListSimulationApplicationsError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.list_simulation_applications();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `ListSimulationApplications`.
24///
25/// <important>
26/// <p>End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit <a href="https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/">https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/</a>.</p>
27/// </important>
28/// <p>Returns a list of simulation applications. You can optionally provide filters to retrieve specific simulation applications.</p>
29#[derive(::std::clone::Clone, ::std::fmt::Debug)]
30pub struct ListSimulationApplicationsFluentBuilder {
31 handle: ::std::sync::Arc<crate::client::Handle>,
32 inner: crate::operation::list_simulation_applications::builders::ListSimulationApplicationsInputBuilder,
33 config_override: ::std::option::Option<crate::config::Builder>,
34}
35impl
36 crate::client::customize::internal::CustomizableSend<
37 crate::operation::list_simulation_applications::ListSimulationApplicationsOutput,
38 crate::operation::list_simulation_applications::ListSimulationApplicationsError,
39 > for ListSimulationApplicationsFluentBuilder
40{
41 fn send(
42 self,
43 config_override: crate::config::Builder,
44 ) -> crate::client::customize::internal::BoxFuture<
45 crate::client::customize::internal::SendResult<
46 crate::operation::list_simulation_applications::ListSimulationApplicationsOutput,
47 crate::operation::list_simulation_applications::ListSimulationApplicationsError,
48 >,
49 > {
50 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
51 }
52}
53impl ListSimulationApplicationsFluentBuilder {
54 /// Creates a new `ListSimulationApplicationsFluentBuilder`.
55 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
56 Self {
57 handle,
58 inner: ::std::default::Default::default(),
59 config_override: ::std::option::Option::None,
60 }
61 }
62 /// Access the ListSimulationApplications as a reference.
63 pub fn as_input(&self) -> &crate::operation::list_simulation_applications::builders::ListSimulationApplicationsInputBuilder {
64 &self.inner
65 }
66 /// Sends the request and returns the response.
67 ///
68 /// If an error occurs, an `SdkError` will be returned with additional details that
69 /// can be matched against.
70 ///
71 /// By default, any retryable failures will be retried twice. Retry behavior
72 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
73 /// set when configuring the client.
74 pub async fn send(
75 self,
76 ) -> ::std::result::Result<
77 crate::operation::list_simulation_applications::ListSimulationApplicationsOutput,
78 ::aws_smithy_runtime_api::client::result::SdkError<
79 crate::operation::list_simulation_applications::ListSimulationApplicationsError,
80 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
81 >,
82 > {
83 let input = self
84 .inner
85 .build()
86 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
87 let runtime_plugins = crate::operation::list_simulation_applications::ListSimulationApplications::operation_runtime_plugins(
88 self.handle.runtime_plugins.clone(),
89 &self.handle.conf,
90 self.config_override,
91 );
92 crate::operation::list_simulation_applications::ListSimulationApplications::orchestrate(&runtime_plugins, input).await
93 }
94
95 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
96 pub fn customize(
97 self,
98 ) -> crate::client::customize::CustomizableOperation<
99 crate::operation::list_simulation_applications::ListSimulationApplicationsOutput,
100 crate::operation::list_simulation_applications::ListSimulationApplicationsError,
101 Self,
102 > {
103 crate::client::customize::CustomizableOperation::new(self)
104 }
105 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
106 self.set_config_override(::std::option::Option::Some(config_override.into()));
107 self
108 }
109
110 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
111 self.config_override = config_override;
112 self
113 }
114 /// Create a paginator for this request
115 ///
116 /// Paginators are used by calling [`send().await`](crate::operation::list_simulation_applications::paginator::ListSimulationApplicationsPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
117 pub fn into_paginator(self) -> crate::operation::list_simulation_applications::paginator::ListSimulationApplicationsPaginator {
118 crate::operation::list_simulation_applications::paginator::ListSimulationApplicationsPaginator::new(self.handle, self.inner)
119 }
120 /// <p>The version qualifier of the simulation application.</p>
121 pub fn version_qualifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
122 self.inner = self.inner.version_qualifier(input.into());
123 self
124 }
125 /// <p>The version qualifier of the simulation application.</p>
126 pub fn set_version_qualifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
127 self.inner = self.inner.set_version_qualifier(input);
128 self
129 }
130 /// <p>The version qualifier of the simulation application.</p>
131 pub fn get_version_qualifier(&self) -> &::std::option::Option<::std::string::String> {
132 self.inner.get_version_qualifier()
133 }
134 /// <p>If the previous paginated request did not return all of the remaining results, the response object's <code>nextToken</code> parameter value is set to a token. To retrieve the next set of results, call <code>ListSimulationApplications</code> again and assign that token to the request object's <code>nextToken</code> parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.</p>
135 pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
136 self.inner = self.inner.next_token(input.into());
137 self
138 }
139 /// <p>If the previous paginated request did not return all of the remaining results, the response object's <code>nextToken</code> parameter value is set to a token. To retrieve the next set of results, call <code>ListSimulationApplications</code> again and assign that token to the request object's <code>nextToken</code> parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.</p>
140 pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
141 self.inner = self.inner.set_next_token(input);
142 self
143 }
144 /// <p>If the previous paginated request did not return all of the remaining results, the response object's <code>nextToken</code> parameter value is set to a token. To retrieve the next set of results, call <code>ListSimulationApplications</code> again and assign that token to the request object's <code>nextToken</code> parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.</p>
145 pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
146 self.inner.get_next_token()
147 }
148 /// <p>When this parameter is used, <code>ListSimulationApplications</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListSimulationApplications</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>ListSimulationApplications</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>
149 pub fn max_results(mut self, input: i32) -> Self {
150 self.inner = self.inner.max_results(input);
151 self
152 }
153 /// <p>When this parameter is used, <code>ListSimulationApplications</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListSimulationApplications</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>ListSimulationApplications</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>
154 pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
155 self.inner = self.inner.set_max_results(input);
156 self
157 }
158 /// <p>When this parameter is used, <code>ListSimulationApplications</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListSimulationApplications</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>ListSimulationApplications</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>
159 pub fn get_max_results(&self) -> &::std::option::Option<i32> {
160 self.inner.get_max_results()
161 }
162 ///
163 /// Appends an item to `filters`.
164 ///
165 /// To override the contents of this collection use [`set_filters`](Self::set_filters).
166 ///
167 /// <p>Optional list of filters to limit results.</p>
168 /// <p>The filter name <code>name</code> is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.</p>
169 pub fn filters(mut self, input: crate::types::Filter) -> Self {
170 self.inner = self.inner.filters(input);
171 self
172 }
173 /// <p>Optional list of filters to limit results.</p>
174 /// <p>The filter name <code>name</code> is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.</p>
175 pub fn set_filters(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Filter>>) -> Self {
176 self.inner = self.inner.set_filters(input);
177 self
178 }
179 /// <p>Optional list of filters to limit results.</p>
180 /// <p>The filter name <code>name</code> is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.</p>
181 pub fn get_filters(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Filter>> {
182 self.inner.get_filters()
183 }
184}