aws_sdk_ecr/operation/list_images/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::list_images::_list_images_output::ListImagesOutputBuilder;
3
4pub use crate::operation::list_images::_list_images_input::ListImagesInputBuilder;
5
6impl crate::operation::list_images::builders::ListImagesInputBuilder {
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_images::ListImagesOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::list_images::ListImagesError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.list_images();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `ListImages`.
24///
25/// <p>Lists all the image IDs for the specified repository.</p>
26/// <p>You can filter images based on whether or not they are tagged by using the <code>tagStatus</code> filter and specifying either <code>TAGGED</code>, <code>UNTAGGED</code> or <code>ANY</code>. For example, you can filter your results to return only <code>UNTAGGED</code> images and then pipe that result to a <code>BatchDeleteImage</code> operation to delete them. Or, you can filter your results to return only <code>TAGGED</code> images to list all of the tags in your repository.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct ListImagesFluentBuilder {
29 handle: ::std::sync::Arc<crate::client::Handle>,
30 inner: crate::operation::list_images::builders::ListImagesInputBuilder,
31 config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34 crate::client::customize::internal::CustomizableSend<
35 crate::operation::list_images::ListImagesOutput,
36 crate::operation::list_images::ListImagesError,
37 > for ListImagesFluentBuilder
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::list_images::ListImagesOutput,
45 crate::operation::list_images::ListImagesError,
46 >,
47 > {
48 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49 }
50}
51impl ListImagesFluentBuilder {
52 /// Creates a new `ListImagesFluentBuilder`.
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 ListImages as a reference.
61 pub fn as_input(&self) -> &crate::operation::list_images::builders::ListImagesInputBuilder {
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::list_images::ListImagesOutput,
76 ::aws_smithy_runtime_api::client::result::SdkError<
77 crate::operation::list_images::ListImagesError,
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::list_images::ListImages::operation_runtime_plugins(
86 self.handle.runtime_plugins.clone(),
87 &self.handle.conf,
88 self.config_override,
89 );
90 crate::operation::list_images::ListImages::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::list_images::ListImagesOutput,
98 crate::operation::list_images::ListImagesError,
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::list_images::paginator::ListImagesPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
115 pub fn into_paginator(self) -> crate::operation::list_images::paginator::ListImagesPaginator {
116 crate::operation::list_images::paginator::ListImagesPaginator::new(self.handle, self.inner)
117 }
118 /// <p>The Amazon Web Services account ID associated with the registry that contains the repository in which to list images. If you do not specify a registry, the default registry is assumed.</p>
119 pub fn registry_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
120 self.inner = self.inner.registry_id(input.into());
121 self
122 }
123 /// <p>The Amazon Web Services account ID associated with the registry that contains the repository in which to list images. If you do not specify a registry, the default registry is assumed.</p>
124 pub fn set_registry_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
125 self.inner = self.inner.set_registry_id(input);
126 self
127 }
128 /// <p>The Amazon Web Services account ID associated with the registry that contains the repository in which to list images. If you do not specify a registry, the default registry is assumed.</p>
129 pub fn get_registry_id(&self) -> &::std::option::Option<::std::string::String> {
130 self.inner.get_registry_id()
131 }
132 /// <p>The repository with image IDs to be listed.</p>
133 pub fn repository_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
134 self.inner = self.inner.repository_name(input.into());
135 self
136 }
137 /// <p>The repository with image IDs to be listed.</p>
138 pub fn set_repository_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
139 self.inner = self.inner.set_repository_name(input);
140 self
141 }
142 /// <p>The repository with image IDs to be listed.</p>
143 pub fn get_repository_name(&self) -> &::std::option::Option<::std::string::String> {
144 self.inner.get_repository_name()
145 }
146 /// <p>The <code>nextToken</code> value returned from a previous paginated <code>ListImages</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>
147 /// <p>This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.</p>
148 /// </note>
149 pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
150 self.inner = self.inner.next_token(input.into());
151 self
152 }
153 /// <p>The <code>nextToken</code> value returned from a previous paginated <code>ListImages</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>
154 /// <p>This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.</p>
155 /// </note>
156 pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
157 self.inner = self.inner.set_next_token(input);
158 self
159 }
160 /// <p>The <code>nextToken</code> value returned from a previous paginated <code>ListImages</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>
161 /// <p>This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.</p>
162 /// </note>
163 pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
164 self.inner.get_next_token()
165 }
166 /// <p>The maximum number of image results returned by <code>ListImages</code> in paginated output. When this parameter is used, <code>ListImages</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>ListImages</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 1000. If this parameter is not used, then <code>ListImages</code> returns up to 100 results and a <code>nextToken</code> value, if applicable.</p>
167 pub fn max_results(mut self, input: i32) -> Self {
168 self.inner = self.inner.max_results(input);
169 self
170 }
171 /// <p>The maximum number of image results returned by <code>ListImages</code> in paginated output. When this parameter is used, <code>ListImages</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>ListImages</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 1000. If this parameter is not used, then <code>ListImages</code> returns up to 100 results and a <code>nextToken</code> value, if applicable.</p>
172 pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
173 self.inner = self.inner.set_max_results(input);
174 self
175 }
176 /// <p>The maximum number of image results returned by <code>ListImages</code> in paginated output. When this parameter is used, <code>ListImages</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>ListImages</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 1000. If this parameter is not used, then <code>ListImages</code> returns up to 100 results and a <code>nextToken</code> value, if applicable.</p>
177 pub fn get_max_results(&self) -> &::std::option::Option<i32> {
178 self.inner.get_max_results()
179 }
180 /// <p>The filter key and value with which to filter your <code>ListImages</code> results.</p>
181 pub fn filter(mut self, input: crate::types::ListImagesFilter) -> Self {
182 self.inner = self.inner.filter(input);
183 self
184 }
185 /// <p>The filter key and value with which to filter your <code>ListImages</code> results.</p>
186 pub fn set_filter(mut self, input: ::std::option::Option<crate::types::ListImagesFilter>) -> Self {
187 self.inner = self.inner.set_filter(input);
188 self
189 }
190 /// <p>The filter key and value with which to filter your <code>ListImages</code> results.</p>
191 pub fn get_filter(&self) -> &::std::option::Option<crate::types::ListImagesFilter> {
192 self.inner.get_filter()
193 }
194}