aws_sdk_gamelift/operation/describe_fleet_location_attributes/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::describe_fleet_location_attributes::_describe_fleet_location_attributes_output::DescribeFleetLocationAttributesOutputBuilder;
3
4pub use crate::operation::describe_fleet_location_attributes::_describe_fleet_location_attributes_input::DescribeFleetLocationAttributesInputBuilder;
5
6impl crate::operation::describe_fleet_location_attributes::builders::DescribeFleetLocationAttributesInputBuilder {
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_fleet_location_attributes::DescribeFleetLocationAttributesOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::describe_fleet_location_attributes::DescribeFleetLocationAttributesError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.describe_fleet_location_attributes();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `DescribeFleetLocationAttributes`.
24///
25/// <p><b>This API works with the following fleet types:</b> EC2, Container</p>
26/// <p>Retrieves information on a fleet's remote locations, including life-cycle status and any suspended fleet activity.</p>
27/// <p>This operation can be used in the following ways:</p>
28/// <ul>
29/// <li>
30/// <p>To get data for specific locations, provide a fleet identifier and a list of locations. Location data is returned in the order that it is requested.</p></li>
31/// <li>
32/// <p>To get data for all locations, provide a fleet identifier only. Location data is returned in no particular order.</p></li>
33/// </ul>
34/// <p>When requesting attributes for multiple locations, use the pagination parameters to retrieve results as a set of sequential pages.</p>
35/// <p>If successful, a <code>LocationAttributes</code> object is returned for each requested location. If the fleet does not have a requested location, no information is returned. This operation does not return the home Region. To get information on a fleet's home Region, call <code>DescribeFleetAttributes</code>.</p>
36/// <p><b>Learn more</b></p>
37/// <p><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up Amazon GameLift Servers fleets</a></p>
38/// <p><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-regions.html"> Amazon GameLift Servers service locations</a> for managed hosting</p>
39#[derive(::std::clone::Clone, ::std::fmt::Debug)]
40pub struct DescribeFleetLocationAttributesFluentBuilder {
41    handle: ::std::sync::Arc<crate::client::Handle>,
42    inner: crate::operation::describe_fleet_location_attributes::builders::DescribeFleetLocationAttributesInputBuilder,
43    config_override: ::std::option::Option<crate::config::Builder>,
44}
45impl
46    crate::client::customize::internal::CustomizableSend<
47        crate::operation::describe_fleet_location_attributes::DescribeFleetLocationAttributesOutput,
48        crate::operation::describe_fleet_location_attributes::DescribeFleetLocationAttributesError,
49    > for DescribeFleetLocationAttributesFluentBuilder
50{
51    fn send(
52        self,
53        config_override: crate::config::Builder,
54    ) -> crate::client::customize::internal::BoxFuture<
55        crate::client::customize::internal::SendResult<
56            crate::operation::describe_fleet_location_attributes::DescribeFleetLocationAttributesOutput,
57            crate::operation::describe_fleet_location_attributes::DescribeFleetLocationAttributesError,
58        >,
59    > {
60        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
61    }
62}
63impl DescribeFleetLocationAttributesFluentBuilder {
64    /// Creates a new `DescribeFleetLocationAttributesFluentBuilder`.
65    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
66        Self {
67            handle,
68            inner: ::std::default::Default::default(),
69            config_override: ::std::option::Option::None,
70        }
71    }
72    /// Access the DescribeFleetLocationAttributes as a reference.
73    pub fn as_input(&self) -> &crate::operation::describe_fleet_location_attributes::builders::DescribeFleetLocationAttributesInputBuilder {
74        &self.inner
75    }
76    /// Sends the request and returns the response.
77    ///
78    /// If an error occurs, an `SdkError` will be returned with additional details that
79    /// can be matched against.
80    ///
81    /// By default, any retryable failures will be retried twice. Retry behavior
82    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
83    /// set when configuring the client.
84    pub async fn send(
85        self,
86    ) -> ::std::result::Result<
87        crate::operation::describe_fleet_location_attributes::DescribeFleetLocationAttributesOutput,
88        ::aws_smithy_runtime_api::client::result::SdkError<
89            crate::operation::describe_fleet_location_attributes::DescribeFleetLocationAttributesError,
90            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
91        >,
92    > {
93        let input = self
94            .inner
95            .build()
96            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
97        let runtime_plugins = crate::operation::describe_fleet_location_attributes::DescribeFleetLocationAttributes::operation_runtime_plugins(
98            self.handle.runtime_plugins.clone(),
99            &self.handle.conf,
100            self.config_override,
101        );
102        crate::operation::describe_fleet_location_attributes::DescribeFleetLocationAttributes::orchestrate(&runtime_plugins, input).await
103    }
104
105    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
106    pub fn customize(
107        self,
108    ) -> crate::client::customize::CustomizableOperation<
109        crate::operation::describe_fleet_location_attributes::DescribeFleetLocationAttributesOutput,
110        crate::operation::describe_fleet_location_attributes::DescribeFleetLocationAttributesError,
111        Self,
112    > {
113        crate::client::customize::CustomizableOperation::new(self)
114    }
115    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
116        self.set_config_override(::std::option::Option::Some(config_override.into()));
117        self
118    }
119
120    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
121        self.config_override = config_override;
122        self
123    }
124    /// Create a paginator for this request
125    ///
126    /// Paginators are used by calling [`send().await`](crate::operation::describe_fleet_location_attributes::paginator::DescribeFleetLocationAttributesPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
127    pub fn into_paginator(self) -> crate::operation::describe_fleet_location_attributes::paginator::DescribeFleetLocationAttributesPaginator {
128        crate::operation::describe_fleet_location_attributes::paginator::DescribeFleetLocationAttributesPaginator::new(self.handle, self.inner)
129    }
130    /// <p>A unique identifier for the fleet to retrieve remote locations for. You can use either the fleet ID or ARN value.</p>
131    pub fn fleet_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
132        self.inner = self.inner.fleet_id(input.into());
133        self
134    }
135    /// <p>A unique identifier for the fleet to retrieve remote locations for. You can use either the fleet ID or ARN value.</p>
136    pub fn set_fleet_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
137        self.inner = self.inner.set_fleet_id(input);
138        self
139    }
140    /// <p>A unique identifier for the fleet to retrieve remote locations for. You can use either the fleet ID or ARN value.</p>
141    pub fn get_fleet_id(&self) -> &::std::option::Option<::std::string::String> {
142        self.inner.get_fleet_id()
143    }
144    ///
145    /// Appends an item to `Locations`.
146    ///
147    /// To override the contents of this collection use [`set_locations`](Self::set_locations).
148    ///
149    /// <p>A list of fleet locations to retrieve information for. Specify locations in the form of an Amazon Web Services Region code, such as <code>us-west-2</code>.</p>
150    pub fn locations(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
151        self.inner = self.inner.locations(input.into());
152        self
153    }
154    /// <p>A list of fleet locations to retrieve information for. Specify locations in the form of an Amazon Web Services Region code, such as <code>us-west-2</code>.</p>
155    pub fn set_locations(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
156        self.inner = self.inner.set_locations(input);
157        self
158    }
159    /// <p>A list of fleet locations to retrieve information for. Specify locations in the form of an Amazon Web Services Region code, such as <code>us-west-2</code>.</p>
160    pub fn get_locations(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
161        self.inner.get_locations()
162    }
163    /// <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages. This limit is not currently enforced.</p>
164    pub fn limit(mut self, input: i32) -> Self {
165        self.inner = self.inner.limit(input);
166        self
167    }
168    /// <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages. This limit is not currently enforced.</p>
169    pub fn set_limit(mut self, input: ::std::option::Option<i32>) -> Self {
170        self.inner = self.inner.set_limit(input);
171        self
172    }
173    /// <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages. This limit is not currently enforced.</p>
174    pub fn get_limit(&self) -> &::std::option::Option<i32> {
175        self.inner.get_limit()
176    }
177    /// <p>A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.</p>
178    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
179        self.inner = self.inner.next_token(input.into());
180        self
181    }
182    /// <p>A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.</p>
183    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
184        self.inner = self.inner.set_next_token(input);
185        self
186    }
187    /// <p>A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.</p>
188    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
189        self.inner.get_next_token()
190    }
191}
aws_sdk_gamelift/operation/describe_fleet_location_attributes/builders.rs

aws_sdk_gamelift/operation/describe_fleet_location_attributes/
builders.rs
