public class DescribePlayerSessionsRequest extends AmazonWebServiceRequest implements java.io.Serializable, java.lang.Cloneable
Represents the input for a request action.
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
gameSessionId
Unique identifier for a game session.
|
private java.lang.Integer |
limit
Maximum number of results to return.
|
private java.lang.String |
nextToken
Token indicating the start of the next sequential page of results.
|
private java.lang.String |
playerId
Unique identifier for a player.
|
private java.lang.String |
playerSessionId
Unique identifier for a player session.
|
private java.lang.String |
playerSessionStatusFilter
Player session status to filter results on.
|
NOOP
Constructor and Description |
---|
DescribePlayerSessionsRequest() |
Modifier and Type | Method and Description |
---|---|
DescribePlayerSessionsRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getGameSessionId()
Unique identifier for a game session.
|
java.lang.Integer |
getLimit()
Maximum number of results to return.
|
java.lang.String |
getNextToken()
Token indicating the start of the next sequential page of results.
|
java.lang.String |
getPlayerId()
Unique identifier for a player.
|
java.lang.String |
getPlayerSessionId()
Unique identifier for a player session.
|
java.lang.String |
getPlayerSessionStatusFilter()
Player session status to filter results on.
|
int |
hashCode() |
void |
setGameSessionId(java.lang.String gameSessionId)
Unique identifier for a game session.
|
void |
setLimit(java.lang.Integer limit)
Maximum number of results to return.
|
void |
setNextToken(java.lang.String nextToken)
Token indicating the start of the next sequential page of results.
|
void |
setPlayerId(java.lang.String playerId)
Unique identifier for a player.
|
void |
setPlayerSessionId(java.lang.String playerSessionId)
Unique identifier for a player session.
|
void |
setPlayerSessionStatusFilter(java.lang.String playerSessionStatusFilter)
Player session status to filter results on.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
DescribePlayerSessionsRequest |
withGameSessionId(java.lang.String gameSessionId)
Unique identifier for a game session.
|
DescribePlayerSessionsRequest |
withLimit(java.lang.Integer limit)
Maximum number of results to return.
|
DescribePlayerSessionsRequest |
withNextToken(java.lang.String nextToken)
Token indicating the start of the next sequential page of results.
|
DescribePlayerSessionsRequest |
withPlayerId(java.lang.String playerId)
Unique identifier for a player.
|
DescribePlayerSessionsRequest |
withPlayerSessionId(java.lang.String playerSessionId)
Unique identifier for a player session.
|
DescribePlayerSessionsRequest |
withPlayerSessionStatusFilter(java.lang.String playerSessionStatusFilter)
Player session status to filter results on.
|
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
private java.lang.String gameSessionId
Unique identifier for a game session.
private java.lang.String playerId
Unique identifier for a player.
private java.lang.String playerSessionId
Unique identifier for a player session.
private java.lang.String playerSessionStatusFilter
Player session status to filter results on. Possible player session states include:
private java.lang.Integer limit
Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages. If a player session ID is specified, this parameter is ignored.
private java.lang.String nextToken
Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value. If a player session ID is specified, this parameter is ignored.
public void setGameSessionId(java.lang.String gameSessionId)
Unique identifier for a game session.
gameSessionId
- Unique identifier for a game session.public java.lang.String getGameSessionId()
Unique identifier for a game session.
public DescribePlayerSessionsRequest withGameSessionId(java.lang.String gameSessionId)
Unique identifier for a game session.
gameSessionId
- Unique identifier for a game session.public void setPlayerId(java.lang.String playerId)
Unique identifier for a player.
playerId
- Unique identifier for a player.public java.lang.String getPlayerId()
Unique identifier for a player.
public DescribePlayerSessionsRequest withPlayerId(java.lang.String playerId)
Unique identifier for a player.
playerId
- Unique identifier for a player.public void setPlayerSessionId(java.lang.String playerSessionId)
Unique identifier for a player session.
playerSessionId
- Unique identifier for a player session.public java.lang.String getPlayerSessionId()
Unique identifier for a player session.
public DescribePlayerSessionsRequest withPlayerSessionId(java.lang.String playerSessionId)
Unique identifier for a player session.
playerSessionId
- Unique identifier for a player session.public void setPlayerSessionStatusFilter(java.lang.String playerSessionStatusFilter)
Player session status to filter results on. Possible player session states include:
playerSessionStatusFilter
- Player session status to filter results on. Possible player
session states include:
public java.lang.String getPlayerSessionStatusFilter()
Player session status to filter results on. Possible player session states include:
public DescribePlayerSessionsRequest withPlayerSessionStatusFilter(java.lang.String playerSessionStatusFilter)
Player session status to filter results on. Possible player session states include:
playerSessionStatusFilter
- Player session status to filter results on. Possible player
session states include:
public void setLimit(java.lang.Integer limit)
Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages. If a player session ID is specified, this parameter is ignored.
limit
- Maximum number of results to return. You can use this parameter
with NextToken to get results as a set of sequential pages.
If a player session ID is specified, this parameter is ignored.public java.lang.Integer getLimit()
Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages. If a player session ID is specified, this parameter is ignored.
public DescribePlayerSessionsRequest withLimit(java.lang.Integer limit)
Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages. If a player session ID is specified, this parameter is ignored.
limit
- Maximum number of results to return. You can use this parameter
with NextToken to get results as a set of sequential pages.
If a player session ID is specified, this parameter is ignored.public void setNextToken(java.lang.String nextToken)
Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value. If a player session ID is specified, this parameter is ignored.
nextToken
- Token indicating the start of the next sequential page of results.
Use the token that is returned with a previous call to this
action. To specify the start of the result set, do not specify a
value. If a player session ID is specified, this parameter is
ignored.public java.lang.String getNextToken()
Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value. If a player session ID is specified, this parameter is ignored.
public DescribePlayerSessionsRequest withNextToken(java.lang.String nextToken)
Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value. If a player session ID is specified, this parameter is ignored.
nextToken
- Token indicating the start of the next sequential page of results.
Use the token that is returned with a previous call to this
action. To specify the start of the result set, do not specify a
value. If a player session ID is specified, this parameter is
ignored.public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public DescribePlayerSessionsRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()