pub struct UpdateGameServerFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to UpdateGameServer.
This operation is used with the Amazon GameLift Servers FleetIQ solution and game server groups.
Updates information about a registered game server to help Amazon GameLift Servers FleetIQ track game server availability. This operation is called by a game server process that is running on an instance in a game server group.
Use this operation to update the following types of game server information. You can make all three types of updates in the same request:
-
To update the game server's utilization status from
AVAILABLE(when the game server is available to be claimed) toUTILIZED(when the game server is currently hosting games). Identify the game server and game server group and specify the new utilization status. You can't change the status from toUTILIZEDtoAVAILABLE. -
To report health status, identify the game server and game server group and set health check to
HEALTHY. If a game server does not report health status for a certain length of time, the game server is no longer considered healthy. As a result, it will be eventually deregistered from the game server group to avoid affecting utilization metrics. The best practice is to report health every 60 seconds. -
To change game server metadata, provide updated game server data.
Once a game server is successfully updated, the relevant statuses and timestamps are updated.
Learn more
Implementations§
Source§impl UpdateGameServerFluentBuilder
impl UpdateGameServerFluentBuilder
Sourcepub fn as_input(&self) -> &UpdateGameServerInputBuilder
pub fn as_input(&self) -> &UpdateGameServerInputBuilder
Access the UpdateGameServer as a reference.
Sourcepub async fn send(
self,
) -> Result<UpdateGameServerOutput, SdkError<UpdateGameServerError, HttpResponse>>
pub async fn send( self, ) -> Result<UpdateGameServerOutput, SdkError<UpdateGameServerError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<UpdateGameServerOutput, UpdateGameServerError, Self>
pub fn customize( self, ) -> CustomizableOperation<UpdateGameServerOutput, UpdateGameServerError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn game_server_group_name(self, input: impl Into<String>) -> Self
pub fn game_server_group_name(self, input: impl Into<String>) -> Self
A unique identifier for the game server group where the game server is running.
Sourcepub fn set_game_server_group_name(self, input: Option<String>) -> Self
pub fn set_game_server_group_name(self, input: Option<String>) -> Self
A unique identifier for the game server group where the game server is running.
Sourcepub fn get_game_server_group_name(&self) -> &Option<String>
pub fn get_game_server_group_name(&self) -> &Option<String>
A unique identifier for the game server group where the game server is running.
Sourcepub fn game_server_id(self, input: impl Into<String>) -> Self
pub fn game_server_id(self, input: impl Into<String>) -> Self
A custom string that uniquely identifies the game server to update.
Sourcepub fn set_game_server_id(self, input: Option<String>) -> Self
pub fn set_game_server_id(self, input: Option<String>) -> Self
A custom string that uniquely identifies the game server to update.
Sourcepub fn get_game_server_id(&self) -> &Option<String>
pub fn get_game_server_id(&self) -> &Option<String>
A custom string that uniquely identifies the game server to update.
Sourcepub fn game_server_data(self, input: impl Into<String>) -> Self
pub fn game_server_data(self, input: impl Into<String>) -> Self
A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers.
Sourcepub fn set_game_server_data(self, input: Option<String>) -> Self
pub fn set_game_server_data(self, input: Option<String>) -> Self
A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers.
Sourcepub fn get_game_server_data(&self) -> &Option<String>
pub fn get_game_server_data(&self) -> &Option<String>
A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers.
Sourcepub fn utilization_status(self, input: GameServerUtilizationStatus) -> Self
pub fn utilization_status(self, input: GameServerUtilizationStatus) -> Self
Indicates if the game server is available or is currently hosting gameplay. You can update a game server status from AVAILABLE to UTILIZED, but you can't change a the status from UTILIZED to AVAILABLE.
Sourcepub fn set_utilization_status(
self,
input: Option<GameServerUtilizationStatus>,
) -> Self
pub fn set_utilization_status( self, input: Option<GameServerUtilizationStatus>, ) -> Self
Indicates if the game server is available or is currently hosting gameplay. You can update a game server status from AVAILABLE to UTILIZED, but you can't change a the status from UTILIZED to AVAILABLE.
Sourcepub fn get_utilization_status(&self) -> &Option<GameServerUtilizationStatus>
pub fn get_utilization_status(&self) -> &Option<GameServerUtilizationStatus>
Indicates if the game server is available or is currently hosting gameplay. You can update a game server status from AVAILABLE to UTILIZED, but you can't change a the status from UTILIZED to AVAILABLE.
Sourcepub fn health_check(self, input: GameServerHealthCheck) -> Self
pub fn health_check(self, input: GameServerHealthCheck) -> Self
Indicates health status of the game server. A request that includes this parameter updates the game server's LastHealthCheckTime timestamp.
Sourcepub fn set_health_check(self, input: Option<GameServerHealthCheck>) -> Self
pub fn set_health_check(self, input: Option<GameServerHealthCheck>) -> Self
Indicates health status of the game server. A request that includes this parameter updates the game server's LastHealthCheckTime timestamp.
Sourcepub fn get_health_check(&self) -> &Option<GameServerHealthCheck>
pub fn get_health_check(&self) -> &Option<GameServerHealthCheck>
Indicates health status of the game server. A request that includes this parameter updates the game server's LastHealthCheckTime timestamp.
Trait Implementations§
Source§impl Clone for UpdateGameServerFluentBuilder
impl Clone for UpdateGameServerFluentBuilder
Source§fn clone(&self) -> UpdateGameServerFluentBuilder
fn clone(&self) -> UpdateGameServerFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for UpdateGameServerFluentBuilder
impl !RefUnwindSafe for UpdateGameServerFluentBuilder
impl Send for UpdateGameServerFluentBuilder
impl Sync for UpdateGameServerFluentBuilder
impl Unpin for UpdateGameServerFluentBuilder
impl !UnwindSafe for UpdateGameServerFluentBuilder
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);