@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class SearchGameSessionsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
SearchGameSessionsRequest() |
Modifier and Type | Method and Description |
---|---|
SearchGameSessionsRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getAliasId()
A unique identifier for the alias associated with the fleet to search for active game sessions.
|
String |
getFilterExpression()
String containing the search criteria for the session search.
|
String |
getFleetId()
A unique identifier for the fleet to search for active game sessions.
|
Integer |
getLimit()
The maximum number of results to return.
|
String |
getLocation()
A fleet location to search for game sessions.
|
String |
getNextToken()
A token that indicates the start of the next sequential page of results.
|
String |
getSortExpression()
Instructions on how to sort the search results.
|
int |
hashCode() |
void |
setAliasId(String aliasId)
A unique identifier for the alias associated with the fleet to search for active game sessions.
|
void |
setFilterExpression(String filterExpression)
String containing the search criteria for the session search.
|
void |
setFleetId(String fleetId)
A unique identifier for the fleet to search for active game sessions.
|
void |
setLimit(Integer limit)
The maximum number of results to return.
|
void |
setLocation(String location)
A fleet location to search for game sessions.
|
void |
setNextToken(String nextToken)
A token that indicates the start of the next sequential page of results.
|
void |
setSortExpression(String sortExpression)
Instructions on how to sort the search results.
|
String |
toString()
Returns a string representation of this object.
|
SearchGameSessionsRequest |
withAliasId(String aliasId)
A unique identifier for the alias associated with the fleet to search for active game sessions.
|
SearchGameSessionsRequest |
withFilterExpression(String filterExpression)
String containing the search criteria for the session search.
|
SearchGameSessionsRequest |
withFleetId(String fleetId)
A unique identifier for the fleet to search for active game sessions.
|
SearchGameSessionsRequest |
withLimit(Integer limit)
The maximum number of results to return.
|
SearchGameSessionsRequest |
withLocation(String location)
A fleet location to search for game sessions.
|
SearchGameSessionsRequest |
withNextToken(String nextToken)
A token that indicates the start of the next sequential page of results.
|
SearchGameSessionsRequest |
withSortExpression(String sortExpression)
Instructions on how to sort the search results.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setFleetId(String fleetId)
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.
fleetId
- 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.public String getFleetId()
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.
public SearchGameSessionsRequest withFleetId(String fleetId)
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.
fleetId
- 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.public void setAliasId(String aliasId)
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.
aliasId
- 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.public String getAliasId()
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.
public SearchGameSessionsRequest withAliasId(String aliasId)
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.
aliasId
- 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.public void setLocation(String location)
A fleet location to search for game sessions. You can specify a fleet's home Region or a remote location. Use the
Amazon Web Services Region code format, such as us-west-2
.
location
- A fleet location to search for game sessions. You can specify a fleet's home Region or a remote location.
Use the Amazon Web Services Region code format, such as us-west-2
.public String getLocation()
A fleet location to search for game sessions. You can specify a fleet's home Region or a remote location. Use the
Amazon Web Services Region code format, such as us-west-2
.
us-west-2
.public SearchGameSessionsRequest withLocation(String location)
A fleet location to search for game sessions. You can specify a fleet's home Region or a remote location. Use the
Amazon Web Services Region code format, such as us-west-2
.
location
- A fleet location to search for game sessions. You can specify a fleet's home Region or a remote location.
Use the Amazon Web Services Region code format, such as us-west-2
.public void setFilterExpression(String filterExpression)
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 on gameSessionName
: "
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"
.
filterExpression
- 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 on
gameSessionName
: "
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"
.
public String getFilterExpression()
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 on gameSessionName
: "
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"
.
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 on
gameSessionName
: "
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"
.
public SearchGameSessionsRequest withFilterExpression(String filterExpression)
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 on gameSessionName
: "
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"
.
filterExpression
- 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 on
gameSessionName
: "
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"
.
public void setSortExpression(String sortExpression)
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) and DESC
(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.
sortExpression
- 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) and DESC
(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.
public String getSortExpression()
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) and DESC
(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.
Operand -- Name of a game session attribute. Valid values are gameSessionName
,
gameSessionId
, gameSessionProperties
, maximumSessions
,
creationTimeMillis
, playerSessionCount
, hasAvailablePlayerSessions
.
Order -- Valid sort orders are ASC
(ascending) and DESC
(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.
public SearchGameSessionsRequest withSortExpression(String sortExpression)
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) and DESC
(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.
sortExpression
- 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) and DESC
(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.
public void setLimit(Integer limit)
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.
limit
- 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.public Integer getLimit()
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.
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.public SearchGameSessionsRequest withLimit(Integer limit)
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.
limit
- 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.public void setNextToken(String nextToken)
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.
nextToken
- 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.public String getNextToken()
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.
public SearchGameSessionsRequest withNextToken(String nextToken)
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.
nextToken
- 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.public String toString()
toString
in class Object
Object.toString()
public SearchGameSessionsRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()