Struct aws_sdk_gamelift::model::matchmaking_ticket::Builder
source · [−]pub struct Builder { /* private fields */ }
Expand description
A builder for MatchmakingTicket
.
Implementations
sourceimpl Builder
impl Builder
sourcepub fn ticket_id(self, input: impl Into<String>) -> Self
pub fn ticket_id(self, input: impl Into<String>) -> Self
A unique identifier for a matchmaking ticket.
sourcepub fn set_ticket_id(self, input: Option<String>) -> Self
pub fn set_ticket_id(self, input: Option<String>) -> Self
A unique identifier for a matchmaking ticket.
sourcepub fn configuration_name(self, input: impl Into<String>) -> Self
pub fn configuration_name(self, input: impl Into<String>) -> Self
Name of the MatchmakingConfiguration
that is used with this ticket. Matchmaking configurations determine how players are grouped into a match and how a new game session is created for the match.
sourcepub fn set_configuration_name(self, input: Option<String>) -> Self
pub fn set_configuration_name(self, input: Option<String>) -> Self
Name of the MatchmakingConfiguration
that is used with this ticket. Matchmaking configurations determine how players are grouped into a match and how a new game session is created for the match.
sourcepub fn configuration_arn(self, input: impl Into<String>) -> Self
pub fn configuration_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) associated with the GameLift matchmaking configuration resource that is used with this ticket.
sourcepub fn set_configuration_arn(self, input: Option<String>) -> Self
pub fn set_configuration_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) associated with the GameLift matchmaking configuration resource that is used with this ticket.
sourcepub fn status(self, input: MatchmakingConfigurationStatus) -> Self
pub fn status(self, input: MatchmakingConfigurationStatus) -> Self
Current status of the matchmaking request.
-
QUEUED -- The matchmaking request has been received and is currently waiting to be processed.
-
SEARCHING -- The matchmaking request is currently being processed.
-
REQUIRES_ACCEPTANCE -- A match has been proposed and the players must accept the match (see
AcceptMatch
). This status is used only with requests that use a matchmaking configuration with a player acceptance requirement. -
PLACING -- The FlexMatch engine has matched players and is in the process of placing a new game session for the match.
-
COMPLETED -- Players have been matched and a game session is ready to host the players. A ticket in this state contains the necessary connection information for players.
-
FAILED -- The matchmaking request was not completed.
-
CANCELLED -- The matchmaking request was canceled. This may be the result of a call to
StopMatchmaking
or a proposed match that one or more players failed to accept. -
TIMED_OUT -- The matchmaking request was not successful within the duration specified in the matchmaking configuration.
Matchmaking requests that fail to successfully complete (statuses FAILED, CANCELLED, TIMED_OUT) can be resubmitted as new requests with new ticket IDs.
sourcepub fn set_status(self, input: Option<MatchmakingConfigurationStatus>) -> Self
pub fn set_status(self, input: Option<MatchmakingConfigurationStatus>) -> Self
Current status of the matchmaking request.
-
QUEUED -- The matchmaking request has been received and is currently waiting to be processed.
-
SEARCHING -- The matchmaking request is currently being processed.
-
REQUIRES_ACCEPTANCE -- A match has been proposed and the players must accept the match (see
AcceptMatch
). This status is used only with requests that use a matchmaking configuration with a player acceptance requirement. -
PLACING -- The FlexMatch engine has matched players and is in the process of placing a new game session for the match.
-
COMPLETED -- Players have been matched and a game session is ready to host the players. A ticket in this state contains the necessary connection information for players.
-
FAILED -- The matchmaking request was not completed.
-
CANCELLED -- The matchmaking request was canceled. This may be the result of a call to
StopMatchmaking
or a proposed match that one or more players failed to accept. -
TIMED_OUT -- The matchmaking request was not successful within the duration specified in the matchmaking configuration.
Matchmaking requests that fail to successfully complete (statuses FAILED, CANCELLED, TIMED_OUT) can be resubmitted as new requests with new ticket IDs.
sourcepub fn status_reason(self, input: impl Into<String>) -> Self
pub fn status_reason(self, input: impl Into<String>) -> Self
Code to explain the current status. For example, a status reason may indicate when a ticket has returned to SEARCHING
status after a proposed match fails to receive player acceptances.
sourcepub fn set_status_reason(self, input: Option<String>) -> Self
pub fn set_status_reason(self, input: Option<String>) -> Self
Code to explain the current status. For example, a status reason may indicate when a ticket has returned to SEARCHING
status after a proposed match fails to receive player acceptances.
sourcepub fn status_message(self, input: impl Into<String>) -> Self
pub fn status_message(self, input: impl Into<String>) -> Self
Additional information about the current status.
sourcepub fn set_status_message(self, input: Option<String>) -> Self
pub fn set_status_message(self, input: Option<String>) -> Self
Additional information about the current status.
sourcepub fn start_time(self, input: DateTime) -> Self
pub fn start_time(self, input: DateTime) -> Self
Time stamp indicating when this matchmaking request was received. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"
).
sourcepub fn set_start_time(self, input: Option<DateTime>) -> Self
pub fn set_start_time(self, input: Option<DateTime>) -> Self
Time stamp indicating when this matchmaking request was received. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"
).
sourcepub fn end_time(self, input: DateTime) -> Self
pub fn end_time(self, input: DateTime) -> Self
Time stamp indicating when this matchmaking request stopped being processed due to success, failure, or cancellation. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"
).
sourcepub fn set_end_time(self, input: Option<DateTime>) -> Self
pub fn set_end_time(self, input: Option<DateTime>) -> Self
Time stamp indicating when this matchmaking request stopped being processed due to success, failure, or cancellation. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"
).
sourcepub fn players(self, input: Player) -> Self
pub fn players(self, input: Player) -> Self
Appends an item to players
.
To override the contents of this collection use set_players
.
A set of Player
objects, each representing a player to find matches for. Players are identified by a unique player ID and may include latency data for use during matchmaking. If the ticket is in status COMPLETED
, the Player
objects include the team the players were assigned to in the resulting match.
sourcepub fn set_players(self, input: Option<Vec<Player>>) -> Self
pub fn set_players(self, input: Option<Vec<Player>>) -> Self
A set of Player
objects, each representing a player to find matches for. Players are identified by a unique player ID and may include latency data for use during matchmaking. If the ticket is in status COMPLETED
, the Player
objects include the team the players were assigned to in the resulting match.
sourcepub fn game_session_connection_info(
self,
input: GameSessionConnectionInfo
) -> Self
pub fn game_session_connection_info(
self,
input: GameSessionConnectionInfo
) -> Self
Identifier and connection information of the game session created for the match. This information is added to the ticket only after the matchmaking request has been successfully completed. This parameter is not set when FlexMatch is being used without GameLift hosting.
sourcepub fn set_game_session_connection_info(
self,
input: Option<GameSessionConnectionInfo>
) -> Self
pub fn set_game_session_connection_info(
self,
input: Option<GameSessionConnectionInfo>
) -> Self
Identifier and connection information of the game session created for the match. This information is added to the ticket only after the matchmaking request has been successfully completed. This parameter is not set when FlexMatch is being used without GameLift hosting.
sourcepub fn estimated_wait_time(self, input: i32) -> Self
pub fn estimated_wait_time(self, input: i32) -> Self
Average amount of time (in seconds) that players are currently waiting for a match. If there is not enough recent data, this property may be empty.
sourcepub fn set_estimated_wait_time(self, input: Option<i32>) -> Self
pub fn set_estimated_wait_time(self, input: Option<i32>) -> Self
Average amount of time (in seconds) that players are currently waiting for a match. If there is not enough recent data, this property may be empty.
sourcepub fn build(self) -> MatchmakingTicket
pub fn build(self) -> MatchmakingTicket
Consumes the builder and constructs a MatchmakingTicket
.
Trait Implementations
impl StructuralPartialEq for Builder
Auto Trait Implementations
impl RefUnwindSafe for Builder
impl Send for Builder
impl Sync for Builder
impl Unpin for Builder
impl UnwindSafe for Builder
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more