Struct aws_sdk_gamelift::types::builders::PlayerSessionBuilder

#[non_exhaustive]
pub struct PlayerSessionBuilder { /* private fields */ }

A builder for PlayerSession.

Implementations

impl PlayerSessionBuilder

pub fn player_session_id(self, input: impl Into<String>) -> Self

A unique identifier for a player session.

pub fn set_player_session_id(self, input: Option<String>) -> Self

A unique identifier for a player session.

pub fn get_player_session_id(&self) -> &Option<String>

A unique identifier for a player session.

pub fn player_id(self, input: impl Into<String>) -> Self

A unique identifier for a player that is associated with this player session.

pub fn set_player_id(self, input: Option<String>) -> Self

A unique identifier for a player that is associated with this player session.

pub fn get_player_id(&self) -> &Option<String>

A unique identifier for a player that is associated with this player session.

pub fn game_session_id(self, input: impl Into<String>) -> Self

A unique identifier for the game session that the player session is connected to.

pub fn set_game_session_id(self, input: Option<String>) -> Self

A unique identifier for the game session that the player session is connected to.

pub fn get_game_session_id(&self) -> &Option<String>

A unique identifier for the game session that the player session is connected to.

pub fn fleet_id(self, input: impl Into<String>) -> Self

A unique identifier for the fleet that the player's game session is running on.

pub fn set_fleet_id(self, input: Option<String>) -> Self

A unique identifier for the fleet that the player's game session is running on.

pub fn get_fleet_id(&self) -> &Option<String>

A unique identifier for the fleet that the player's game session is running on.

pub fn fleet_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) associated with the GameLift fleet that the player's game session is running on.

pub fn set_fleet_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) associated with the GameLift fleet that the player's game session is running on.

pub fn get_fleet_arn(&self) -> &Option<String>

The Amazon Resource Name (ARN) associated with the GameLift fleet that the player's game session is running on.

pub fn creation_time(self, input: DateTime) -> Self

A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

pub fn set_creation_time(self, input: Option<DateTime>) -> Self

A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

pub fn get_creation_time(&self) -> &Option<DateTime>

A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

pub fn termination_time(self, input: DateTime) -> Self

A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

pub fn set_termination_time(self, input: Option<DateTime>) -> Self

A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

pub fn get_termination_time(&self) -> &Option<DateTime>

A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

pub fn status(self, input: PlayerSessionStatus) -> Self

Current status of the player session.

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).

pub fn set_status(self, input: Option<PlayerSessionStatus>) -> Self

Current status of the player session.

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).

pub fn get_status(&self) -> &Option<PlayerSessionStatus>

Current status of the player session.

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).

pub fn ip_address(self, input: impl Into<String>) -> Self

The IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.

pub fn set_ip_address(self, input: Option<String>) -> Self

The IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.

pub fn get_ip_address(&self) -> &Option<String>

The IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.

pub fn dns_name(self, input: impl Into<String>) -> Self

The DNS identifier assigned to the instance that is running the game session. Values have the following format:

• TLS-enabled fleets: . .amazongamelift.com .

• Non-TLS-enabled fleets: ec2- .compute.amazonaws.com . (See Amazon EC2 Instance IP Addressing.)

When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

pub fn set_dns_name(self, input: Option<String>) -> Self

The DNS identifier assigned to the instance that is running the game session. Values have the following format:

• TLS-enabled fleets: . .amazongamelift.com .

• Non-TLS-enabled fleets: ec2- .compute.amazonaws.com . (See Amazon EC2 Instance IP Addressing.)

When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

pub fn get_dns_name(&self) -> &Option<String>

The DNS identifier assigned to the instance that is running the game session. Values have the following format:

• TLS-enabled fleets: . .amazongamelift.com .

• Non-TLS-enabled fleets: ec2- .compute.amazonaws.com . (See Amazon EC2 Instance IP Addressing.)

When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

pub fn port(self, input: i32) -> Self

Port number for the game session. To connect to a Amazon GameLift server process, an app needs both the IP address and port number.

pub fn set_port(self, input: Option<i32>) -> Self

Port number for the game session. To connect to a Amazon GameLift server process, an app needs both the IP address and port number.

pub fn get_port(&self) -> &Option<i32>

Port number for the game session. To connect to a Amazon GameLift server process, an app needs both the IP address and port number.

pub fn player_data(self, input: impl Into<String>) -> Self

Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game.

pub fn set_player_data(self, input: Option<String>) -> Self

Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game.

pub fn get_player_data(&self) -> &Option<String>

Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game.

pub fn build(self) -> PlayerSession

Consumes the builder and constructs a PlayerSession.

Trait Implementations

impl Clone for PlayerSessionBuilder

fn clone(&self) -> PlayerSessionBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PlayerSessionBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PlayerSessionBuilder

fn default() -> PlayerSessionBuilder

Returns the “default value” for a type.

impl PartialEq for PlayerSessionBuilder

fn eq(&self, other: &PlayerSessionBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PlayerSessionBuilder