Struct aws_sdk_gamelift::input::StartMatchBackfillInput

#[non_exhaustive]
pub struct StartMatchBackfillInput {
    pub ticket_id: Option<String>,
    pub configuration_name: Option<String>,
    pub game_session_arn: Option<String>,
    pub players: Option<Vec<Player>>,
}

Represents the input for a request operation.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

ticket_id: Option<String>

A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of a UUID. Use this identifier to track the match backfill ticket status and retrieve match results.

configuration_name: Option<String>

Name of the matchmaker to use for this request. You can use either the configuration name or ARN value. The ARN of the matchmaker that was used with the original game session is listed in the GameSession object, MatchmakerData property.

game_session_arn: Option<String>

A unique identifier for the game session. Use the game session ID. When using FlexMatch as a standalone matchmaking solution, this parameter is not needed.

players: Option<Vec<Player>>

Match information on all players that are currently assigned to the game session. This information is used by the matchmaker to find new players and add them to the existing game.

• PlayerID, PlayerAttributes, Team -- This information is maintained in the GameSession object, MatchmakerData property, for all players who are currently assigned to the game session. The matchmaker data is in JSON syntax, formatted as a string. For more details, see Match Data.

  The backfill request must specify the team membership for every player. Do not specify team if you are not using backfill.

• LatencyInMs -- If the matchmaker uses player latency, include a latency value, in milliseconds, for the Region that the game session is currently in. Do not include latency values for any other Region.

Implementations

impl StartMatchBackfillInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<StartMatchBackfill, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<StartMatchBackfill>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture StartMatchBackfillInput

impl StartMatchBackfillInput

pub fn ticket_id(&self) -> Option<&str>

A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of a UUID. Use this identifier to track the match backfill ticket status and retrieve match results.

pub fn configuration_name(&self) -> Option<&str>

Name of the matchmaker to use for this request. You can use either the configuration name or ARN value. The ARN of the matchmaker that was used with the original game session is listed in the GameSession object, MatchmakerData property.

pub fn game_session_arn(&self) -> Option<&str>

A unique identifier for the game session. Use the game session ID. When using FlexMatch as a standalone matchmaking solution, this parameter is not needed.

pub fn players(&self) -> Option<&[Player]>

Match information on all players that are currently assigned to the game session. This information is used by the matchmaker to find new players and add them to the existing game.

• PlayerID, PlayerAttributes, Team -- This information is maintained in the GameSession object, MatchmakerData property, for all players who are currently assigned to the game session. The matchmaker data is in JSON syntax, formatted as a string. For more details, see Match Data.

  The backfill request must specify the team membership for every player. Do not specify team if you are not using backfill.

• LatencyInMs -- If the matchmaker uses player latency, include a latency value, in milliseconds, for the Region that the game session is currently in. Do not include latency values for any other Region.

Trait Implementations

impl Clone for StartMatchBackfillInput

fn clone(&self) -> StartMatchBackfillInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartMatchBackfillInput

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

Formats the value using the given formatter.

impl PartialEq<StartMatchBackfillInput> for StartMatchBackfillInput

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

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

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

This method tests for !=.

impl StructuralPartialEq for StartMatchBackfillInput