Struct aws_sdk_gamelift::input::StartMatchmakingInput

#[non_exhaustive]
pub struct StartMatchmakingInput {
    pub ticket_id: Option<String>,
    pub configuration_name: 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 matchmaking ticket status and retrieve match results.

configuration_name: Option<String>

Name of the matchmaking configuration to use for this request. Matchmaking configurations must exist in the same Region as this request. You can use either the configuration name or ARN value.

players: Option<Vec<Player>>

Information on each player to be matched. This information must include a player ID, and may contain player attributes and latency data to be used in the matchmaking process. After a successful match, Player objects contain the name of the team the player is assigned to.

Implementations

impl StartMatchmakingInput

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

Consumes the builder and constructs an Operation<StartMatchmaking>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture StartMatchmakingInput

impl StartMatchmakingInput

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 matchmaking ticket status and retrieve match results.

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

Name of the matchmaking configuration to use for this request. Matchmaking configurations must exist in the same Region as this request. You can use either the configuration name or ARN value.

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

Information on each player to be matched. This information must include a player ID, and may contain player attributes and latency data to be used in the matchmaking process. After a successful match, Player objects contain the name of the team the player is assigned to.

Trait Implementations

impl Clone for StartMatchmakingInput

fn clone(&self) -> StartMatchmakingInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartMatchmakingInput

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

Formats the value using the given formatter.

impl PartialEq<StartMatchmakingInput> for StartMatchmakingInput

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

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

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

This method tests for !=.

impl StructuralPartialEq for StartMatchmakingInput