#[non_exhaustive]pub struct UpdateMatchmakingConfigurationInput {Show 14 fields
pub name: Option<String>,
pub description: Option<String>,
pub game_session_queue_arns: Option<Vec<String>>,
pub request_timeout_seconds: Option<i32>,
pub acceptance_timeout_seconds: Option<i32>,
pub acceptance_required: Option<bool>,
pub rule_set_name: Option<String>,
pub notification_target: Option<String>,
pub additional_player_count: Option<i32>,
pub custom_event_data: Option<String>,
pub game_properties: Option<Vec<GameProperty>>,
pub game_session_data: Option<String>,
pub backfill_mode: Option<BackfillMode>,
pub flex_match_mode: Option<FlexMatchMode>,
}Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.name: Option<String>A unique identifier for the matchmaking configuration to update. You can use either the configuration name or ARN value.
description: Option<String>A description for the matchmaking configuration.
game_session_queue_arns: Option<Vec<String>>The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift Servers game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:. Queues can be located in any Region. Queues are used to start new Amazon GameLift Servers-hosted game sessions for matches that are created with this matchmaking configuration. If FlexMatchMode is set to STANDALONE, do not set this parameter.
request_timeout_seconds: Option<i32>The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that fail due to timing out can be resubmitted as needed.
acceptance_timeout_seconds: Option<i32>The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.
acceptance_required: Option<bool>A flag that indicates whether a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE. With this option enabled, matchmaking tickets use the status REQUIRES_ACCEPTANCE to indicate when a completed potential match is waiting for player acceptance.
rule_set_name: Option<String>A unique identifier for the matchmaking rule set to use with this configuration. You can use either the rule set name or ARN value. A matchmaking configuration can only use rule sets that are defined in the same Region.
notification_target: Option<String>An SNS topic ARN that is set up to receive matchmaking notifications. See Setting up notifications for matchmaking for more information.
additional_player_count: Option<i32>The number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match. This parameter is not used if FlexMatchMode is set to STANDALONE.
custom_event_data: Option<String>Information to add to all events related to the matchmaking configuration.
game_properties: Option<Vec<GameProperty>>A set of key-value pairs that can store custom data in a game session. For example: {"Key": "difficulty", "Value": "novice"}. This information is added to the new GameSession object that is created for a successful match. This parameter is not used if FlexMatchMode is set to STANDALONE.
game_session_data: Option<String>A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session. For more information, see Start a game session. This information is added to the game session that is created for a successful match. This parameter is not used if FlexMatchMode is set to STANDALONE.
backfill_mode: Option<BackfillMode>The method that is used to backfill game sessions created with this matchmaking configuration. Specify MANUAL when your game manages backfill requests manually or does not use the match backfill feature. Specify AUTOMATIC to have GameLift create a match backfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill Existing Games with FlexMatch. Automatic backfill is not available when FlexMatchMode is set to STANDALONE.
flex_match_mode: Option<FlexMatchMode>Indicates whether this matchmaking configuration is being used with Amazon GameLift Servers hosting or as a standalone matchmaking solution.
-
STANDALONE - FlexMatch forms matches and returns match information, including players and team assignments, in a MatchmakingSucceeded event.
-
WITH_QUEUE - FlexMatch forms matches and uses the specified Amazon GameLift Servers queue to start a game session for the match.
Implementations§
Source§impl UpdateMatchmakingConfigurationInput
impl UpdateMatchmakingConfigurationInput
Sourcepub fn name(&self) -> Option<&str>
pub fn name(&self) -> Option<&str>
A unique identifier for the matchmaking configuration to update. You can use either the configuration name or ARN value.
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
A description for the matchmaking configuration.
Sourcepub fn game_session_queue_arns(&self) -> &[String]
pub fn game_session_queue_arns(&self) -> &[String]
The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift Servers game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:. Queues can be located in any Region. Queues are used to start new Amazon GameLift Servers-hosted game sessions for matches that are created with this matchmaking configuration. If FlexMatchMode is set to STANDALONE, do not set this parameter.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .game_session_queue_arns.is_none().
Sourcepub fn request_timeout_seconds(&self) -> Option<i32>
pub fn request_timeout_seconds(&self) -> Option<i32>
The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that fail due to timing out can be resubmitted as needed.
Sourcepub fn acceptance_timeout_seconds(&self) -> Option<i32>
pub fn acceptance_timeout_seconds(&self) -> Option<i32>
The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.
Sourcepub fn acceptance_required(&self) -> Option<bool>
pub fn acceptance_required(&self) -> Option<bool>
A flag that indicates whether a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE. With this option enabled, matchmaking tickets use the status REQUIRES_ACCEPTANCE to indicate when a completed potential match is waiting for player acceptance.
Sourcepub fn rule_set_name(&self) -> Option<&str>
pub fn rule_set_name(&self) -> Option<&str>
A unique identifier for the matchmaking rule set to use with this configuration. You can use either the rule set name or ARN value. A matchmaking configuration can only use rule sets that are defined in the same Region.
Sourcepub fn notification_target(&self) -> Option<&str>
pub fn notification_target(&self) -> Option<&str>
An SNS topic ARN that is set up to receive matchmaking notifications. See Setting up notifications for matchmaking for more information.
Sourcepub fn additional_player_count(&self) -> Option<i32>
pub fn additional_player_count(&self) -> Option<i32>
The number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match. This parameter is not used if FlexMatchMode is set to STANDALONE.
Sourcepub fn custom_event_data(&self) -> Option<&str>
pub fn custom_event_data(&self) -> Option<&str>
Information to add to all events related to the matchmaking configuration.
Sourcepub fn game_properties(&self) -> &[GameProperty]
pub fn game_properties(&self) -> &[GameProperty]
A set of key-value pairs that can store custom data in a game session. For example: {"Key": "difficulty", "Value": "novice"}. This information is added to the new GameSession object that is created for a successful match. This parameter is not used if FlexMatchMode is set to STANDALONE.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .game_properties.is_none().
Sourcepub fn game_session_data(&self) -> Option<&str>
pub fn game_session_data(&self) -> Option<&str>
A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session. For more information, see Start a game session. This information is added to the game session that is created for a successful match. This parameter is not used if FlexMatchMode is set to STANDALONE.
Sourcepub fn backfill_mode(&self) -> Option<&BackfillMode>
pub fn backfill_mode(&self) -> Option<&BackfillMode>
The method that is used to backfill game sessions created with this matchmaking configuration. Specify MANUAL when your game manages backfill requests manually or does not use the match backfill feature. Specify AUTOMATIC to have GameLift create a match backfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill Existing Games with FlexMatch. Automatic backfill is not available when FlexMatchMode is set to STANDALONE.
Sourcepub fn flex_match_mode(&self) -> Option<&FlexMatchMode>
pub fn flex_match_mode(&self) -> Option<&FlexMatchMode>
Indicates whether this matchmaking configuration is being used with Amazon GameLift Servers hosting or as a standalone matchmaking solution.
-
STANDALONE - FlexMatch forms matches and returns match information, including players and team assignments, in a MatchmakingSucceeded event.
-
WITH_QUEUE - FlexMatch forms matches and uses the specified Amazon GameLift Servers queue to start a game session for the match.
Source§impl UpdateMatchmakingConfigurationInput
impl UpdateMatchmakingConfigurationInput
Sourcepub fn builder() -> UpdateMatchmakingConfigurationInputBuilder
pub fn builder() -> UpdateMatchmakingConfigurationInputBuilder
Creates a new builder-style object to manufacture UpdateMatchmakingConfigurationInput.
Trait Implementations§
Source§impl Clone for UpdateMatchmakingConfigurationInput
impl Clone for UpdateMatchmakingConfigurationInput
Source§fn clone(&self) -> UpdateMatchmakingConfigurationInput
fn clone(&self) -> UpdateMatchmakingConfigurationInput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl PartialEq for UpdateMatchmakingConfigurationInput
impl PartialEq for UpdateMatchmakingConfigurationInput
Source§fn eq(&self, other: &UpdateMatchmakingConfigurationInput) -> bool
fn eq(&self, other: &UpdateMatchmakingConfigurationInput) -> bool
self and other values to be equal, and is used by ==.impl StructuralPartialEq for UpdateMatchmakingConfigurationInput
Auto Trait Implementations§
impl Freeze for UpdateMatchmakingConfigurationInput
impl RefUnwindSafe for UpdateMatchmakingConfigurationInput
impl Send for UpdateMatchmakingConfigurationInput
impl Sync for UpdateMatchmakingConfigurationInput
impl Unpin for UpdateMatchmakingConfigurationInput
impl UnwindSafe for UpdateMatchmakingConfigurationInput
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);