Struct rusoto_gamelift::SearchGameSessionsInput
source · [−]pub struct SearchGameSessionsInput {
pub alias_id: Option<String>,
pub filter_expression: Option<String>,
pub fleet_id: Option<String>,
pub limit: Option<i64>,
pub location: Option<String>,
pub next_token: Option<String>,
pub sort_expression: Option<String>,
}
Expand description
Represents the input for a request operation.
Fields
alias_id: Option<String>
A unique identifier for the alias associated with the fleet to search for active game sessions. You can use either the alias ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.
filter_expression: Option<String>
String containing the search criteria for the session search. If no filter expression is included, the request returns results for all game sessions in the fleet that are in ACTIVE
status.
A filter expression can contain one or multiple conditions. Each condition consists of the following:
-
Operand -- Name of a game session attribute. Valid values are
gameSessionName
,gameSessionId
,gameSessionProperties
,maximumSessions
,creationTimeMillis
,playerSessionCount
,hasAvailablePlayerSessions
. -
Comparator -- Valid comparators are:
=
,<>
,<
,>
,<=
,>=
. -
Value -- Value to be searched for. Values may be numbers, boolean values (true/false) or strings depending on the operand. String values are case sensitive and must be enclosed in single quotes. Special characters must be escaped. Boolean and string values can only be used with the comparators
=
and<>
. For example, the following filter expression searches ongameSessionName
: "FilterExpression": "gameSessionName = 'Matt\\'s Awesome Game 1'"
.
To chain multiple conditions in a single expression, use the logical keywords AND
, OR
, and NOT
and parentheses as needed. For example: x AND y AND NOT z
, NOT (x OR y)
.
Session search evaluates conditions from left to right using the following precedence rules:
-
=
,<>
,<
,>
,<=
,>=
-
Parentheses
-
NOT
-
AND
-
OR
For example, this filter expression retrieves game sessions hosting at least ten players that have an open player slot: "maximumSessions>=10 AND hasAvailablePlayerSessions=true"
.
fleet_id: Option<String>
A unique identifier for the fleet to search for active game sessions. You can use either the fleet ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.
limit: Option<i64>
The maximum number of results to return. Use this parameter with NextToken
to get results as a set of sequential pages. The maximum number of results returned is 20, even if this value is not set or is set higher than 20.
location: Option<String>
A fleet location to search for game sessions. You can specify a fleet's home Region or a remote location. Use the AWS Region code format, such as us-west-2
.
next_token: Option<String>
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.
sort_expression: Option<String>
Instructions on how to sort the search results. If no sort expression is included, the request returns results in random order. A sort expression consists of the following elements:
-
Operand -- Name of a game session attribute. Valid values are
gameSessionName
,gameSessionId
,gameSessionProperties
,maximumSessions
,creationTimeMillis
,playerSessionCount
,hasAvailablePlayerSessions
. -
Order -- Valid sort orders are
ASC
(ascending) andDESC
(descending).
For example, this sort expression returns the oldest active sessions first: "SortExpression": "creationTimeMillis ASC"
. Results with a null value for the sort operand are returned at the end of the list.
Trait Implementations
sourceimpl Clone for SearchGameSessionsInput
impl Clone for SearchGameSessionsInput
sourcefn clone(&self) -> SearchGameSessionsInput
fn clone(&self) -> SearchGameSessionsInput
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
sourceimpl Debug for SearchGameSessionsInput
impl Debug for SearchGameSessionsInput
sourceimpl Default for SearchGameSessionsInput
impl Default for SearchGameSessionsInput
sourcefn default() -> SearchGameSessionsInput
fn default() -> SearchGameSessionsInput
Returns the “default value” for a type. Read more
sourceimpl PartialEq<SearchGameSessionsInput> for SearchGameSessionsInput
impl PartialEq<SearchGameSessionsInput> for SearchGameSessionsInput
sourcefn eq(&self, other: &SearchGameSessionsInput) -> bool
fn eq(&self, other: &SearchGameSessionsInput) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &SearchGameSessionsInput) -> bool
fn ne(&self, other: &SearchGameSessionsInput) -> bool
This method tests for !=
.
sourceimpl Serialize for SearchGameSessionsInput
impl Serialize for SearchGameSessionsInput
impl StructuralPartialEq for SearchGameSessionsInput
Auto Trait Implementations
impl RefUnwindSafe for SearchGameSessionsInput
impl Send for SearchGameSessionsInput
impl Sync for SearchGameSessionsInput
impl Unpin for SearchGameSessionsInput
impl UnwindSafe for SearchGameSessionsInput
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> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
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