aws_sdk_datasync/operation/list_locations/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::list_locations::_list_locations_output::ListLocationsOutputBuilder;
3
4pub use crate::operation::list_locations::_list_locations_input::ListLocationsInputBuilder;
5
6impl crate::operation::list_locations::builders::ListLocationsInputBuilder {
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_locations::ListLocationsOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::list_locations::ListLocationsError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.list_locations();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `ListLocations`.
24///
25/// <p>Returns a list of source and destination locations.</p>
26/// <p>If you have more locations than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a token that you can specify in your next request to fetch the next page of locations.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct ListLocationsFluentBuilder {
29    handle: ::std::sync::Arc<crate::client::Handle>,
30    inner: crate::operation::list_locations::builders::ListLocationsInputBuilder,
31    config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34    crate::client::customize::internal::CustomizableSend<
35        crate::operation::list_locations::ListLocationsOutput,
36        crate::operation::list_locations::ListLocationsError,
37    > for ListLocationsFluentBuilder
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_locations::ListLocationsOutput,
45            crate::operation::list_locations::ListLocationsError,
46        >,
47    > {
48        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49    }
50}
51impl ListLocationsFluentBuilder {
52    /// Creates a new `ListLocationsFluentBuilder`.
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 ListLocations as a reference.
61    pub fn as_input(&self) -> &crate::operation::list_locations::builders::ListLocationsInputBuilder {
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_locations::ListLocationsOutput,
76        ::aws_smithy_runtime_api::client::result::SdkError<
77            crate::operation::list_locations::ListLocationsError,
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_locations::ListLocations::operation_runtime_plugins(
86            self.handle.runtime_plugins.clone(),
87            &self.handle.conf,
88            self.config_override,
89        );
90        crate::operation::list_locations::ListLocations::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_locations::ListLocationsOutput,
98        crate::operation::list_locations::ListLocationsError,
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_locations::paginator::ListLocationsPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
115    pub fn into_paginator(self) -> crate::operation::list_locations::paginator::ListLocationsPaginator {
116        crate::operation::list_locations::paginator::ListLocationsPaginator::new(self.handle, self.inner)
117    }
118    /// <p>The maximum number of locations to return.</p>
119    pub fn max_results(mut self, input: i32) -> Self {
120        self.inner = self.inner.max_results(input);
121        self
122    }
123    /// <p>The maximum number of locations to return.</p>
124    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
125        self.inner = self.inner.set_max_results(input);
126        self
127    }
128    /// <p>The maximum number of locations to return.</p>
129    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
130        self.inner.get_max_results()
131    }
132    /// <p>An opaque string that indicates the position at which to begin the next list of locations.</p>
133    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
134        self.inner = self.inner.next_token(input.into());
135        self
136    }
137    /// <p>An opaque string that indicates the position at which to begin the next list of locations.</p>
138    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
139        self.inner = self.inner.set_next_token(input);
140        self
141    }
142    /// <p>An opaque string that indicates the position at which to begin the next list of locations.</p>
143    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
144        self.inner.get_next_token()
145    }
146    ///
147    /// Appends an item to `Filters`.
148    ///
149    /// To override the contents of this collection use [`set_filters`](Self::set_filters).
150    ///
151    /// <p>You can use API filters to narrow down the list of resources returned by <code>ListLocations</code>. For example, to retrieve all tasks on a specific source location, you can use <code>ListLocations</code> with filter name <code>LocationType S3</code> and <code>Operator Equals</code>.</p>
152    pub fn filters(mut self, input: crate::types::LocationFilter) -> Self {
153        self.inner = self.inner.filters(input);
154        self
155    }
156    /// <p>You can use API filters to narrow down the list of resources returned by <code>ListLocations</code>. For example, to retrieve all tasks on a specific source location, you can use <code>ListLocations</code> with filter name <code>LocationType S3</code> and <code>Operator Equals</code>.</p>
157    pub fn set_filters(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::LocationFilter>>) -> Self {
158        self.inner = self.inner.set_filters(input);
159        self
160    }
161    /// <p>You can use API filters to narrow down the list of resources returned by <code>ListLocations</code>. For example, to retrieve all tasks on a specific source location, you can use <code>ListLocations</code> with filter name <code>LocationType S3</code> and <code>Operator Equals</code>.</p>
162    pub fn get_filters(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::LocationFilter>> {
163        self.inner.get_filters()
164    }
165}
aws_sdk_datasync/operation/list_locations/builders.rs

aws_sdk_datasync/operation/list_locations/
builders.rs
