Struct aws_sdk_gamelift::client::fluent_builders::ListGameServers
source · [−]pub struct ListGameServers { /* private fields */ }
Expand description
Fluent builder constructing a request to ListGameServers
.
This operation is used with the GameLift FleetIQ solution and game server groups.
Retrieves information on all game servers that are currently active in a specified game server group. You can opt to sort the list by game server age. Use the pagination parameters to retrieve results in a set of sequential segments.
Learn more
Related actions
RegisterGameServer
| ListGameServers
| ClaimGameServer
| DescribeGameServer
| UpdateGameServer
| DeregisterGameServer
| All APIs by task
Implementations
sourceimpl ListGameServers
impl ListGameServers
sourcepub async fn send(
self
) -> Result<ListGameServersOutput, SdkError<ListGameServersError>>
pub async fn send(
self
) -> Result<ListGameServersOutput, SdkError<ListGameServersError>>
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 into_paginator(self) -> ListGameServersPaginator
pub fn into_paginator(self) -> ListGameServersPaginator
Create a paginator for this request
Paginators are used by calling send().await
which returns a Stream
.
sourcepub fn game_server_group_name(self, input: impl Into<String>) -> Self
pub fn game_server_group_name(self, input: impl Into<String>) -> Self
An identifier for the game server group to retrieve a list of game servers from. Use either the GameServerGroup
name or ARN value.
sourcepub fn set_game_server_group_name(self, input: Option<String>) -> Self
pub fn set_game_server_group_name(self, input: Option<String>) -> Self
An identifier for the game server group to retrieve a list of game servers from. Use either the GameServerGroup
name or ARN value.
sourcepub fn sort_order(self, input: SortOrder) -> Self
pub fn sort_order(self, input: SortOrder) -> Self
Indicates how to sort the returned data based on game server registration timestamp. Use ASCENDING
to retrieve oldest game servers first, or use DESCENDING
to retrieve newest game servers first. If this parameter is left empty, game servers are returned in no particular order.
sourcepub fn set_sort_order(self, input: Option<SortOrder>) -> Self
pub fn set_sort_order(self, input: Option<SortOrder>) -> Self
Indicates how to sort the returned data based on game server registration timestamp. Use ASCENDING
to retrieve oldest game servers first, or use DESCENDING
to retrieve newest game servers first. If this parameter is left empty, game servers are returned in no particular order.
sourcepub fn limit(self, input: i32) -> Self
pub fn limit(self, input: i32) -> Self
The maximum number of results to return. Use this parameter with NextToken
to get results as a set of sequential pages.
sourcepub fn set_limit(self, input: Option<i32>) -> Self
pub fn set_limit(self, input: Option<i32>) -> Self
The maximum number of results to return. Use this parameter with NextToken
to get results as a set of sequential pages.
sourcepub fn next_token(self, input: impl Into<String>) -> Self
pub fn next_token(self, input: impl Into<String>) -> Self
A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.
sourcepub fn set_next_token(self, input: Option<String>) -> Self
pub fn set_next_token(self, input: Option<String>) -> Self
A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.
Trait Implementations
sourceimpl Clone for ListGameServers
impl Clone for ListGameServers
sourcefn clone(&self) -> ListGameServers
fn clone(&self) -> ListGameServers
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
Auto Trait Implementations
impl !RefUnwindSafe for ListGameServers
impl Send for ListGameServers
impl Sync for ListGameServers
impl Unpin for ListGameServers
impl !UnwindSafe for ListGameServers
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