aws_sdk_shield/operation/list_protections/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::list_protections::_list_protections_output::ListProtectionsOutputBuilder;
3
4pub use crate::operation::list_protections::_list_protections_input::ListProtectionsInputBuilder;
5
6impl crate::operation::list_protections::builders::ListProtectionsInputBuilder {
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_protections::ListProtectionsOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::list_protections::ListProtectionsError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.list_protections();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `ListProtections`.
24///
25/// <p>Retrieves <code>Protection</code> objects for the account. You can retrieve all protections or you can provide filtering criteria and retrieve just the subset of protections that match the criteria.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct ListProtectionsFluentBuilder {
28 handle: ::std::sync::Arc<crate::client::Handle>,
29 inner: crate::operation::list_protections::builders::ListProtectionsInputBuilder,
30 config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33 crate::client::customize::internal::CustomizableSend<
34 crate::operation::list_protections::ListProtectionsOutput,
35 crate::operation::list_protections::ListProtectionsError,
36 > for ListProtectionsFluentBuilder
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::list_protections::ListProtectionsOutput,
44 crate::operation::list_protections::ListProtectionsError,
45 >,
46 > {
47 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48 }
49}
50impl ListProtectionsFluentBuilder {
51 /// Creates a new `ListProtectionsFluentBuilder`.
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 ListProtections as a reference.
60 pub fn as_input(&self) -> &crate::operation::list_protections::builders::ListProtectionsInputBuilder {
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::list_protections::ListProtectionsOutput,
75 ::aws_smithy_runtime_api::client::result::SdkError<
76 crate::operation::list_protections::ListProtectionsError,
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::list_protections::ListProtections::operation_runtime_plugins(
85 self.handle.runtime_plugins.clone(),
86 &self.handle.conf,
87 self.config_override,
88 );
89 crate::operation::list_protections::ListProtections::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::list_protections::ListProtectionsOutput,
97 crate::operation::list_protections::ListProtectionsError,
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::list_protections::paginator::ListProtectionsPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
114 pub fn into_paginator(self) -> crate::operation::list_protections::paginator::ListProtectionsPaginator {
115 crate::operation::list_protections::paginator::ListProtectionsPaginator::new(self.handle, self.inner)
116 }
117 /// <p>When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a <code>NextToken</code> value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request.</p>
118 /// <p>You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the <code>MaxResults</code> setting. Shield Advanced will not return more than <code>MaxResults</code> objects, but may return fewer, even if more objects are still available.</p>
119 /// <p>Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a <code>NextToken</code> value.</p>
120 /// <p>On your first call to a list operation, leave this setting empty.</p>
121 pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
122 self.inner = self.inner.next_token(input.into());
123 self
124 }
125 /// <p>When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a <code>NextToken</code> value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request.</p>
126 /// <p>You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the <code>MaxResults</code> setting. Shield Advanced will not return more than <code>MaxResults</code> objects, but may return fewer, even if more objects are still available.</p>
127 /// <p>Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a <code>NextToken</code> value.</p>
128 /// <p>On your first call to a list operation, leave this setting empty.</p>
129 pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
130 self.inner = self.inner.set_next_token(input);
131 self
132 }
133 /// <p>When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a <code>NextToken</code> value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request.</p>
134 /// <p>You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the <code>MaxResults</code> setting. Shield Advanced will not return more than <code>MaxResults</code> objects, but may return fewer, even if more objects are still available.</p>
135 /// <p>Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a <code>NextToken</code> value.</p>
136 /// <p>On your first call to a list operation, leave this setting empty.</p>
137 pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
138 self.inner.get_next_token()
139 }
140 /// <p>The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might return fewer objects than you indicate in this setting, even if more objects are available. If there are more objects remaining, Shield Advanced will always also return a <code>NextToken</code> value in the response.</p>
141 /// <p>The default setting is 20.</p>
142 pub fn max_results(mut self, input: i32) -> Self {
143 self.inner = self.inner.max_results(input);
144 self
145 }
146 /// <p>The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might return fewer objects than you indicate in this setting, even if more objects are available. If there are more objects remaining, Shield Advanced will always also return a <code>NextToken</code> value in the response.</p>
147 /// <p>The default setting is 20.</p>
148 pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
149 self.inner = self.inner.set_max_results(input);
150 self
151 }
152 /// <p>The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might return fewer objects than you indicate in this setting, even if more objects are available. If there are more objects remaining, Shield Advanced will always also return a <code>NextToken</code> value in the response.</p>
153 /// <p>The default setting is 20.</p>
154 pub fn get_max_results(&self) -> &::std::option::Option<i32> {
155 self.inner.get_max_results()
156 }
157 /// <p>Narrows the set of protections that the call retrieves. You can retrieve a single protection by providing its name or the ARN (Amazon Resource Name) of its protected resource. You can also retrieve all protections for a specific resource type. You can provide up to one criteria per filter type. Shield Advanced returns protections that exactly match all of the filter criteria that you provide.</p>
158 pub fn inclusion_filters(mut self, input: crate::types::InclusionProtectionFilters) -> Self {
159 self.inner = self.inner.inclusion_filters(input);
160 self
161 }
162 /// <p>Narrows the set of protections that the call retrieves. You can retrieve a single protection by providing its name or the ARN (Amazon Resource Name) of its protected resource. You can also retrieve all protections for a specific resource type. You can provide up to one criteria per filter type. Shield Advanced returns protections that exactly match all of the filter criteria that you provide.</p>
163 pub fn set_inclusion_filters(mut self, input: ::std::option::Option<crate::types::InclusionProtectionFilters>) -> Self {
164 self.inner = self.inner.set_inclusion_filters(input);
165 self
166 }
167 /// <p>Narrows the set of protections that the call retrieves. You can retrieve a single protection by providing its name or the ARN (Amazon Resource Name) of its protected resource. You can also retrieve all protections for a specific resource type. You can provide up to one criteria per filter type. Shield Advanced returns protections that exactly match all of the filter criteria that you provide.</p>
168 pub fn get_inclusion_filters(&self) -> &::std::option::Option<crate::types::InclusionProtectionFilters> {
169 self.inner.get_inclusion_filters()
170 }
171}