aws_sdk_batch/operation/describe_compute_environments/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::describe_compute_environments::_describe_compute_environments_output::DescribeComputeEnvironmentsOutputBuilder;
3
4pub use crate::operation::describe_compute_environments::_describe_compute_environments_input::DescribeComputeEnvironmentsInputBuilder;
5
6impl crate::operation::describe_compute_environments::builders::DescribeComputeEnvironmentsInputBuilder {
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::describe_compute_environments::DescribeComputeEnvironmentsOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::describe_compute_environments::DescribeComputeEnvironmentsError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.describe_compute_environments();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `DescribeComputeEnvironments`.
24///
25/// <p>Describes one or more of your compute environments.</p>
26/// <p>If you're using an unmanaged compute environment, you can use the <code>DescribeComputeEnvironment</code> operation to determine the <code>ecsClusterArn</code> that you launch your Amazon ECS container instances into.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct DescribeComputeEnvironmentsFluentBuilder {
29 handle: ::std::sync::Arc<crate::client::Handle>,
30 inner: crate::operation::describe_compute_environments::builders::DescribeComputeEnvironmentsInputBuilder,
31 config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34 crate::client::customize::internal::CustomizableSend<
35 crate::operation::describe_compute_environments::DescribeComputeEnvironmentsOutput,
36 crate::operation::describe_compute_environments::DescribeComputeEnvironmentsError,
37 > for DescribeComputeEnvironmentsFluentBuilder
38{
39 fn send(
40 self,
41 config_override: crate::config::Builder,
42 ) -> crate::client::customize::internal::BoxFuture<
43 crate::client::customize::internal::SendResult<
44 crate::operation::describe_compute_environments::DescribeComputeEnvironmentsOutput,
45 crate::operation::describe_compute_environments::DescribeComputeEnvironmentsError,
46 >,
47 > {
48 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49 }
50}
51impl DescribeComputeEnvironmentsFluentBuilder {
52 /// Creates a new `DescribeComputeEnvironmentsFluentBuilder`.
53 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
54 Self {
55 handle,
56 inner: ::std::default::Default::default(),
57 config_override: ::std::option::Option::None,
58 }
59 }
60 /// Access the DescribeComputeEnvironments as a reference.
61 pub fn as_input(&self) -> &crate::operation::describe_compute_environments::builders::DescribeComputeEnvironmentsInputBuilder {
62 &self.inner
63 }
64 /// Sends the request and returns the response.
65 ///
66 /// If an error occurs, an `SdkError` will be returned with additional details that
67 /// can be matched against.
68 ///
69 /// By default, any retryable failures will be retried twice. Retry behavior
70 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
71 /// set when configuring the client.
72 pub async fn send(
73 self,
74 ) -> ::std::result::Result<
75 crate::operation::describe_compute_environments::DescribeComputeEnvironmentsOutput,
76 ::aws_smithy_runtime_api::client::result::SdkError<
77 crate::operation::describe_compute_environments::DescribeComputeEnvironmentsError,
78 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
79 >,
80 > {
81 let input = self
82 .inner
83 .build()
84 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
85 let runtime_plugins = crate::operation::describe_compute_environments::DescribeComputeEnvironments::operation_runtime_plugins(
86 self.handle.runtime_plugins.clone(),
87 &self.handle.conf,
88 self.config_override,
89 );
90 crate::operation::describe_compute_environments::DescribeComputeEnvironments::orchestrate(&runtime_plugins, input).await
91 }
92
93 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
94 pub fn customize(
95 self,
96 ) -> crate::client::customize::CustomizableOperation<
97 crate::operation::describe_compute_environments::DescribeComputeEnvironmentsOutput,
98 crate::operation::describe_compute_environments::DescribeComputeEnvironmentsError,
99 Self,
100 > {
101 crate::client::customize::CustomizableOperation::new(self)
102 }
103 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
104 self.set_config_override(::std::option::Option::Some(config_override.into()));
105 self
106 }
107
108 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
109 self.config_override = config_override;
110 self
111 }
112 /// Create a paginator for this request
113 ///
114 /// Paginators are used by calling [`send().await`](crate::operation::describe_compute_environments::paginator::DescribeComputeEnvironmentsPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
115 pub fn into_paginator(self) -> crate::operation::describe_compute_environments::paginator::DescribeComputeEnvironmentsPaginator {
116 crate::operation::describe_compute_environments::paginator::DescribeComputeEnvironmentsPaginator::new(self.handle, self.inner)
117 }
118 ///
119 /// Appends an item to `computeEnvironments`.
120 ///
121 /// To override the contents of this collection use [`set_compute_environments`](Self::set_compute_environments).
122 ///
123 /// <p>A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.</p>
124 pub fn compute_environments(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
125 self.inner = self.inner.compute_environments(input.into());
126 self
127 }
128 /// <p>A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.</p>
129 pub fn set_compute_environments(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
130 self.inner = self.inner.set_compute_environments(input);
131 self
132 }
133 /// <p>A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.</p>
134 pub fn get_compute_environments(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
135 self.inner.get_compute_environments()
136 }
137 /// <p>The maximum number of cluster results returned by <code>DescribeComputeEnvironments</code> in paginated output. When this parameter is used, <code>DescribeComputeEnvironments</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>DescribeComputeEnvironments</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter isn't used, then <code>DescribeComputeEnvironments</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>
138 pub fn max_results(mut self, input: i32) -> Self {
139 self.inner = self.inner.max_results(input);
140 self
141 }
142 /// <p>The maximum number of cluster results returned by <code>DescribeComputeEnvironments</code> in paginated output. When this parameter is used, <code>DescribeComputeEnvironments</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>DescribeComputeEnvironments</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter isn't used, then <code>DescribeComputeEnvironments</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>
143 pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
144 self.inner = self.inner.set_max_results(input);
145 self
146 }
147 /// <p>The maximum number of cluster results returned by <code>DescribeComputeEnvironments</code> in paginated output. When this parameter is used, <code>DescribeComputeEnvironments</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>DescribeComputeEnvironments</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter isn't used, then <code>DescribeComputeEnvironments</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>
148 pub fn get_max_results(&self) -> &::std::option::Option<i32> {
149 self.inner.get_max_results()
150 }
151 /// <p>The <code>nextToken</code> value returned from a previous paginated <code>DescribeComputeEnvironments</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when there are no more results to return.</p><note>
152 /// <p>Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.</p>
153 /// </note>
154 pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
155 self.inner = self.inner.next_token(input.into());
156 self
157 }
158 /// <p>The <code>nextToken</code> value returned from a previous paginated <code>DescribeComputeEnvironments</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when there are no more results to return.</p><note>
159 /// <p>Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.</p>
160 /// </note>
161 pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
162 self.inner = self.inner.set_next_token(input);
163 self
164 }
165 /// <p>The <code>nextToken</code> value returned from a previous paginated <code>DescribeComputeEnvironments</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when there are no more results to return.</p><note>
166 /// <p>Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.</p>
167 /// </note>
168 pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
169 self.inner.get_next_token()
170 }
171}