aws_sdk_batch/operation/describe_job_definitions/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::describe_job_definitions::_describe_job_definitions_output::DescribeJobDefinitionsOutputBuilder;
3
4pub use crate::operation::describe_job_definitions::_describe_job_definitions_input::DescribeJobDefinitionsInputBuilder;
5
6impl crate::operation::describe_job_definitions::builders::DescribeJobDefinitionsInputBuilder {
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_job_definitions::DescribeJobDefinitionsOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::describe_job_definitions::DescribeJobDefinitionsError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.describe_job_definitions();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `DescribeJobDefinitions`.
24///
25/// <p>Describes a list of job definitions. You can specify a <code>status</code> (such as <code>ACTIVE</code>) to only return job definitions that match that status.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct DescribeJobDefinitionsFluentBuilder {
28 handle: ::std::sync::Arc<crate::client::Handle>,
29 inner: crate::operation::describe_job_definitions::builders::DescribeJobDefinitionsInputBuilder,
30 config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33 crate::client::customize::internal::CustomizableSend<
34 crate::operation::describe_job_definitions::DescribeJobDefinitionsOutput,
35 crate::operation::describe_job_definitions::DescribeJobDefinitionsError,
36 > for DescribeJobDefinitionsFluentBuilder
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::describe_job_definitions::DescribeJobDefinitionsOutput,
44 crate::operation::describe_job_definitions::DescribeJobDefinitionsError,
45 >,
46 > {
47 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48 }
49}
50impl DescribeJobDefinitionsFluentBuilder {
51 /// Creates a new `DescribeJobDefinitionsFluentBuilder`.
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 DescribeJobDefinitions as a reference.
60 pub fn as_input(&self) -> &crate::operation::describe_job_definitions::builders::DescribeJobDefinitionsInputBuilder {
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::describe_job_definitions::DescribeJobDefinitionsOutput,
75 ::aws_smithy_runtime_api::client::result::SdkError<
76 crate::operation::describe_job_definitions::DescribeJobDefinitionsError,
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::describe_job_definitions::DescribeJobDefinitions::operation_runtime_plugins(
85 self.handle.runtime_plugins.clone(),
86 &self.handle.conf,
87 self.config_override,
88 );
89 crate::operation::describe_job_definitions::DescribeJobDefinitions::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::describe_job_definitions::DescribeJobDefinitionsOutput,
97 crate::operation::describe_job_definitions::DescribeJobDefinitionsError,
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::describe_job_definitions::paginator::DescribeJobDefinitionsPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
114 pub fn into_paginator(self) -> crate::operation::describe_job_definitions::paginator::DescribeJobDefinitionsPaginator {
115 crate::operation::describe_job_definitions::paginator::DescribeJobDefinitionsPaginator::new(self.handle, self.inner)
116 }
117 ///
118 /// Appends an item to `jobDefinitions`.
119 ///
120 /// To override the contents of this collection use [`set_job_definitions`](Self::set_job_definitions).
121 ///
122 /// <p>A list of up to 100 job definitions. Each entry in the list can either be an ARN in the format <code>arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}</code> or a short version using the form <code>${JobDefinitionName}:${Revision}</code>. This parameter can't be used with other parameters.</p>
123 pub fn job_definitions(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
124 self.inner = self.inner.job_definitions(input.into());
125 self
126 }
127 /// <p>A list of up to 100 job definitions. Each entry in the list can either be an ARN in the format <code>arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}</code> or a short version using the form <code>${JobDefinitionName}:${Revision}</code>. This parameter can't be used with other parameters.</p>
128 pub fn set_job_definitions(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
129 self.inner = self.inner.set_job_definitions(input);
130 self
131 }
132 /// <p>A list of up to 100 job definitions. Each entry in the list can either be an ARN in the format <code>arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}</code> or a short version using the form <code>${JobDefinitionName}:${Revision}</code>. This parameter can't be used with other parameters.</p>
133 pub fn get_job_definitions(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
134 self.inner.get_job_definitions()
135 }
136 /// <p>The maximum number of results returned by <code>DescribeJobDefinitions</code> in paginated output. When this parameter is used, <code>DescribeJobDefinitions</code> only returns <code>maxResults</code> results in a single page and a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>DescribeJobDefinitions</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>DescribeJobDefinitions</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>
137 pub fn max_results(mut self, input: i32) -> Self {
138 self.inner = self.inner.max_results(input);
139 self
140 }
141 /// <p>The maximum number of results returned by <code>DescribeJobDefinitions</code> in paginated output. When this parameter is used, <code>DescribeJobDefinitions</code> only returns <code>maxResults</code> results in a single page and a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>DescribeJobDefinitions</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>DescribeJobDefinitions</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>
142 pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
143 self.inner = self.inner.set_max_results(input);
144 self
145 }
146 /// <p>The maximum number of results returned by <code>DescribeJobDefinitions</code> in paginated output. When this parameter is used, <code>DescribeJobDefinitions</code> only returns <code>maxResults</code> results in a single page and a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>DescribeJobDefinitions</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>DescribeJobDefinitions</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>
147 pub fn get_max_results(&self) -> &::std::option::Option<i32> {
148 self.inner.get_max_results()
149 }
150 /// <p>The name of the job definition to describe.</p>
151 pub fn job_definition_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
152 self.inner = self.inner.job_definition_name(input.into());
153 self
154 }
155 /// <p>The name of the job definition to describe.</p>
156 pub fn set_job_definition_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
157 self.inner = self.inner.set_job_definition_name(input);
158 self
159 }
160 /// <p>The name of the job definition to describe.</p>
161 pub fn get_job_definition_name(&self) -> &::std::option::Option<::std::string::String> {
162 self.inner.get_job_definition_name()
163 }
164 /// <p>The status used to filter job definitions.</p>
165 pub fn status(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
166 self.inner = self.inner.status(input.into());
167 self
168 }
169 /// <p>The status used to filter job definitions.</p>
170 pub fn set_status(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
171 self.inner = self.inner.set_status(input);
172 self
173 }
174 /// <p>The status used to filter job definitions.</p>
175 pub fn get_status(&self) -> &::std::option::Option<::std::string::String> {
176 self.inner.get_status()
177 }
178 /// <p>The <code>nextToken</code> value returned from a previous paginated <code>DescribeJobDefinitions</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>
179 /// <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>
180 /// </note>
181 pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
182 self.inner = self.inner.next_token(input.into());
183 self
184 }
185 /// <p>The <code>nextToken</code> value returned from a previous paginated <code>DescribeJobDefinitions</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>
186 /// <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>
187 /// </note>
188 pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
189 self.inner = self.inner.set_next_token(input);
190 self
191 }
192 /// <p>The <code>nextToken</code> value returned from a previous paginated <code>DescribeJobDefinitions</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>
193 /// <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>
194 /// </note>
195 pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
196 self.inner.get_next_token()
197 }
198}