aws_sdk_gamelift/operation/create_player_sessions/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_player_sessions::_create_player_sessions_output::CreatePlayerSessionsOutputBuilder;
3
4pub use crate::operation::create_player_sessions::_create_player_sessions_input::CreatePlayerSessionsInputBuilder;
5
6impl crate::operation::create_player_sessions::builders::CreatePlayerSessionsInputBuilder {
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::create_player_sessions::CreatePlayerSessionsOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::create_player_sessions::CreatePlayerSessionsError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.create_player_sessions();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `CreatePlayerSessions`.
24///
25/// <p><b>This API works with the following fleet types:</b> EC2, Anywhere, Container</p>
26/// <p>Reserves open slots in a game session for a group of players. New player sessions can be created in any game session with an open slot that is in <code>ACTIVE</code> status and has a player creation policy of <code>ACCEPT_ALL</code>. To add a single player to a game session, use <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreatePlayerSession.html">CreatePlayerSession</a></p>
27/// <p>To create player sessions, specify a game session ID and a list of player IDs. Optionally, provide a set of player data for each player ID.</p>
28/// <p>If successful, a slot is reserved in the game session for each player, and new <code>PlayerSession</code> objects are returned with player session IDs. Each player references their player session ID when sending a connection request to the game session, and the game server can use it to validate the player reservation with the Amazon GameLift Servers service. Player sessions cannot be updated.</p>
29/// <p>The maximum number of players per game session is 200. It is not adjustable.</p>
30/// <p><b>Related actions</b></p>
31/// <p><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a></p>
32#[derive(::std::clone::Clone, ::std::fmt::Debug)]
33pub struct CreatePlayerSessionsFluentBuilder {
34    handle: ::std::sync::Arc<crate::client::Handle>,
35    inner: crate::operation::create_player_sessions::builders::CreatePlayerSessionsInputBuilder,
36    config_override: ::std::option::Option<crate::config::Builder>,
37}
38impl
39    crate::client::customize::internal::CustomizableSend<
40        crate::operation::create_player_sessions::CreatePlayerSessionsOutput,
41        crate::operation::create_player_sessions::CreatePlayerSessionsError,
42    > for CreatePlayerSessionsFluentBuilder
43{
44    fn send(
45        self,
46        config_override: crate::config::Builder,
47    ) -> crate::client::customize::internal::BoxFuture<
48        crate::client::customize::internal::SendResult<
49            crate::operation::create_player_sessions::CreatePlayerSessionsOutput,
50            crate::operation::create_player_sessions::CreatePlayerSessionsError,
51        >,
52    > {
53        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
54    }
55}
56impl CreatePlayerSessionsFluentBuilder {
57    /// Creates a new `CreatePlayerSessionsFluentBuilder`.
58    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
59        Self {
60            handle,
61            inner: ::std::default::Default::default(),
62            config_override: ::std::option::Option::None,
63        }
64    }
65    /// Access the CreatePlayerSessions as a reference.
66    pub fn as_input(&self) -> &crate::operation::create_player_sessions::builders::CreatePlayerSessionsInputBuilder {
67        &self.inner
68    }
69    /// Sends the request and returns the response.
70    ///
71    /// If an error occurs, an `SdkError` will be returned with additional details that
72    /// can be matched against.
73    ///
74    /// By default, any retryable failures will be retried twice. Retry behavior
75    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
76    /// set when configuring the client.
77    pub async fn send(
78        self,
79    ) -> ::std::result::Result<
80        crate::operation::create_player_sessions::CreatePlayerSessionsOutput,
81        ::aws_smithy_runtime_api::client::result::SdkError<
82            crate::operation::create_player_sessions::CreatePlayerSessionsError,
83            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
84        >,
85    > {
86        let input = self
87            .inner
88            .build()
89            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
90        let runtime_plugins = crate::operation::create_player_sessions::CreatePlayerSessions::operation_runtime_plugins(
91            self.handle.runtime_plugins.clone(),
92            &self.handle.conf,
93            self.config_override,
94        );
95        crate::operation::create_player_sessions::CreatePlayerSessions::orchestrate(&runtime_plugins, input).await
96    }
97
98    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
99    pub fn customize(
100        self,
101    ) -> crate::client::customize::CustomizableOperation<
102        crate::operation::create_player_sessions::CreatePlayerSessionsOutput,
103        crate::operation::create_player_sessions::CreatePlayerSessionsError,
104        Self,
105    > {
106        crate::client::customize::CustomizableOperation::new(self)
107    }
108    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
109        self.set_config_override(::std::option::Option::Some(config_override.into()));
110        self
111    }
112
113    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
114        self.config_override = config_override;
115        self
116    }
117    /// <p>A unique identifier for the game session to add players to.</p>
118    pub fn game_session_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
119        self.inner = self.inner.game_session_id(input.into());
120        self
121    }
122    /// <p>A unique identifier for the game session to add players to.</p>
123    pub fn set_game_session_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
124        self.inner = self.inner.set_game_session_id(input);
125        self
126    }
127    /// <p>A unique identifier for the game session to add players to.</p>
128    pub fn get_game_session_id(&self) -> &::std::option::Option<::std::string::String> {
129        self.inner.get_game_session_id()
130    }
131    ///
132    /// Appends an item to `PlayerIds`.
133    ///
134    /// To override the contents of this collection use [`set_player_ids`](Self::set_player_ids).
135    ///
136    /// <p>List of unique identifiers for the players to be added.</p>
137    pub fn player_ids(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
138        self.inner = self.inner.player_ids(input.into());
139        self
140    }
141    /// <p>List of unique identifiers for the players to be added.</p>
142    pub fn set_player_ids(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
143        self.inner = self.inner.set_player_ids(input);
144        self
145    }
146    /// <p>List of unique identifiers for the players to be added.</p>
147    pub fn get_player_ids(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
148        self.inner.get_player_ids()
149    }
150    ///
151    /// Adds a key-value pair to `PlayerDataMap`.
152    ///
153    /// To override the contents of this collection use [`set_player_data_map`](Self::set_player_data_map).
154    ///
155    /// <p>Map of string pairs, each specifying a player ID and a set of developer-defined information related to the player. Amazon GameLift Servers does not use this data, so it can be formatted as needed for use in the game. Any player data strings for player IDs that are not included in the <code>PlayerIds</code> parameter are ignored.</p>
156    pub fn player_data_map(
157        mut self,
158        k: impl ::std::convert::Into<::std::string::String>,
159        v: impl ::std::convert::Into<::std::string::String>,
160    ) -> Self {
161        self.inner = self.inner.player_data_map(k.into(), v.into());
162        self
163    }
164    /// <p>Map of string pairs, each specifying a player ID and a set of developer-defined information related to the player. Amazon GameLift Servers does not use this data, so it can be formatted as needed for use in the game. Any player data strings for player IDs that are not included in the <code>PlayerIds</code> parameter are ignored.</p>
165    pub fn set_player_data_map(
166        mut self,
167        input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
168    ) -> Self {
169        self.inner = self.inner.set_player_data_map(input);
170        self
171    }
172    /// <p>Map of string pairs, each specifying a player ID and a set of developer-defined information related to the player. Amazon GameLift Servers does not use this data, so it can be formatted as needed for use in the game. Any player data strings for player IDs that are not included in the <code>PlayerIds</code> parameter are ignored.</p>
173    pub fn get_player_data_map(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
174        self.inner.get_player_data_map()
175    }
176}
aws_sdk_gamelift/operation/create_player_sessions/builders.rs

aws_sdk_gamelift/operation/create_player_sessions/
builders.rs
