aws_sdk_gamelift/operation/describe_game_session_queues/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::describe_game_session_queues::_describe_game_session_queues_output::DescribeGameSessionQueuesOutputBuilder;
3
4pub use crate::operation::describe_game_session_queues::_describe_game_session_queues_input::DescribeGameSessionQueuesInputBuilder;
5
6impl crate::operation::describe_game_session_queues::builders::DescribeGameSessionQueuesInputBuilder {
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_game_session_queues::DescribeGameSessionQueuesOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::describe_game_session_queues::DescribeGameSessionQueuesError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.describe_game_session_queues();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `DescribeGameSessionQueues`.
24///
25/// <p>Retrieves the properties for one or more game session queues. When requesting multiple queues, use the pagination parameters to retrieve results as a set of sequential pages. When specifying a list of queues, objects are returned only for queues that currently exist in the Region.</p>
26/// <p><b>Learn more</b></p>
27/// <p><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-console.html"> View Your Queues</a></p>
28#[derive(::std::clone::Clone, ::std::fmt::Debug)]
29pub struct DescribeGameSessionQueuesFluentBuilder {
30    handle: ::std::sync::Arc<crate::client::Handle>,
31    inner: crate::operation::describe_game_session_queues::builders::DescribeGameSessionQueuesInputBuilder,
32    config_override: ::std::option::Option<crate::config::Builder>,
33}
34impl
35    crate::client::customize::internal::CustomizableSend<
36        crate::operation::describe_game_session_queues::DescribeGameSessionQueuesOutput,
37        crate::operation::describe_game_session_queues::DescribeGameSessionQueuesError,
38    > for DescribeGameSessionQueuesFluentBuilder
39{
40    fn send(
41        self,
42        config_override: crate::config::Builder,
43    ) -> crate::client::customize::internal::BoxFuture<
44        crate::client::customize::internal::SendResult<
45            crate::operation::describe_game_session_queues::DescribeGameSessionQueuesOutput,
46            crate::operation::describe_game_session_queues::DescribeGameSessionQueuesError,
47        >,
48    > {
49        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
50    }
51}
52impl DescribeGameSessionQueuesFluentBuilder {
53    /// Creates a new `DescribeGameSessionQueuesFluentBuilder`.
54    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
55        Self {
56            handle,
57            inner: ::std::default::Default::default(),
58            config_override: ::std::option::Option::None,
59        }
60    }
61    /// Access the DescribeGameSessionQueues as a reference.
62    pub fn as_input(&self) -> &crate::operation::describe_game_session_queues::builders::DescribeGameSessionQueuesInputBuilder {
63        &self.inner
64    }
65    /// Sends the request and returns the response.
66    ///
67    /// If an error occurs, an `SdkError` will be returned with additional details that
68    /// can be matched against.
69    ///
70    /// By default, any retryable failures will be retried twice. Retry behavior
71    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
72    /// set when configuring the client.
73    pub async fn send(
74        self,
75    ) -> ::std::result::Result<
76        crate::operation::describe_game_session_queues::DescribeGameSessionQueuesOutput,
77        ::aws_smithy_runtime_api::client::result::SdkError<
78            crate::operation::describe_game_session_queues::DescribeGameSessionQueuesError,
79            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
80        >,
81    > {
82        let input = self
83            .inner
84            .build()
85            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
86        let runtime_plugins = crate::operation::describe_game_session_queues::DescribeGameSessionQueues::operation_runtime_plugins(
87            self.handle.runtime_plugins.clone(),
88            &self.handle.conf,
89            self.config_override,
90        );
91        crate::operation::describe_game_session_queues::DescribeGameSessionQueues::orchestrate(&runtime_plugins, input).await
92    }
93
94    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
95    pub fn customize(
96        self,
97    ) -> crate::client::customize::CustomizableOperation<
98        crate::operation::describe_game_session_queues::DescribeGameSessionQueuesOutput,
99        crate::operation::describe_game_session_queues::DescribeGameSessionQueuesError,
100        Self,
101    > {
102        crate::client::customize::CustomizableOperation::new(self)
103    }
104    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
105        self.set_config_override(::std::option::Option::Some(config_override.into()));
106        self
107    }
108
109    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
110        self.config_override = config_override;
111        self
112    }
113    /// Create a paginator for this request
114    ///
115    /// Paginators are used by calling [`send().await`](crate::operation::describe_game_session_queues::paginator::DescribeGameSessionQueuesPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
116    pub fn into_paginator(self) -> crate::operation::describe_game_session_queues::paginator::DescribeGameSessionQueuesPaginator {
117        crate::operation::describe_game_session_queues::paginator::DescribeGameSessionQueuesPaginator::new(self.handle, self.inner)
118    }
119    ///
120    /// Appends an item to `Names`.
121    ///
122    /// To override the contents of this collection use [`set_names`](Self::set_names).
123    ///
124    /// <p>A list of queue names to retrieve information for. You can use either the queue ID or ARN value. To request settings for all queues, leave this parameter empty.</p>
125    pub fn names(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
126        self.inner = self.inner.names(input.into());
127        self
128    }
129    /// <p>A list of queue names to retrieve information for. You can use either the queue ID or ARN value. To request settings for all queues, leave this parameter empty.</p>
130    pub fn set_names(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
131        self.inner = self.inner.set_names(input);
132        self
133    }
134    /// <p>A list of queue names to retrieve information for. You can use either the queue ID or ARN value. To request settings for all queues, leave this parameter empty.</p>
135    pub fn get_names(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
136        self.inner.get_names()
137    }
138    /// <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages. You can request up to 50 results.</p>
139    pub fn limit(mut self, input: i32) -> Self {
140        self.inner = self.inner.limit(input);
141        self
142    }
143    /// <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages. You can request up to 50 results.</p>
144    pub fn set_limit(mut self, input: ::std::option::Option<i32>) -> Self {
145        self.inner = self.inner.set_limit(input);
146        self
147    }
148    /// <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages. You can request up to 50 results.</p>
149    pub fn get_limit(&self) -> &::std::option::Option<i32> {
150        self.inner.get_limit()
151    }
152    /// <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>
153    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
154        self.inner = self.inner.next_token(input.into());
155        self
156    }
157    /// <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>
158    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
159        self.inner = self.inner.set_next_token(input);
160        self
161    }
162    /// <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>
163    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
164        self.inner.get_next_token()
165    }
166}
aws_sdk_gamelift/operation/describe_game_session_queues/builders.rs

aws_sdk_gamelift/operation/describe_game_session_queues/
builders.rs
