aws_sdk_gamelift/operation/create_player_session/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_player_session::_create_player_session_output::CreatePlayerSessionOutputBuilder;
3
4pub use crate::operation::create_player_session::_create_player_session_input::CreatePlayerSessionInputBuilder;
5
6impl crate::operation::create_player_session::builders::CreatePlayerSessionInputBuilder {
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_session::CreatePlayerSessionOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::create_player_session::CreatePlayerSessionError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.create_player_session();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `CreatePlayerSession`.
24///
25/// <p><b>This API works with the following fleet types:</b> EC2, Anywhere, Container</p>
26/// <p>Reserves an open player slot in a game session for a player. 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>. You can add a group of players to a game session with <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreatePlayerSessions.html">CreatePlayerSessions</a> .</p>
27/// <p>To create a player session, specify a game session ID, player ID, and optionally a set of player data.</p>
28/// <p>If successful, a slot is reserved in the game session for the player and a new <code>PlayerSessions</code> object is returned with a player session ID. The player references the 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 CreatePlayerSessionFluentBuilder {
34    handle: ::std::sync::Arc<crate::client::Handle>,
35    inner: crate::operation::create_player_session::builders::CreatePlayerSessionInputBuilder,
36    config_override: ::std::option::Option<crate::config::Builder>,
37}
38impl
39    crate::client::customize::internal::CustomizableSend<
40        crate::operation::create_player_session::CreatePlayerSessionOutput,
41        crate::operation::create_player_session::CreatePlayerSessionError,
42    > for CreatePlayerSessionFluentBuilder
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_session::CreatePlayerSessionOutput,
50            crate::operation::create_player_session::CreatePlayerSessionError,
51        >,
52    > {
53        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
54    }
55}
56impl CreatePlayerSessionFluentBuilder {
57    /// Creates a new `CreatePlayerSessionFluentBuilder`.
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 CreatePlayerSession as a reference.
66    pub fn as_input(&self) -> &crate::operation::create_player_session::builders::CreatePlayerSessionInputBuilder {
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_session::CreatePlayerSessionOutput,
81        ::aws_smithy_runtime_api::client::result::SdkError<
82            crate::operation::create_player_session::CreatePlayerSessionError,
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_session::CreatePlayerSession::operation_runtime_plugins(
91            self.handle.runtime_plugins.clone(),
92            &self.handle.conf,
93            self.config_override,
94        );
95        crate::operation::create_player_session::CreatePlayerSession::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_session::CreatePlayerSessionOutput,
103        crate::operation::create_player_session::CreatePlayerSessionError,
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 a player 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 a player 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 a player 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    /// <p>A unique identifier for a player. Player IDs are developer-defined.</p>
132    pub fn player_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
133        self.inner = self.inner.player_id(input.into());
134        self
135    }
136    /// <p>A unique identifier for a player. Player IDs are developer-defined.</p>
137    pub fn set_player_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
138        self.inner = self.inner.set_player_id(input);
139        self
140    }
141    /// <p>A unique identifier for a player. Player IDs are developer-defined.</p>
142    pub fn get_player_id(&self) -> &::std::option::Option<::std::string::String> {
143        self.inner.get_player_id()
144    }
145    /// <p>Developer-defined information related to a player. Amazon GameLift Servers does not use this data, so it can be formatted as needed for use in the game.</p>
146    pub fn player_data(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
147        self.inner = self.inner.player_data(input.into());
148        self
149    }
150    /// <p>Developer-defined information related to a player. Amazon GameLift Servers does not use this data, so it can be formatted as needed for use in the game.</p>
151    pub fn set_player_data(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
152        self.inner = self.inner.set_player_data(input);
153        self
154    }
155    /// <p>Developer-defined information related to a player. Amazon GameLift Servers does not use this data, so it can be formatted as needed for use in the game.</p>
156    pub fn get_player_data(&self) -> &::std::option::Option<::std::string::String> {
157        self.inner.get_player_data()
158    }
159}
aws_sdk_gamelift/operation/create_player_session/builders.rs

aws_sdk_gamelift/operation/create_player_session/
builders.rs
