com.amazonaws.services.gamelift.model.DescribePlayerSessionsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-gamelift Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.gamelift.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribePlayerSessionsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* A unique identifier for the game session to retrieve player sessions for.
*
*/
private String gameSessionId;
/**
*
* A unique identifier for a player to retrieve player sessions for.
*
*/
private String playerId;
/**
*
* A unique identifier for a player session to retrieve.
*
*/
private String playerSessionId;
/**
*
* Player session status to filter results on. Note that when a PlayerSessionId or PlayerId is provided in a
* DescribePlayerSessions request, then the PlayerSessionStatusFilter has no effect on the response.
*
*
* Possible player session statuses include the following:
*
*
* -
*
* RESERVED -- The player session request has been received, but the player has not yet connected to the
* server process and/or been validated.
*
*
* -
*
* ACTIVE -- The player has been validated by the server process and is currently connected.
*
*
* -
*
* COMPLETED -- The player connection has been dropped.
*
*
* -
*
* TIMEDOUT -- A player session request was received, but the player did not connect and/or was not validated
* within the timeout limit (60 seconds).
*
*
*
*/
private String playerSessionStatusFilter;
/**
*
* The maximum number of results to return. 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 Integer limit;
/**
*
* 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. If a player
* session ID is specified, this parameter is ignored.
*
*/
private String nextToken;
/**
*
* A unique identifier for the game session to retrieve player sessions for.
*
*
* @param gameSessionId
* A unique identifier for the game session to retrieve player sessions for.
*/
public void setGameSessionId(String gameSessionId) {
this.gameSessionId = gameSessionId;
}
/**
*
* A unique identifier for the game session to retrieve player sessions for.
*
*
* @return A unique identifier for the game session to retrieve player sessions for.
*/
public String getGameSessionId() {
return this.gameSessionId;
}
/**
*
* A unique identifier for the game session to retrieve player sessions for.
*
*
* @param gameSessionId
* A unique identifier for the game session to retrieve player sessions for.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribePlayerSessionsRequest withGameSessionId(String gameSessionId) {
setGameSessionId(gameSessionId);
return this;
}
/**
*
* A unique identifier for a player to retrieve player sessions for.
*
*
* @param playerId
* A unique identifier for a player to retrieve player sessions for.
*/
public void setPlayerId(String playerId) {
this.playerId = playerId;
}
/**
*
* A unique identifier for a player to retrieve player sessions for.
*
*
* @return A unique identifier for a player to retrieve player sessions for.
*/
public String getPlayerId() {
return this.playerId;
}
/**
*
* A unique identifier for a player to retrieve player sessions for.
*
*
* @param playerId
* A unique identifier for a player to retrieve player sessions for.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribePlayerSessionsRequest withPlayerId(String playerId) {
setPlayerId(playerId);
return this;
}
/**
*
* A unique identifier for a player session to retrieve.
*
*
* @param playerSessionId
* A unique identifier for a player session to retrieve.
*/
public void setPlayerSessionId(String playerSessionId) {
this.playerSessionId = playerSessionId;
}
/**
*
* A unique identifier for a player session to retrieve.
*
*
* @return A unique identifier for a player session to retrieve.
*/
public String getPlayerSessionId() {
return this.playerSessionId;
}
/**
*
* A unique identifier for a player session to retrieve.
*
*
* @param playerSessionId
* A unique identifier for a player session to retrieve.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribePlayerSessionsRequest withPlayerSessionId(String playerSessionId) {
setPlayerSessionId(playerSessionId);
return this;
}
/**
*
* Player session status to filter results on. Note that when a PlayerSessionId or PlayerId is provided in a
* DescribePlayerSessions request, then the PlayerSessionStatusFilter has no effect on the response.
*
*
* Possible player session statuses include the following:
*
*
* -
*
* RESERVED -- The player session request has been received, but the player has not yet connected to the
* server process and/or been validated.
*
*
* -
*
* ACTIVE -- The player has been validated by the server process and is currently connected.
*
*
* -
*
* COMPLETED -- The player connection has been dropped.
*
*
* -
*
* TIMEDOUT -- A player session request was received, but the player did not connect and/or was not validated
* within the timeout limit (60 seconds).
*
*
*
*
* @param playerSessionStatusFilter
* Player session status to filter results on. Note that when a PlayerSessionId or PlayerId is provided in a
* DescribePlayerSessions request, then the PlayerSessionStatusFilter has no effect on the response.
*
* Possible player session statuses include the following:
*
*
* -
*
* RESERVED -- The player session request has been received, but the player has not yet connected to
* the server process and/or been validated.
*
*
* -
*
* ACTIVE -- The player has been validated by the server process and is currently connected.
*
*
* -
*
* COMPLETED -- The player connection has been dropped.
*
*
* -
*
* TIMEDOUT -- A player session request was received, but the player did not connect and/or was not
* validated within the timeout limit (60 seconds).
*
*
*/
public void setPlayerSessionStatusFilter(String playerSessionStatusFilter) {
this.playerSessionStatusFilter = playerSessionStatusFilter;
}
/**
*
* Player session status to filter results on. Note that when a PlayerSessionId or PlayerId is provided in a
* DescribePlayerSessions request, then the PlayerSessionStatusFilter has no effect on the response.
*
*
* Possible player session statuses include the following:
*
*
* -
*
* RESERVED -- The player session request has been received, but the player has not yet connected to the
* server process and/or been validated.
*
*
* -
*
* ACTIVE -- The player has been validated by the server process and is currently connected.
*
*
* -
*
* COMPLETED -- The player connection has been dropped.
*
*
* -
*
* TIMEDOUT -- A player session request was received, but the player did not connect and/or was not validated
* within the timeout limit (60 seconds).
*
*
*
*
* @return Player session status to filter results on. Note that when a PlayerSessionId or PlayerId is provided in a
* DescribePlayerSessions request, then the PlayerSessionStatusFilter has no effect on the response.
*
* Possible player session statuses include the following:
*
*
* -
*
* RESERVED -- The player session request has been received, but the player has not yet connected to
* the server process and/or been validated.
*
*
* -
*
* ACTIVE -- The player has been validated by the server process and is currently connected.
*
*
* -
*
* COMPLETED -- The player connection has been dropped.
*
*
* -
*
* TIMEDOUT -- A player session request was received, but the player did not connect and/or was not
* validated within the timeout limit (60 seconds).
*
*
*/
public String getPlayerSessionStatusFilter() {
return this.playerSessionStatusFilter;
}
/**
*
* Player session status to filter results on. Note that when a PlayerSessionId or PlayerId is provided in a
* DescribePlayerSessions request, then the PlayerSessionStatusFilter has no effect on the response.
*
*
* Possible player session statuses include the following:
*
*
* -
*
* RESERVED -- The player session request has been received, but the player has not yet connected to the
* server process and/or been validated.
*
*
* -
*
* ACTIVE -- The player has been validated by the server process and is currently connected.
*
*
* -
*
* COMPLETED -- The player connection has been dropped.
*
*
* -
*
* TIMEDOUT -- A player session request was received, but the player did not connect and/or was not validated
* within the timeout limit (60 seconds).
*
*
*
*
* @param playerSessionStatusFilter
* Player session status to filter results on. Note that when a PlayerSessionId or PlayerId is provided in a
* DescribePlayerSessions request, then the PlayerSessionStatusFilter has no effect on the response.
*
* Possible player session statuses include the following:
*
*
* -
*
* RESERVED -- The player session request has been received, but the player has not yet connected to
* the server process and/or been validated.
*
*
* -
*
* ACTIVE -- The player has been validated by the server process and is currently connected.
*
*
* -
*
* COMPLETED -- The player connection has been dropped.
*
*
* -
*
* TIMEDOUT -- A player session request was received, but the player did not connect and/or was not
* validated within the timeout limit (60 seconds).
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribePlayerSessionsRequest withPlayerSessionStatusFilter(String playerSessionStatusFilter) {
setPlayerSessionStatusFilter(playerSessionStatusFilter);
return this;
}
/**
*
* The maximum number of results to return. 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.
*
*
* @param limit
* The maximum number of results to return. 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 setLimit(Integer limit) {
this.limit = limit;
}
/**
*
* The maximum number of results to return. 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.
*
*
* @return The maximum number of results to return. 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 Integer getLimit() {
return this.limit;
}
/**
*
* The maximum number of results to return. 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.
*
*
* @param limit
* The maximum number of results to return. 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribePlayerSessionsRequest withLimit(Integer limit) {
setLimit(limit);
return this;
}
/**
*
* 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. If a player
* session ID is specified, this parameter is ignored.
*
*
* @param 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. If a player session ID is specified, this parameter is ignored.
*/
public void setNextToken(String nextToken) {
this.nextToken = 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. If a player
* session ID is specified, this parameter is ignored.
*
*
* @return 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. If a player session ID is specified, this parameter is ignored.
*/
public String getNextToken() {
return this.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. If a player
* session ID is specified, this parameter is ignored.
*
*
* @param 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. If a player session ID is specified, this parameter is ignored.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribePlayerSessionsRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getGameSessionId() != null)
sb.append("GameSessionId: ").append(getGameSessionId()).append(",");
if (getPlayerId() != null)
sb.append("PlayerId: ").append("***Sensitive Data Redacted***").append(",");
if (getPlayerSessionId() != null)
sb.append("PlayerSessionId: ").append(getPlayerSessionId()).append(",");
if (getPlayerSessionStatusFilter() != null)
sb.append("PlayerSessionStatusFilter: ").append(getPlayerSessionStatusFilter()).append(",");
if (getLimit() != null)
sb.append("Limit: ").append(getLimit()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribePlayerSessionsRequest == false)
return false;
DescribePlayerSessionsRequest other = (DescribePlayerSessionsRequest) obj;
if (other.getGameSessionId() == null ^ this.getGameSessionId() == null)
return false;
if (other.getGameSessionId() != null && other.getGameSessionId().equals(this.getGameSessionId()) == false)
return false;
if (other.getPlayerId() == null ^ this.getPlayerId() == null)
return false;
if (other.getPlayerId() != null && other.getPlayerId().equals(this.getPlayerId()) == false)
return false;
if (other.getPlayerSessionId() == null ^ this.getPlayerSessionId() == null)
return false;
if (other.getPlayerSessionId() != null && other.getPlayerSessionId().equals(this.getPlayerSessionId()) == false)
return false;
if (other.getPlayerSessionStatusFilter() == null ^ this.getPlayerSessionStatusFilter() == null)
return false;
if (other.getPlayerSessionStatusFilter() != null && other.getPlayerSessionStatusFilter().equals(this.getPlayerSessionStatusFilter()) == false)
return false;
if (other.getLimit() == null ^ this.getLimit() == null)
return false;
if (other.getLimit() != null && other.getLimit().equals(this.getLimit()) == false)
return false;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getGameSessionId() == null) ? 0 : getGameSessionId().hashCode());
hashCode = prime * hashCode + ((getPlayerId() == null) ? 0 : getPlayerId().hashCode());
hashCode = prime * hashCode + ((getPlayerSessionId() == null) ? 0 : getPlayerSessionId().hashCode());
hashCode = prime * hashCode + ((getPlayerSessionStatusFilter() == null) ? 0 : getPlayerSessionStatusFilter().hashCode());
hashCode = prime * hashCode + ((getLimit() == null) ? 0 : getLimit().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
return hashCode;
}
@Override
public DescribePlayerSessionsRequest clone() {
return (DescribePlayerSessionsRequest) super.clone();
}
}