[−][src]Struct rusoto_gamelift::SearchGameSessionsInput
Represents the input for a request action.
Fields
alias_id: Option<String>
A unique identifier for an 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 a 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.
next_token: Option<String>
Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. 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
impl Clone for SearchGameSessionsInput
[src]
fn clone(&self) -> SearchGameSessionsInput
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for SearchGameSessionsInput
[src]
impl Default for SearchGameSessionsInput
[src]
fn default() -> SearchGameSessionsInput
[src]
impl PartialEq<SearchGameSessionsInput> for SearchGameSessionsInput
[src]
fn eq(&self, other: &SearchGameSessionsInput) -> bool
[src]
fn ne(&self, other: &SearchGameSessionsInput) -> bool
[src]
impl Serialize for SearchGameSessionsInput
[src]
fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
__S: Serializer,
[src]
__S: Serializer,
impl StructuralPartialEq for SearchGameSessionsInput
[src]
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
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> Sealed<T> for T where
T: ?Sized,
T: ?Sized,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,