#[non_exhaustive]pub struct DescribePlayerSessionsInputBuilder { /* private fields */ }Expand description
A builder for DescribePlayerSessionsInput.
Implementations§
Source§impl DescribePlayerSessionsInputBuilder
impl DescribePlayerSessionsInputBuilder
Sourcepub fn game_session_id(self, input: impl Into<String>) -> Self
pub fn game_session_id(self, input: impl Into<String>) -> Self
A unique identifier for the game session to retrieve player sessions for.
Sourcepub fn set_game_session_id(self, input: Option<String>) -> Self
pub fn set_game_session_id(self, input: Option<String>) -> Self
A unique identifier for the game session to retrieve player sessions for.
Sourcepub fn get_game_session_id(&self) -> &Option<String>
pub fn get_game_session_id(&self) -> &Option<String>
A unique identifier for the game session to retrieve player sessions for.
Sourcepub fn player_id(self, input: impl Into<String>) -> Self
pub fn player_id(self, input: impl Into<String>) -> Self
A unique identifier for a player to retrieve player sessions for.
Sourcepub fn set_player_id(self, input: Option<String>) -> Self
pub fn set_player_id(self, input: Option<String>) -> Self
A unique identifier for a player to retrieve player sessions for.
Sourcepub fn get_player_id(&self) -> &Option<String>
pub fn get_player_id(&self) -> &Option<String>
A unique identifier for a player to retrieve player sessions for.
Sourcepub fn player_session_id(self, input: impl Into<String>) -> Self
pub fn player_session_id(self, input: impl Into<String>) -> Self
A unique identifier for a player session to retrieve.
Sourcepub fn set_player_session_id(self, input: Option<String>) -> Self
pub fn set_player_session_id(self, input: Option<String>) -> Self
A unique identifier for a player session to retrieve.
Sourcepub fn get_player_session_id(&self) -> &Option<String>
pub fn get_player_session_id(&self) -> &Option<String>
A unique identifier for a player session to retrieve.
Sourcepub fn player_session_status_filter(self, input: impl Into<String>) -> Self
pub fn player_session_status_filter(self, input: impl Into<String>) -> Self
Player session status to filter results on. Note that when a PlayerSessionId or PlayerId is provided in a DescribePlayerSessions request, then the PlayerSessionStatusFilter has no effect on the response.
Possible player session statuses include the following:
-
RESERVED -- The player session request has been received, but the player has not yet connected to the server process and/or been validated.
-
ACTIVE -- The player has been validated by the server process and is currently connected.
-
COMPLETED -- The player connection has been dropped.
-
TIMEDOUT -- A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).
Sourcepub fn set_player_session_status_filter(self, input: Option<String>) -> Self
pub fn set_player_session_status_filter(self, input: Option<String>) -> Self
Player session status to filter results on. Note that when a PlayerSessionId or PlayerId is provided in a DescribePlayerSessions request, then the PlayerSessionStatusFilter has no effect on the response.
Possible player session statuses include the following:
-
RESERVED -- The player session request has been received, but the player has not yet connected to the server process and/or been validated.
-
ACTIVE -- The player has been validated by the server process and is currently connected.
-
COMPLETED -- The player connection has been dropped.
-
TIMEDOUT -- A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).
Sourcepub fn get_player_session_status_filter(&self) -> &Option<String>
pub fn get_player_session_status_filter(&self) -> &Option<String>
Player session status to filter results on. Note that when a PlayerSessionId or PlayerId is provided in a DescribePlayerSessions request, then the PlayerSessionStatusFilter has no effect on the response.
Possible player session statuses include the following:
-
RESERVED -- The player session request has been received, but the player has not yet connected to the server process and/or been validated.
-
ACTIVE -- The player has been validated by the server process and is currently connected.
-
COMPLETED -- The player connection has been dropped.
-
TIMEDOUT -- A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).
Sourcepub fn limit(self, input: i32) -> Self
pub fn limit(self, input: i32) -> Self
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. If a player session ID is specified, this parameter is ignored.
Sourcepub fn set_limit(self, input: Option<i32>) -> Self
pub fn set_limit(self, input: Option<i32>) -> Self
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. If a player session ID is specified, this parameter is ignored.
Sourcepub fn get_limit(&self) -> &Option<i32>
pub fn get_limit(&self) -> &Option<i32>
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. If a player session ID is specified, this parameter is ignored.
Sourcepub fn next_token(self, input: impl Into<String>) -> Self
pub fn next_token(self, input: impl Into<String>) -> Self
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. If a player session ID is specified, this parameter is ignored.
Sourcepub fn set_next_token(self, input: Option<String>) -> Self
pub fn set_next_token(self, input: Option<String>) -> Self
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. If a player session ID is specified, this parameter is ignored.
Sourcepub fn get_next_token(&self) -> &Option<String>
pub fn get_next_token(&self) -> &Option<String>
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. If a player session ID is specified, this parameter is ignored.
Sourcepub fn build(self) -> Result<DescribePlayerSessionsInput, BuildError>
pub fn build(self) -> Result<DescribePlayerSessionsInput, BuildError>
Consumes the builder and constructs a DescribePlayerSessionsInput.
Source§impl DescribePlayerSessionsInputBuilder
impl DescribePlayerSessionsInputBuilder
Sourcepub async fn send_with(
self,
client: &Client,
) -> Result<DescribePlayerSessionsOutput, SdkError<DescribePlayerSessionsError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<DescribePlayerSessionsOutput, SdkError<DescribePlayerSessionsError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
Source§impl Clone for DescribePlayerSessionsInputBuilder
impl Clone for DescribePlayerSessionsInputBuilder
Source§fn clone(&self) -> DescribePlayerSessionsInputBuilder
fn clone(&self) -> DescribePlayerSessionsInputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Default for DescribePlayerSessionsInputBuilder
impl Default for DescribePlayerSessionsInputBuilder
Source§fn default() -> DescribePlayerSessionsInputBuilder
fn default() -> DescribePlayerSessionsInputBuilder
Source§impl PartialEq for DescribePlayerSessionsInputBuilder
impl PartialEq for DescribePlayerSessionsInputBuilder
Source§fn eq(&self, other: &DescribePlayerSessionsInputBuilder) -> bool
fn eq(&self, other: &DescribePlayerSessionsInputBuilder) -> bool
self and other values to be equal, and is used by ==.impl StructuralPartialEq for DescribePlayerSessionsInputBuilder
Auto Trait Implementations§
impl Freeze for DescribePlayerSessionsInputBuilder
impl RefUnwindSafe for DescribePlayerSessionsInputBuilder
impl Send for DescribePlayerSessionsInputBuilder
impl Sync for DescribePlayerSessionsInputBuilder
impl Unpin for DescribePlayerSessionsInputBuilder
impl UnwindSafe for DescribePlayerSessionsInputBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);