com.amazonaws.services.gamelift.model.DescribePlayerSessionsResult Maven / Gradle / Ivy
Show all versions of aws-java-sdk-gamelift Show documentation
/*
* Copyright 2011-2016 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;
/**
*
* Represents the returned data in response to a request action.
*
*/
public class DescribePlayerSessionsResult implements Serializable, Cloneable {
/**
*
* Collection of objects containing properties for each player session that
* matches the request.
*
*/
private java.util.List playerSessions;
/**
*
* Token indicating where to resume retrieving results on the next call to
* this action. If no token is returned, these results represent the end of
* the list.
*
*
*
* If a request has a limit that exactly matches the number of remaining
* results, a token is returned even though there are no more results to
* retrieve.
*
*
*/
private String nextToken;
/**
*
* Collection of objects containing properties for each player session that
* matches the request.
*
*
* @return Collection of objects containing properties for each player
* session that matches the request.
*/
public java.util.List getPlayerSessions() {
return playerSessions;
}
/**
*
* Collection of objects containing properties for each player session that
* matches the request.
*
*
* @param playerSessions
* Collection of objects containing properties for each player
* session that matches the request.
*/
public void setPlayerSessions(
java.util.Collection playerSessions) {
if (playerSessions == null) {
this.playerSessions = null;
return;
}
this.playerSessions = new java.util.ArrayList(
playerSessions);
}
/**
*
* Collection of objects containing properties for each player session that
* matches the request.
*
*
* NOTE: This method appends the values to the existing list (if
* any). Use {@link #setPlayerSessions(java.util.Collection)} or
* {@link #withPlayerSessions(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param playerSessions
* Collection of objects containing properties for each player
* session that matches the request.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribePlayerSessionsResult withPlayerSessions(
PlayerSession... playerSessions) {
if (this.playerSessions == null) {
setPlayerSessions(new java.util.ArrayList(
playerSessions.length));
}
for (PlayerSession ele : playerSessions) {
this.playerSessions.add(ele);
}
return this;
}
/**
*
* Collection of objects containing properties for each player session that
* matches the request.
*
*
* @param playerSessions
* Collection of objects containing properties for each player
* session that matches the request.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribePlayerSessionsResult withPlayerSessions(
java.util.Collection playerSessions) {
setPlayerSessions(playerSessions);
return this;
}
/**
*
* Token indicating where to resume retrieving results on the next call to
* this action. If no token is returned, these results represent the end of
* the list.
*
*
*
* If a request has a limit that exactly matches the number of remaining
* results, a token is returned even though there are no more results to
* retrieve.
*
*
*
* @param nextToken
* Token indicating where to resume retrieving results on the next
* call to this action. If no token is returned, these results
* represent the end of the list.
*
* If a request has a limit that exactly matches the number of
* remaining results, a token is returned even though there are no
* more results to retrieve.
*
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* Token indicating where to resume retrieving results on the next call to
* this action. If no token is returned, these results represent the end of
* the list.
*
*
*
* If a request has a limit that exactly matches the number of remaining
* results, a token is returned even though there are no more results to
* retrieve.
*
*
*
* @return Token indicating where to resume retrieving results on the next
* call to this action. If no token is returned, these results
* represent the end of the list.
*
* If a request has a limit that exactly matches the number of
* remaining results, a token is returned even though there are no
* more results to retrieve.
*
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* Token indicating where to resume retrieving results on the next call to
* this action. If no token is returned, these results represent the end of
* the list.
*
*
*
* If a request has a limit that exactly matches the number of remaining
* results, a token is returned even though there are no more results to
* retrieve.
*
*
*
* @param nextToken
* Token indicating where to resume retrieving results on the next
* call to this action. If no token is returned, these results
* represent the end of the list.
*
* If a request has a limit that exactly matches the number of
* remaining results, a token is returned even though there are no
* more results to retrieve.
*
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribePlayerSessionsResult withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getPlayerSessions() != null)
sb.append("PlayerSessions: " + getPlayerSessions() + ",");
if (getNextToken() != null)
sb.append("NextToken: " + 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 DescribePlayerSessionsResult == false)
return false;
DescribePlayerSessionsResult other = (DescribePlayerSessionsResult) obj;
if (other.getPlayerSessions() == null
^ this.getPlayerSessions() == null)
return false;
if (other.getPlayerSessions() != null
&& other.getPlayerSessions().equals(this.getPlayerSessions()) == 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
+ ((getPlayerSessions() == null) ? 0 : getPlayerSessions()
.hashCode());
hashCode = prime * hashCode
+ ((getNextToken() == null) ? 0 : getNextToken().hashCode());
return hashCode;
}
@Override
public DescribePlayerSessionsResult clone() {
try {
return (DescribePlayerSessionsResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException(
"Got a CloneNotSupportedException from Object.clone() "
+ "even though we're Cloneable!", e);
}
}
}